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 Applicants API

The Applicants API from Onfido — 3 operation(s) for applicants.

Onfido Applicants 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 Applicants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 6 operations across 3 paths, and defines 21 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 3 paths 21 schemas 1 DELETE2 GET2 POST1 PUT

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 Applicants 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 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Applicants 6
GET
/applicants
List Applicants
list_applicants 3 params → 200default
POST
/applicants
Create Applicant
create_applicant body → 201default
DELETE
/applicants/{applicant_id}
Delete Applicant
delete_applicant 1 param → 204default
GET
/applicants/{applicant_id}
Retrieve Applicant
find_applicant 1 param → 200default
PUT
/applicants/{applicant_id}
Update Applicant
update_applicant 1 param body → 200default
POST
/applicants/{applicant_id}/restore
Restore Applicant
restore_applicant 1 param → 204default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are address_shared (12 properties), applicant_response (9 properties), applicant_shared (4 properties), ErrorProperties (3 properties). Each schema is shown below with its type and property counts.

ErrorProperties
object
3 properties
address_builder
applicant_updater
location_shared
object
2 properties
applicant
applicant_create
object
2 properties 2 required
applicant_update
object
2 properties
applicant_request
object
3 properties
Applicants_list
object
1 property 1 required
id_number
object
3 properties
location
applicant_consent_name
string
country_codes
string
address
applicant_builder
location_builder
address_shared
object
12 properties 2 required
applicant_shared
object
4 properties
applicant_response
object
9 properties 1 required
Error
object
1 property
applicant_consent_builder
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onfido-applicants-api-openapi.yml Raw ↑

Other APIs Onfido publishes across the network.

Onfido Addresses API
Onfido Attempts API
Onfido Cancel API
Onfido Capture API
Onfido Captures API
Onfido Checks API
Onfido Complete API
Onfido Documents 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 Applicants 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.