How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Onfido Documents API

The Documents API from Onfido — 5 operation(s) for documents.

Onfido Documents API is one of 45 APIs that Onfido publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 6 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version v3.6.

Requests are made against a single base URL, https://api.{region}.onfido.com/v3.6.

6 operations 5 paths 12 schemas 5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v3.6
Server
https://api.{region}.onfido.com/v3.6
Authentication
API Key
Contact
License
MIT
Resource Areas
1

Authentication & Security 1

Onfido Documents API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Token). By default, every request must be authenticated.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 6
GET
/documents
List documents
list_documents 1 param → 200default
POST
/documents
Upload a document
upload_document body → 201default
GET
/documents/{document_id}
Retrieve document
find_document 1 param → 200default
GET
/documents/{document_id}/download
Download document
download_document 1 param → 200default
GET
/documents/{document_id}/video/download
Download document video
download_document_video 1 param → 200default
GET
/qualified_electronic_signature/documents
Retrieves the signed document or application form
download_qes_document 2 params → 200302default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are document_response (6 properties), document_shared (5 properties), document_request (3 properties), ErrorProperties (3 properties). Each schema is shown below with its type and property counts.

ErrorProperties
object
3 properties
location_shared
object
2 properties
document_uploader
3 required
document_response
object
6 properties 1 required
country_codes
string
document_request
object
3 properties
Error
object
1 property
document_types
string
document
location_builder
Documents_list
object
1 property 1 required
document_shared
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onfido-documents-api-openapi.yml Raw ↑

Other APIs Onfido publishes across the network.

Onfido Addresses API
Onfido Applicants API
Onfido Attempts API
Onfido Cancel API
Onfido Capture API
Onfido Captures API
Onfido Checks API
Onfido Complete API
Onfido Download API
Onfido Downloads API
Onfido Electronic API
Onfido Evidence API
Where this information came from

This is an independent, third-party profile of Onfido Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.