Docs
Session statuses
The status of the session is not the success flag of the call. Read it as the state of the verification.
Session statuses
| Status | Meaning |
|---|---|
idle | The session is created and ready, or a step has not started. |
processing | The session or a step is still being processed. |
success | The session or step completed successfully. |
failed | The session or step failed. A step is forced to failed when it has errors. |
exception | Processing ended with an exception. |
expired | The time to live of the session ran out. |
suspicious | The platform flagged the result as suspicious. |
Read the right field
The status field of a session is the session status. It is not the ok or error of a response envelope. A running session answers processing, and an expired one answers expired. Branch on this field and never on the text of a message.
Steps
The results list holds one entry per step, such as document, selfie, liveness and faces. Each entry carries its own status from the list above.
Questionnaire records
A questionnaire record is either idle, while the form is unfinished, or success, once it is filled in and committed. It is not a verdict.
Database checks
Verdicts of database checks, such as AML screening, are not part of the session body. Read them from the database checks method after the DATABASE_CHECKS_COMPLETE event. See webhooks.
Changing a status
A reviewer can change a session status manually in the dashboard, or through the status change method. See the quick start for the six operations.