idcheckio_nodejs_client

idcheckio_nodejs_client - JavaScript client for idcheckio_nodejs_client Check identity documents

Web application : https://idcheck.io

Mashape REST API : https://market.mashape.com/ariadnext/idcheck-io-api

Swagger REST API : https://api.idcheck.io/swagger/#/

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0
• Package version: 1.0.0
• Build date: 2016-12-05T17:23:14.144+01:00
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Requirements.

Credentials

To get your credentials, contact us by email with your all needs at: [email protected] You will receive two sets of credentials: one for test purpose only and on for production.

Platforms

Three platforms can be targeted with the library:

| Platform | API URL | Credentials | Purpose | Restriction | Cost | -------------|----------------------------------|-------------|------------------------------------------|----------------------------------------|----------------------| | SANDBOX | https://sandbox.idcheck.io/rest | Test | Dev integration + automated tests | Only a fix set of images are supported | Free | TEST | https://api-test.idcheck.io/rest | Test | Functional tests / Idcheck.io evaluation | No SLA | Commercial agreement | PROD | https://api.idcheck.io/rest | Prod | Production service | None | Commercial agreement

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install idcheckio_nodejs_client --save

git

If the library is hosted at a git repository, e.g. https://github.com/ariadnext/nodejs-IDCHECKIO then install it via:

    npm install ariadnext/nodejs-IDCHECKIO --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var idcheckio_nodejs_client = require('idcheckio_nodejs_client');

var api = new idcheckio_nodejs_client.AdministrationApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHealth(callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/rest

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- idcheckio_nodejs_client.AdministrationApi | getHealth | GET /v0/admin/health | HTTP GET health idcheckio_nodejs_client.AdministrationApi | getUser | GET /v0/admin/user | HTTP GET user idcheckio_nodejs_client.AnalysisApi | getReport | GET /v0/pdfreport/{analysisRefUid} | HTTP GET report (demo) idcheckio_nodejs_client.AnalysisApi | getResult | GET /v0/result/{analysisRefUid} | HTTP GET result idcheckio_nodejs_client.AnalysisApi | getTask | GET /v0/task/{analysisRefUid} | HTTP GET task idcheckio_nodejs_client.AnalysisApi | postImage | POST /v0/task/image | HTTP POST task image idcheckio_nodejs_client.AnalysisApi | postMrz | POST /v0/task/mrz | HTTP POST task mrz idcheckio_nodejs_client.SandboxApi | getImage | GET /v0/sandbox/image/{imageUid} | HTTP GET image idcheckio_nodejs_client.SandboxApi | getImageList | GET /v0/sandbox/imagelist | HTTP GET images list idcheckio_nodejs_client.SandboxApi | getMrz | GET /v0/sandbox/mrz/{mrzUid} | HTTP GET mrz idcheckio_nodejs_client.SandboxApi | getMrzList | GET /v0/sandbox/mrzlist | HTTP GET mrz list

Documentation for Models

• idcheckio_nodejs_client.CheckSummaryOfTheSubmittedDocument
• idcheckio_nodejs_client.ClassificationOfTheSubmittedDocument
• idcheckio_nodejs_client.Control
• idcheckio_nodejs_client.ControlGroup
• idcheckio_nodejs_client.DetailedInformationOfTheHolderOfTheSubmittedDocument
• idcheckio_nodejs_client.DetailedInformationOfTheSubmittedDocument
• idcheckio_nodejs_client.ErrorResponse
• idcheckio_nodejs_client.EventDate
• idcheckio_nodejs_client.ExtractedImage
• idcheckio_nodejs_client.GenericData
• idcheckio_nodejs_client.HealthResponse
• idcheckio_nodejs_client.Image
• idcheckio_nodejs_client.ImageIndicator
• idcheckio_nodejs_client.ImageListResponse
• idcheckio_nodejs_client.ImageRequest
• idcheckio_nodejs_client.Mrz
• idcheckio_nodejs_client.MrzListResponse
• idcheckio_nodejs_client.MrzRequest
• idcheckio_nodejs_client.MrzResponse
• idcheckio_nodejs_client.ReportResponse
• idcheckio_nodejs_client.ResultResponse
• idcheckio_nodejs_client.TaskResponse
• idcheckio_nodejs_client.UserResponse

Documentation for Authorization

basic

• Type: HTTP basic authentication