Liveness with two Factor Authentication

Document Scan, Liveness, Email Address Verification and Phone Number Verification

Step 1: Initialize session

POST to

Test enviornment : https://test-gateway.zignsec.com/core/api/sessions/workflow/liveness_with_two_factor_authentication

Production enviornment : https://gateway.zignsec.com/core/api/sessions/workflow/liveness_with_two_factor_authentication

Request Example

POST https://test-gateway.zignsec.com/core/api/sessions/workflow/liveness_with_two_factor_authentication
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"
}

1.2: Description of Request Model

ParamterDescriptionRequired
localePreferred Language to Use . example: En 
metadata  Yes
redirect_failureURL to redirect the end-user to on failure 
redirect_successURL to redirect the end-user to on success 
relay_stateThis optional parameter will be returned to you at the redirect back to your server. Use it to link an unique ID of your choice that you can parse. Examplerelaystate=zignsec_eid_1234No
webhook

A URL where success/error results will automatically be POST:ed.

During test you try https://webhook.site/  for free webhook URLs.

No

1.3: Example of Response Body

{
  "data": {
    "id": "474cc763-session id-bc861a99620c",
    "redirect_url": "https://test-gateway.zignsec.com/core/workflow_instances/474cc763-6fe7-session id-bc861a99620c"
  }
}

1.4: Description of Response Model

idA unique session identifier generated for each workflow instance.
redirect_urlRedirected  URL will open the below form

Fill all the details in the below mentioned Form and follow the steps to start the session.

1 - Consent

You have to give consent to go to next step.

2 - Personal Details

Fill all the mandatory fields.

3 - Select Document Type

4 - Identity Verification

The below link will redirect you to the identity verification of document.

5 - Verify Email

You will receive a mail once you add the documents, you can add the Verification code received below.

After verification of Email, you have to verify code received on the phone.

6 - Verify Phone Number