API Reference

Liveness Attempts Array

📸 Result of each liveness attempt.

The liveness_attempts is an array to represent each attempt. It can be either a video attempt or a selfie attempt.

The liveness_attempts will be defined in a JSON array with the following structure:

"liveness_attempts": [
    {
      "result": false,
      "session_id": "d6994a68-4432-4e62-83d7-e242150cb293", 
      "video": {
        "url": "https://fakedomain.url",
        "size": 150688,
        "content_type": "video/webm"
      }
    }
  ]

Below is an array of liveness attempt results:

"liveness_attempts": [
    {
      "result": false,
      "session_id": "d6994a68-4432-4e62-83d7-e242150cb293",
      "actions": "SMILE LEFT",
      "video": {
        "url": "https://fakedomain.url",
        "size": 150688,
        "content_type": "video/webm"
      }
    }
  ]

Video Attempt

The liveness video is represented in the following structure if the user went through the liveness video:

{
    "actions": [
        "SMILE"
    ],
    "result": "boolean",
    "session_id": "d6994a68-4432-4e62-83d7-e242150cb293",
    "video": "<Asset>"
}

The details are explained as follows:

🚧

Note:

There will be various responses depending on user activity. There are two categories:

  • Mandatory: means the field and its value will always be returned, even with null values.
  • Optional: means the field would not exist in some cases. I.e., the transaction is not completed yet. Thus, some fields are missing.
FieldsData TypeMandatory/OptionalDescriptionPossible Responses
actionsarrayMandatoryIt is always an array with one item: SMILE.It will always be present.
resultbooleanMandatoryThe value will be true if the attempt is successful, false otherwise.It will always be present.
session_idstringMandatoryUUID for each session.It will always be present.
videoarray of objectsMandatoryThe video object.- If the data has been redacted the result will be invalid with null.

- Otherwise, it will always be present.

Selfie Attempt

The following is an example array response if the user went through a selfie image:

{
    "actions": [
        "SMILE"
    ],
    "result": true,
    "flow": "selfie",
    "images": [{
        "action": "SMILE",
        "base_image": "<Asset>",
        "original_image": "<Asset>"
    }]
}

The details are defined as follows:

🚧

Note:

There will be various responses depending on user activity. There are two categories:

  • Mandatory: means the field and its value will always be returned, even with null values.
  • Optional: means the field would not exist in some cases. I.e., the transaction is not completed yet. Thus, some fields are missing.
FieldsData TypeMandatory/OptionalDescriptionPossible Response
actionsarrayMandatoryIt is always an array with one item - SMILE.It will always be present.
resultbooleanMandatoryThe value is always true.It will always be present.
flowstringMandatoryThe value is always selfie.It will always be present.
imagesarray of objectsMandatoryIt is an array of items:

- action (Always SMILE),
- base_image (Resized image URL),
- original_image (Original image URL) fields in it.		- If the record is redacted, the value will be invalid with null.

- Otherwise, it will always be present.

💬 We Are Here to Help!

If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.