API Reference

Statistics

📊 A computed number of steps during verification.

computed_statistics will be defined in a JSON object with the following structure:

{
    "steps": "[<Step>]",
    "total_duration_excl_privacy_seconds": "integer",
    "total_duration_seconds": "integer"
}

The details of each field are 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
stepsarrayMandatoryArray of detailed steps that user went through. Each step will be defined in a JSON object with the structure including name, start_time, and total_duration_seconds.It will always be present.
total_duration_excl_privacy_secondsintegerMandatoryDuration in seconds taken to complete a transaction, excluding privacy policy review.It will always be present.
total_duration_secondsintegerMandatoryDuration in seconds taken to complete a transaction after the transaction is opened.It will always be present.

Below is a sample response of the computed_statistics object:

"computed_statistics": {
    "steps": [
      {
        "name": "PRIVACY",
        "start_time": "2022-03-03T03:28:34.607Z",
        "total_duration_seconds": 55
      },
      {
        "name": "ID_INFORMATION",
        "start_time": "2022-03-03T03:29:30.127Z",
        "total_duration_seconds": 22
      },
      {
        "name": "FACE_MATCH_CAPTURE",
        "start_time": "2022-03-03T03:29:52.654Z",
        "total_duration_seconds": 28
      },
      {
        "name": "SUBMITTED",
        "start_time": "2022-03-03T03:30:21.226Z",
        "total_duration_seconds": 0
      }
    ],
    "total_duration_seconds": 105,
    "total_duration_excl_privacy_seconds": 50
  }

Statistics - Steps

steps is an array of detailed steps that the user went through. A step will defined as a JSON object with the following structure:

{
    "name": "string",
    "start_time": "timestamp",
    "total_duration_seconds": "integer"
}

❗️

Note:

The steps can be different based on the flow type that the user chooses. They also depend on the user activity during the verification process.

The details are defined as follows:

FieldsData TypeMandatory/OptionalDescriptionPossible Response
namestringMandatoryVerification's step name.It will always be present.
start_timetimestampMandatoryTimestamp at which the user arrived to the verification step.It will always be present.
total_duration_secondsintegerMandatoryTotal duration in seconds until user moves on to the next verification step.It will always be present.

Below is a sample steps array response:

"steps": [
      {
        "name": "PRIVACY",
        "start_time": "2022-03-03T03:28:34.607Z",
        "total_duration_seconds": 55
      },
      {
        "name": "ID_INFORMATION",
        "start_time": "2022-03-03T03:29:30.127Z",
        "total_duration_seconds": 22
      },
      {
        "name": "FACE_MATCH_CAPTURE",
        "start_time": "2022-03-03T03:29:52.654Z",
        "total_duration_seconds": 28
      },
      {
        "name": "SUBMITTED",
        "start_time": "2022-03-03T03:30:21.226Z",
        "total_duration_seconds": 0
      }
    ]

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