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.

Swagger link:
Test: Swagger UI (zignsec.com)

Prod : Swagger UI (zignsec.com)

Flow

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/identity_verification/liveness

Production environment: https://gateway.zignsec.com/core/api/sessions/identity_verification/liveness

Request example

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

{
  "metadata": {
    "locale": "en"
  },
  "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

metadataContain parameters like: locale : En,Se,de etc...(as per business requirements)required
redirect_successIf this parameter is supplied the browser session will finally be redirected to this URL-value (it’s applicable only if analysis with provider’s UI is used i.e. liveness) Example : "target": "https://landing.mysite.com"Not required
redirect_failuretarget_error works as target except it is navigated on user cancel or error situations.Not required
webhookA URL where success/error results will automatically be POST:ed. During test you try https://webhook.site/ for free webhook URLs.Not required

Step 1.3: Example of response for initializing scanning session

{
  "data": {
    "id": "51184044-036e-4d98-85ad-9e2c565a78a5",
    "redirect_url": "https://test.zignsec.com/v3/scan/51184044-036e-4d98-85ad-9e2c565a78a5",
    "status": "created"
  }
}

Step 1.4: Description of response model

idThe session identifier, a GUID (globally unique identifier) unique for the started workflow, used both in the redirect_url and the get analysis results.
errorsA JSON object that contains information on error conditions that might have resulted from the request, in an array of property-value pairs. If multiple errors occur, a pair of parameters is returned for each error. code Code for the error. List of codes is in table below. description A string that describes the type of error that occurred. If no errors occur, then this object is empty. errors : []
redirect_urlThe URL that the user need to be redirected to complete the data via the web interface. It is possible to load the URL in an iframe.
status

Indicates whether the verification of the customer is completed or not. Possible values are CREATED, FINISHED .

CREATEDis a temporary state indicating that the user is involved in the process
FINISHED is a final state showing that the customer has completed the entire process and the call has a final result.

Step 2: Browser steps

 There are two approaches to complete files upload to scanning:

    • Browser flow
    • Mobile flow

Step 2.1: Example of browser flow

Browser flow: Upload all images from current browser.

Authenticate with your access tokenControl your settings and Choose to scan through browser Follow instructions 1- Make a photo of document’s front side 

2- Confirm and start face analysis =>Align your face with the frame

Waiting for Analyzing and Getting result

(See details in the portal)

Step 2.2: Example of mobile flow

Mobile flow: start session in browser, continue in mobile, back to browser.

Browser steps
Authenticate with your access tokenControl your settings and Choose to scan through mobileScan QR code by mobile and access the link

Mobile steps
Open link from QR codeFollow instructions 1- Make a photo of document’s front side 2- Confirm and start face analysis =>Align your face with the frameWaiting for Analyzing and Getting result (See details in the portal)

Step 3: Get analysis result

To get result of scanning you need to call API Get result.