Liveness

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

Fields

Field	Type	Required	Description
fieldTypeId	string	Yes	Must be set to "Liveness" (from FieldTypeEnum)
faceDocumentId	string	Yes	ID of the uploaded face/selfie image document
isLivenessConfirmed	boolean	Yes	Whether the liveness check was successful
livenessDetail	object	Yes	Liveness provider details (see below)

Liveness Detail

The livenessDetail object is polymorphic — its shape depends on the providerType field.

Base Fields

Field	Type	Required	Description
providerType	string	Yes	The liveness provider. Must be "AWS" or "Regula"

AWS Provider

When providerType is "AWS":

Field	Type	Required	Description
providerType	string	Yes	Must be "AWS"
livenessResultId	string	Yes	The AWS liveness session result ID

Regula Provider

When providerType is "Regula":

Field	Type	Required	Description
providerType	string	Yes	Must be "Regula"

No additional fields are required for Regula.

Example Usage

AWS Provider

{
  "fieldId": "j0k1l2m3-4n5o-6p7q-8r9s-0t1u2v3w4x5y",
  "answer": {
    "fieldTypeId": "Liveness",
    "faceDocumentId": "d8f72bae-5c9a-4f8e-b8e7-19d8fcd7e34b",
    "isLivenessConfirmed": true,
    "livenessDetail": {
      "providerType": "AWS",
      "livenessResultId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }
}

Regula Provider

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