API Reference
Search…
Live Videos
Empower Identity Checks with the most elaborate form of active liveness check.
A Live Video is a video of the client performing recital and movement challenges to ensure liveness. Typically, along with an ID document, they are used to perform Enhanced Identity Checks.
The live videos API allows you to retrieve, download, and delete live photos. You can retrieve a specific live video as well as a list of all your client's live videos.
Live videos can only be created and uploaded via the Web SDK and native Mobile SDKs..

The Live Video object

Attribute
Type
Description
id
string
The unique identifier for a live video.
clientId
string
The ID of the client associated with this live video.
language
string
The language for the recital challenge.
challenges
array[object]
The list of challenges associated with this live video. Also, see the challenge object below.
createdAt
string
The date and time when the live video was created.
updatedAt
string
The date and time when the live video was updated.

The challenge object

Attribute
Type
Description
type
string
The type of challenge. Valid values include:
  1. 1.
    voice
  2. 2.
    actions
value
array[string]
The expected recital or action challenge the client is expected to perform.