Liveness detection HTML5 (H5) version, is a critical security feature designed to thwart spoofing attacks during digital authentication processes.

This technology is employed in various web and mobile applications to ensure that the entity attempting access is a live human being rather than a photograph, video, mask, or another form of replicated biometric attack.

The liveness detection H5 leverages the capabilities of modern web browsers, allowing seamless integration into online platforms without the need for additional plugins or software installations. It utilizes sophisticated algorithms that analyze real-time video feeds for subtle movements, texture, and other indicators of physical presence.

Throughout the process, end users are instructed to perform gestures based on prompts like "open your mouth" and "blink your eyes." The outcome of the liveness detection could be retrieved from the backend, and a selfie is provided if it detects a live person.

Integration Steps

There are 3 steps to integrate H5 Liveness Detection:

1. Use the "Retrieve token API" to configure redirect URLs and other settings, which will generate the liveness detection token and H5 liveness detection URL.
2. The user completes the liveness detection process through the H5 liveness detection URL, and redirected to success and failure web page URL.
3. Use the "Retrieve result API" to obtain a selfie if the liveness detection is successful, or receive detailed results in case of failure.

1.Retrieve token API

Base URL

• Singapore：https://sg.apitd.net/verification/kyc/h5/liveness/token/v1
• Indonesia：https://id-credit.apitd.net/verification/kyc/h5/liveness/token/v1

API

Authentication

Request

Response Parameters

Response Example

• Request

  JSON

  {
  	"success_redirect": "http://www.google.com",
  	"failure_redirect": "http://www.facebook.com",
  	"language": "en",
  	"audio": true
  }
  

• Success

{
    "code": 200,
    "message": "success",
    "sequence_id": "17119500882*****29",
    "token": "a41701e4-b2a2-4f62-8cd4-9******3",
    "url": "https://static.tongdun.net/liveness/index.html#/progress?code=a41701e4-b2a2-4f62-8cd4-9******3&success_redirect=http%3A%2F%2Fwww.google.com&failure_redirect=http%3A%2F%2Fwww.facebook.com&language=en&audio=true&"
}

• Failed

{
    "code": 11350,
    "sequence_id": "69b57131b6fb********61ccba118b60",
    "message": "Internal error"
}

2.Liveness detection and page redirection

After completing the liveness detection, the page will automatically redirect to the callback page configured by the customer: either the success page [successURL] or the failure page [failureURL].
Callback page URL examples:
● Successful callback example: [successURL]?code=7ac3a964-f540-4aa2-acdf-59ea1639572e&state=0
● Failed callback example: [failureURL]?code=7ac3a964-f540-4aa2-acdf-59ea1639572e&state=2

When the page is redirected, if the customer's callback page receives the parameter "state" with a value of 0 or 2 after the completion of liveness detection, it can proceed to call the API to retrieve the result of the liveness detection. For other values of "state" besides 0 or 2, please refer to the following explanation and suggestions.

3.Retrieve result API

Base URL

• Singapore：https://sg.apitd.net/verification/kyc/h5/liveness/result/v1
• Indonesia：https://id-credit.apitd.net/verification/kyc/h5/liveness/result/v1

API

Authentication

Request

Response Parameters

API Code

Response Example

• Request

  JSON

  {
      "token":"a41701e4-b2a2-4f62-8cd4-9******3"
  }
  

• Success

{
    "code": 200,
    "message": "Success",
    "sequence_id": "1711950327713613G109E0A081240931",
    "image": "/9j/4AAFbs64"
}

• Failed

{
    "code": 11350,
    "sequence_id": "69b57131b6fb********61ccba118b60",
    "message": "Internal error"
}