Passive Liveness

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 (zignsec.com)

Prod : Swagger UI (zignsec.com)

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

POST to

Test environment: https://test-gateway.zignsec.com/core/api/sessions/workflow/premium_liveness

Production environment: https://gateway.zignsec.com/core/api/sessions/workflow/premium_liveness

Request example

POST https://test-gateway.zignsec.com/core/api/sessions/workflow/premium_liveness
Content-Type: application/json
Authorization: 12345678-YOUR-ACCESS-TOKEN-5352305c9fb0
Content-Length: 725

{
  "locale": "En",
  "metadata": {},
  "redirect_failure": "https://my_failure_url.com",
  "redirect_success": "https://my_success_url.com",
  "relay_state": "my-unique-customer-id",
  "webhook": "https://my_webhook_url.com"
}

Step 1.2: Description of request model

Parameter	Description	Required
`locale`	Preferred Language to Use. example: En
`redirect_failure`	URL to redirect the end-user to on failure
`redirect_success`	URL to redirect the end-user to on success
`relay_state`	Optional Custom Parameter to be included in webhook calls
`webhook`	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": "https://test-gateway.zignsec.com/core/workflow_instances/ae01df3a-1482-44d4-9074-e82d4e0cc415"
  }
}

Step 1.4: Description of response model

`id`	Unique Identifier for the Workflow Session
`redirect_url`	Redirection 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 1	Step 2	Step 3	Step 4

Step 3: Get analysis result

GET to https://test-gateway.zignsec.com/core/api/sessions/51184044-036e-4d98-85ad-9e2c565a78a5 to know the status of request

You can also receive results in Webhook.

Our APIs