Skip to main content

Liveness

The Liveness Answer is used to submit liveness verification results, which confirm that the person is physically present during the verification process.

Fields

FieldTypeRequiredDescription
fieldTypeIdstringYesMust be set to "Liveness" (from FieldTypeEnum)
faceDocumentIdstringYesID of the uploaded face/selfie image document
isLivenessConfirmedbooleanYesWhether the liveness check was successful
livenessDetailobjectYesDetails of the liveness session that produced this result. The exact shape depends on how your integration is configured — contact your Azakaw representative for the values that apply to you.

Example Usage

{
"fieldId": "j0k1l2m3-4n5o-6p7q-8r9s-0t1u2v3w4x5y",
"answer": {
"fieldTypeId": "Liveness",
"faceDocumentId": "d8f72bae-5c9a-4f8e-b8e7-19d8fcd7e34b",
"isLivenessConfirmed": true,
"livenessDetail": { }
}
}

Capturing the face image

Use the Liveness Web SDK to run the check in the browser. Its success event returns the captured selfie, which you upload with the Document Upload API to obtain the faceDocumentId used above.