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

The Live API from Onfido — 7 operation(s) for live.

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

This API exposes 8 operations across 7 paths, and defines 9 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.

8 operations 7 paths 9 schemas 7 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 Live 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 8

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

Live 8
GET
/live_photos
List live photos
list_live_photos 1 param → 200default
POST
/live_photos
Upload live photo
upload_live_photo body → 201default
GET
/live_photos/{live_photo_id}
Retrieve live photo
find_live_photo 1 param → 200default
GET
/live_photos/{live_photo_id}/download
Download live photo
download_live_photo 1 param → 200default
GET
/live_videos
List live videos
list_live_videos 1 param → 200default
GET
/live_videos/{live_video_id}
Retrieve live video
find_live_video 1 param → 200default
GET
/live_videos/{live_video_id}/download
Download live video
download_live_video 1 param → 200default
GET
/live_videos/{live_video_id}/frame
Download live video frame
download_live_video_frame 1 param → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are live_video (8 properties), live_photo_response (7 properties), ErrorProperties (3 properties), live_photo_request (3 properties). Each schema is shown below with its type and property counts.

ErrorProperties
object
3 properties
live_photo_request
object
3 properties
Live_Photos_list
object
1 property 1 required
live_photo_uploader
2 required
Error
object
1 property
live_photo_response
object
7 properties 1 required
live_photo
live_video
object
8 properties
Live_Videos_list
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onfido-live-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 Documents API
Onfido Download API
Onfido Downloads API
Onfido Electronic API
Where this information came from

This is an independent, third-party profile of Onfido Live 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.