Onfido Public API v3.6

REST discovered

Details

URL: https://api.{region}.onfido.com/v3.6
Spec: https://raw.githubusercontent.com/onfido/onfido-openapi-spec/master/openapi.yaml
Spec (json): https://raw.githubusercontent.com/onfido/onfido-openapi-spec/master/generated/artifacts/openapi-reference/openapi.json
Docs: https://documentation.identity.entrust.com/api/latest/

Authentication

API token api_key discovered Get key ↗

In the Onfido Dashboard, go to Developers → API authentication → Tokens, choose Generate API token, select Sandbox or Live, and click Generate. Sandbox tokens start with api_sandbox; live tokens start with api_live. The docs note these tokens are for server-side use only.

OAuth client credentials application oauth2_cc discovered Set up OAuth ↗

In the Onfido Dashboard, go to Developers → API authentication → OAuth applications, click Create application, choose the environment, select scopes, and save. Copy the client_id and the one-time client_secret, then exchange them for an access token using the client-credentials token endpoint https://api.{region}.onfido.com/v3.6/oauth/token. OAuth authentication is available for API v3.6 onward.