KYC Asia Workflow

Step 1: Initialize session

POST to

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

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

Request Example

POST https://test-gateway.zignsec.com/core/api/sessions/workflow/kyc_asia
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_stateOptional Custom Parameter to be included in webhook callsNo
webhook

Webhook URL where your backend will receive session events.

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 and follow the steps to start the session.

Step1 : Choose the type of Documentstep2 : Complete the verification and liveness actionsstep3 : Review and confirm the details captured from the scanning session
   

2: GET Results

To GET the results send the GET request with the session id or in the Webhook.

GET to https://test-gateway.zignsec.com/core/api/sessions/474cc763-session id-bc861a99620c