This is an auto-generated client library for Onfido API v2
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


The Onfido API is used to submit check requests.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2.0.0
  • Package version: 1.4.0
  • Build date: 2018-11-08T15:57:14.963Z
  • Build package: class io.swagger.codegen.languages.PythonClientCodegen


Python 2.7 and 3.4+

Installation & Usage

pip install

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

pip install git+

(you may need to run pip with root permission: sudo pip install git+

Then import the package:

import onfido


Install via Setuptools.

python install --user

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

Then import the package:

import onfido

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import onfido
from import ApiException
from pprint import pprint

# Configure API key authorization: Token
onfido.configuration.api_key['Authorization'] = 'token=' + 'YOUR_API_KEY'
onfido.configuration.api_key_prefix['Authorization'] = 'Token'

# Limit the at-rest region, if needed (optional, see
onfido.configuration.region = 'YOUR_REGION'

# create an instance of the API class
api_instance = onfido.DefaultApi()

# setting applicant details
applicant = onfido.Applicant()
applicant.first_name = 'John'
applicant.last_name = 'Smith'
applicant.dob =, 1, 22) = 'GBR'

address = onfido.Address()
address.building_number = '100'
address.street = 'Main Street' = 'London'
address.postcode = 'SW4 6EH' = 'GBR'

applicant.addresses = [address]

# setting check request details
check = onfido.CheckCreationRequest()
check.type = 'express'

report = onfido.Report() = 'identity'

check.reports = [report]

    # Create Applicant
    api_response = api_instance.create_applicant(data=applicant)
    applicant_id =
    api_response = api_instance.create_check(applicant_id, data=check)
except ApiException as e:

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
DefaultApi cancel_report POST /checks/{check_id}/reports/{report_id}/cancel This endpoint is for cancelling individual paused reports.
DefaultApi create_applicant POST /applicants Create Applicant
DefaultApi create_check POST /applicants/{applicant_id}/checks Create a check
DefaultApi create_webhook POST /webhooks Create a webhook
DefaultApi destroy_applicant DELETE /applicants/{applicant_id} Delete Applicant
DefaultApi download_document GET /applicants/{applicant_id}/documents/{document_id}/download Download a documents raw data
DefaultApi download_live_photo GET /live_photos/{live_photo_id}/download Download live photo
DefaultApi find_addresses GET /addresses/pick Search for addresses by postcode
DefaultApi find_applicant GET /applicants/{applicant_id} Retrieve Applicant
DefaultApi find_check GET /applicants/{applicant_id}/checks/{check_id} Retrieve a Check
DefaultApi find_document GET /applicants/{applicant_id}/documents/{document_id} A single document can be retrieved by calling this endpoint with the document’s unique identifier.
DefaultApi find_live_photo GET /live_photos/{live_photo_id} Retrieve live photo
DefaultApi find_report GET /checks/{check_id}/reports/{report_id} A single report can be retrieved using this endpoint with the corresponding unique identifier.
DefaultApi find_report_type_group GET /report_type_groups/{report_type_group_id} Retrieve single report type group object
DefaultApi find_webhook GET /webhooks/{webhook_id} Retrieve a Webhook
DefaultApi list_applicants GET /applicants List Applicants
DefaultApi list_checks GET /applicants/{applicant_id}/checks Retrieve Checks
DefaultApi list_documents GET /applicants/{applicant_id}/documents List documents
DefaultApi list_live_photos GET /live_photos List live photos
DefaultApi list_report_type_groups GET /report_type_groups Retrieve all report type groups
DefaultApi list_reports GET /checks/{check_id}/reports All the reports belonging to a particular check can be listed from this endpoint.
DefaultApi list_webhooks GET /webhooks List webhooks
DefaultApi resume_check POST /checks/{check_id}/resume Resume a Check
DefaultApi resume_report POST /checks/{check_id}/reports/{report_id}/resume This endpoint is for resuming individual paused reports.
DefaultApi update_applicant PUT /applicants/{applicant_id} Update Applicant
DefaultApi upload_document POST /applicants/{applicant_id}/documents Upload a document
DefaultApi upload_live_photo POST /live_photos Upload live photo

Documentation For Models