Liveliness Verification

This is where the real-time liveliness verification occurs

Note: This API endpoint is currently under management and is currently subject for an update. Please wait until further notice from our team to implement.

This is the third step in the eKYC request creation process. Here, you will need to upload a short video of the applicant or user's face. This video will be used to verify the liveliness of the user. In the video, the applicant or user should make minor movements or pronounce their birth year (four digits) as found in the submitted government-issued document. The video should be kept under 15 seconds, and be in MP4, MOV, or AVI format. Options to provide either a remote video URL or base64 of the video will be given. If you choose to go with base64, please ensure that the video is under 30MB in size. We recommend to keep the video under 30MB to ensure a smooth process. Along with the video, please also provide the document ID.

When uploading a base64 video, please ensure that you have added the appropriate MIME type tag for the video format you are using. Here are examples of the MIME types for different video formats:

For .mp4 videos, use 'data:video/mp4;base64,' followed by the base64 encoded data. For example: 'data:video/mp4;base64,Your Link'

For .avi videos, use 'data:video/x-msvideo;base64,' followed by the base64 encoded data. For example: 'data:video/x-msvideo;base64,Your Link'

For .mov videos, use 'data:video/quicktime;base64,' followed by the base64 encoded data. For example: 'data:video/quicktime;base64,Your Link'

Request Endpoint: /api/liveliness-authentication Request Type: POST

Header:

{
  "Content-Type": "application/json",
  "Accept": "application/json",
  "x-api-key": "Your API key"
}

Body: (When opting to upload video using a URL)

{
    "faceVideo":"https://example.com/faceVideo.mp4",
    "documentIdentificationId":"64d3a6f3-6f71-4e15-a6ee-08b95b8f724e"
}

Body: (When opting to upload video using a base64)

{
    "faceVideo_base64":"AAAAAAAAhxchvbhbvcxvc/4QBMRXhpZgAATU0AKgAAAAgAAgESAAMAAAABAAYAAIdpAAQA................",
    "documentIdentificationId":"64d3a6f3-6f71-4e15-a6ee-08b95b8f724e"
}

faceImage: Face video URL of user. documentIdentificationId: The unique ID returned from the previously uploaded document.

Note: Please make sure to provide the actual path of the video file as the video URL. This URL should be the direct location where the video file is stored.

Successful Response: Upon successful liveliness verification, the API response will resemble the following structure:

Response status: 200

{
    "message": "liveliness verification PASSED!",
}