idcheckio_python_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 Python package is automatically generated by the Swagger Codegen project:

• API version: 0.0
• Package version: 1.0.0
• Build date: 2016-12-02T09:52:30.979+01:00
• Build package: class io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

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 & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/ariadnext/python-IDCHECKIO.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ariadnext/python-IDCHECKIO.git)

Then import the package:

import idcheckio_python_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import idcheckio_python_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import idcheckio_python_client
from idcheckio_python_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = idcheckio_python_client.AdministrationApi

try:
    # HTTP GET health
    api_response = api_instance.get_health()
    pprint(api_response)
except ApiException as e:
    print "Exception when calling AdministrationApi->get_health: %s\n" % e

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AdministrationApi	get_health	GET /v0/admin/health	HTTP GET health
AdministrationApi	get_user	GET /v0/admin/user	HTTP GET user
AnalysisApi	get_report	GET /v0/pdfreport/{analysisRefUid}	HTTP GET report (demo)
AnalysisApi	get_result	GET /v0/result/{analysisRefUid}	HTTP GET result
AnalysisApi	get_task	GET /v0/task/{analysisRefUid}	HTTP GET task
AnalysisApi	post_image	POST /v0/task/image	HTTP POST task image
AnalysisApi	post_mrz	POST /v0/task/mrz	HTTP POST task mrz
SandboxApi	get_image	GET /v0/sandbox/image/{imageUid}	HTTP GET image
SandboxApi	get_image_list	GET /v0/sandbox/imagelist	HTTP GET images list
SandboxApi	get_mrz	GET /v0/sandbox/mrz/{mrzUid}	HTTP GET mrz
SandboxApi	get_mrz_list	GET /v0/sandbox/mrzlist	HTTP GET mrz list

Documentation For Models

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

Documentation For Authorization

basic

• Type: HTTP basic authentication

Author