Liveness is used to protect against biometric attacks. It’s a proof of a real person working on Id analysis, Face biometry verification and Liveness verification. With a passive liveness check, users are not required to perform motion tasks, they are performed ‘passively’ in the background. This makes for a much faster and more user-friendly experience. It can also serve as a standalone product for passwordless biometric logins.

Swagger link:
Test: Swagger UI (

Prod :  Swagger UI (

Step 1: Initialize scanning session

 Note: Liveness is video based only and no audio is available.

Step 1.1: Create a new Browser flow (web flow) scanning session


Test environment:

Production environment:

Request example

Content-Type: application/json
Authorization: 12345678-YOUR-ACCESS-TOKEN-5352305c9fb0
Content-Length: 725

  "locale": "En",
  "metadata": {},
  "redirect_failure": "",
  "redirect_success": "",
  "relay_state": "my-unique-customer-id",
  "webhook": ""

Step 1.2: Description of request model


Preferred Language to Use. example: En


URL to redirect the end-user to on failure


URL to redirect the end-user to on success


Optional Custom Parameter to be included in webhook calls


Webhook URL where your backend will receive session events.


Step 1.3: Example of response for initializing scanning session

  "data": {
    "id": "51184044-036e-4d98-85ad-9e2c565a78a5",
    "redirect_url": ""

Step 1.4: Description of response model

idUnique Identifier for the Workflow Session
redirect_urlRedirection URL to the Workflow Session

Step 2: Browser steps

1 – Once you open the redirect URL. Please choose the type of document and Give Consent to proceed further with the scanning.

2 – once you choose the document type you will be redirected to the scanning session.

3- Once document scanning is done, click on continue to record the liveness video

4- Process completion

Step 1Step 2Step 3Step 4

Step 3: Get analysis result

GET to to know the status of request

You can also receive results in Webhook.