Liveness check with Face Verification

POST/v3/service

Prerequisite : Acquire requestID from mykad recognition response

Description: Please obtain the Liveness JS web sdk and sample code from Revenue Monster

Step 1. Navigate to API Key Page

Generate an API Key in the API Key page.

Step 2. Generate API Key

Enter a name and select ekyc.liveness as a scope. Click confirm. An API Key should be generated, store it in your application environment.

Step 3.Download the SDK.

Acquire the Liveness Web SDK from Revenue Monster.

Step 4. SDK Integration (Basic example)

Embedding the SDK into your web project is simple. Only a few parameters are required, they are as follows

a. apiKey – API Key generated from step 2
b. requestId – Can be obtained from the MyKad Recognition response payload
c. autoInit – Optional boolean value. Specifying it to false allows you to have a customization splash screen. Default to true.

A simple HTML example below should be sufficient to get the liveness app started.

Request Parameters

mykad_request_idString

Request ID from mykad recognition response

Example: "62201d48a694817dede84b35"

query_image_contentString

Face image (Base64 image string)

Example: ""

Response Parameters

• Current type in Status will be :-

  • "SUCCESS"
    
  • "FACE_ENGINE_CONNECTION_ERROR"
    
  • "INCOMPLETE"
    
  • "FACE_ENGINE_TIMEOUT"
    

• Current type in Action will be :-

  • "NONE_REQUIRED"
    
  • "ATTENTION_REQUIRED"
    
  • "INCONCLUSIVE"
    
  • "RESOLVED"
    

idString

Table ID

Example: "60f79b737b03abf23ad65206"

ekycIdString

EKYC ID

Example: "62201e0b239b18052126e28b"

actionString

Action Required

Example: NONE_REQUIRED

statusString

Verfication Status

Example: SUCCESS

isSamePersonBoolean

Visualization for result image

Example: true

similarityInt

Percentage of similarity of two faces

Example: 99

updatedAtDateTime

Last update date time

Example: "2021-07-21T15:07:43.266243"