The Onfido API is used to submit check requests.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 2.0.0
- Package version: 2.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/onfido/api-python-client.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/onfido/api-python-client.git
)
Then import the package:
import onfido
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 onfido
Please follow the installation procedure and then run the following:
import sys
import onfido
import datetime
from pprint import pprint
from onfido.rest import ApiException
configuration = onfido.Configuration()
configuration.api_key['Authorization'] = 'token=' + 'YOUR API TOKEN'
configuration.api_key_prefix['Authorization'] = 'Token'
# Limit the at-rest region, if needed (optional, see https://documentation.onfido.com/#regions)
# configuration.host = configuration.get_host_from_settings(1, {'region': 'us'})
api = onfido.DefaultApi(onfido.ApiClient(configuration))
# Setting applicant details
applicant = onfido.Applicant(first_name='John', last_name='Smith')
applicant.dob = datetime.date(1980, 1, 22)
applicant.country = 'GBR'
address = onfido.Address()
address.building_number = '100'
address.street = 'Main Street'
address.town = 'London'
address.postcode = 'SW4 6EH'
address.country = 'GBR'
applicant.addresses = [address];
# Setting check details
check = onfido.Check(type='express')
report = onfido.Report(name='identity')
check.reports = [report];
try:
applicant_data = api.create_applicant(applicant)
applicant_id = applicant_data.id
check_data = api.create_check(applicant_id, check)
pprint(check_data)
except ApiException as e:
pprint(e.body)
All URIs are relative to https://api.onfido.com/v2
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 | restore_applicant | POST /applicants/{applicant_id}/restore | Restore Applicant |
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 |
- Address
- Applicant
- ApplicantsList
- Check
- CheckCommon
- CheckWithReportIds
- ChecksList
- Document
- DocumentsList
- Error
- GenericAddress
- GenericAddressesList
- IdNumber
- LivePhoto
- LivePhotosList
- Report
- ReportDocument
- ReportOption
- ReportType
- ReportTypeGroup
- ReportTypeGroupsList
- ReportsList
- Webhook
- WebhooksList
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header