Core concepts

Results and outcomes

The outcome, reasons and captures fields.

When the checks finish, a session gets an outcome. The reasons explain it.

link Outcomes

outcome is null until there's a decision. It's the same value as status once the session ends with one.

link Reasons

reasons is a list of short codes saying why a session wasn't clear. They're stable, so you can act on them in code, for example to ask a customer to try again with a different document. The list is empty for a clear session.

Each code is a finding, such as DOC_MRZ_CHECKDIGIT_FAIL or FACE_NO_MATCH. checks lists every check's result and findings.

link Review

A consider session waits for your team under Verifications → Needs review. The reviewer approves (clear), rejects (rejected) or asks for a retry, and gives a reason code, which becomes reasons. A retry rejects the session with REVIEW_RETRY and starts a new one for the same reference: its id is retry_session_id, and its link is shown in the dashboard. You get a session.completed webhook either way.

ActionReason codes
approveDOCUMENT_CONFIRMED READING_CORRECTED FACE_CONFIRMED LIVENESS_CONFIRMED
rejectDOCUMENT_ALTERED DOCUMENT_RECAPTURED DOCUMENT_INVALID FACE_MISMATCH NOT_LIVE OTHER_FRAUD
retryPHOTO_UNREADABLE DOCUMENT_CUT_OFF SELFIE_UNUSABLE WRONG_DOCUMENT

link Retention

Photos and video are deleted after your workspace's retention period (30 days by default), counted from the decision. The details read from the document are deleted 90 days after it. The outcome, reasons and checks are kept for two years, for audit.

link What was captured

captures counts the photos and video we have for the session, by kind:

KindWhat it is
doc_frontThe front of the ID (or the passport's photo page)
doc_backThe back of a driving licence
selfie_clipThe short selfie video
selfie_keyframeStill frames from the selfie

document_type and document_country are the document they chose, such as driving_licence from GBR.

link Seeing the evidence

The API returns the decision, not the photos. Your team can see a session's photos, video and timeline in the dashboard under Verifications. Every view is recorded in your audit log, because they're biometric data.

Was this page helpful?

Authorization

Your secret key stays in this tab: it is sent with this request only and never stored.

Body application/json

Response

Send the request to see the response.