Onfido Videos API
The Videos API from Onfido — 4 operation(s) for videos.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/onfido-videos-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
name: Onfido
url: https://public.support.onfido.com
description: "\nCreate trust at onboarding and beyond with a complete, AI-powered digital\nidentity solution built to help you know your customers online. \nAutomation allows you to acquire new customers and reduce costs while\nmeeting global KYC and AML compliance."
license:
name: MIT
title: Onfido Videos API
version: v3.6
servers:
- url: https://api.{region}.onfido.com/v3.6
variables:
region:
default: eu
enum:
- eu
- us
- ca
security:
- Token: []
tags:
- name: Videos
paths:
/live_videos:
get:
description: 'Lists all the live videos that belong to an applicant.
'
operationId: list_live_videos
parameters:
- description: The id of the applicant the live videos belong to.
in: query
name: applicant_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Live_Videos_list'
description: An array of live videos
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: List live videos
tags:
- Videos
/live_videos/{live_video_id}:
get:
description: 'Retrieves a single live video. Returns the corresponding live video object.
'
operationId: find_live_video
parameters:
- description: The live video's unique identifier.
in: path
name: live_video_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/live_video'
description: A live video
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Retrieve live video
tags:
- Videos
/live_videos/{live_video_id}/download:
get:
description: Live videos are downloaded using this endpoint.
operationId: download_live_video
parameters:
- description: The live video's unique identifier.
in: path
name: live_video_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
'*/*':
schema:
format: binary
type: string
description: The live video's binary data.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Download live video
tags:
- Videos
/live_videos/{live_video_id}/frame:
get:
description: Returns the binary data representing a single frame from a live video.
operationId: download_live_video_frame
parameters:
- description: The live video's unique identifier.
in: path
name: live_video_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
'*/*':
schema:
format: binary
type: string
description: The live video frame's binary data.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Download live video frame
tags:
- Videos
components:
schemas:
Live_Videos_list:
example:
live_videos:
- download_href: download_href
file_name: file_name
file_type: file_type
created_at: '2000-01-23T04:56:07.000Z'
challenge:
- key: ''
- key: ''
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
href: href
file_size: 0
- download_href: download_href
file_name: file_name
file_type: file_type
created_at: '2000-01-23T04:56:07.000Z'
challenge:
- key: ''
- key: ''
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
href: href
file_size: 0
properties:
live_videos:
items:
$ref: '#/components/schemas/live_video'
type: array
required:
- live_videos
title: Live Videos list
type: object
live_video:
example:
download_href: download_href
file_name: file_name
file_type: file_type
created_at: '2000-01-23T04:56:07.000Z'
challenge:
- key: ''
- key: ''
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
href: href
file_size: 0
properties:
id:
description: The unique identifier for the video.
format: uuid
type: string
created_at:
description: The date and time at which the video was uploaded.
format: date-time
type: string
href:
description: The uri of this resource.
type: string
download_href:
description: The uri that can be used to download the video.
type: string
file_name:
description: The name of the uploaded file.
type: string
file_size:
description: The size of the file in bytes.
type: integer
file_type:
description: The file type of the uploaded file.
type: string
challenge:
description: Challenge the end user was asked to perform during the video recording.
items:
additionalProperties: true
type: object
type: array
type: object
Error:
example:
error:
type: type
message: message
fields:
key: ''
properties:
error:
$ref: '#/components/schemas/ErrorProperties'
title: Error
type: object
ErrorProperties:
example:
type: type
message: message
fields:
key: ''
properties:
type:
type: string
message:
type: string
fields:
additionalProperties: true
type: object
title: ErrorProperties
type: object
securitySchemes:
Token:
in: header
name: Authorization
type: apiKey
externalDocs:
url: https://documentation.onfido.com