We return a status at the top-level of our API responses describing the current status of each verification session. The possible values, along with their meanings, are listed below.
Within the dashboard, these statuses are referred to by the values in the "Status" column. In API responses, they are returned as the strings in the "Returned as" column below.
| Status | Returned as | Description |
|---|---|---|
| Success | success | The session is complete and the user was passed according to your project. |
| Fail | fail | The session is complete and the user was rejected according to your project. |
| Awaiting Input | awaiting_user_input | The session is not complete and there is some piece of user information CLEAR still needs to collect. |
| Processing Data | processing_data | The session is not complete yet and CLEAR is processing the user's data. Please listen to events via webhooks to get updates on this verification session. |
| Expired | expired | The session is not complete, is expired, and cannot accept any more data. Please create a new verification session. Verification sessions expire after 10 days. |
| Needs Review | awaiting_manual_review | The session is complete and awaiting manual review. |
| Manual Pass | manual_success | The session is complete, was sent to manual review, and was set to pass by a human reviewer. |
| Manual Fail | manual_fail | The session is complete, was sent to manual review, and was set to fail by a human reviewer. |
| Canceled | canceled | The "Canceled" status represents a user who has actively chosen to exit the verification session before providing any data. |