API Reference

Results

💡 The overall result of the identity verification process.

results will be defined as a JSON object with the following structure:

{
    "overall": "string",
    "documents": "string",
    "facematch": "string",
    "liveness": "string",
    "data": "string"
}

The details are represented in the table below:

🚧

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
overallstringMandatoryThis represents the final result of all the checks that have been done.It will always be present.
documentsstringMandatoryThe overall check for documents, value can be FLAGGED or PASSED.It will always be present.
facematchstringOptionalThe overall check for facematch, value can be FLAGGED or PASSED.- The field will not exist if Document Only flow was enabled for this Client

- Otherwise, it will always be present.
livenessstringOptionalThe overall check for liveness, value can be FLAGGED or PASSED.- The field will not exist if Document Only flow was enabled for this Client

- Otherwise, it will always be present.
datastringOptionalThe overall check for data, value can be FLAGGED or PASSED.- The field will not exist if a Data provider check was not required for this transaction.

- Otherwise, it will always be present.

Below is a sample response to the result object:

"results": {
    "liveness": "PASSED",
    "overall": "FLAGGED",
    "data": "PASSED",
    "documents": "FLAGGED",
    "facematch": "FLAGGED"
  }

📘

Note:

Refer to the the Interpreting the Results for more information.

💬 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.