Skip to main content
POST
Handles `POST /v1/verifications/result-codes/exchange`.

Authorizations

Authorization
string
header
required

A tenant API key. Acts for exactly one tenant and cannot conclude a case, because a conclusion records a person.

Body

application/json

A code presented for exchange.

code
string
required

The code from the return redirect.

Response

The session's result; the code is now spent

A hosted session's result, as the customer may read it.

checks
object[]
required

Per-check results so far, worded from the check's kind, outcome and reason code; never from stored text.

created_at
string
required

RFC 3339 opening time.

intent
string
required

FIRST_TIME or REVERIFICATION.

reasons
object[]
required

Why, as stable codes with customer-safe wording. A stored code this build does not describe is UNSPECIFIED.

status
string
required

PENDING, PASSED, REVIEW_REQUIRED, FAILED or EXPIRED.

subject_id
string
required

The person, as the customer identified them.

verification_session_id
string
required

Session identifier.

completed_at
string | null

RFC 3339 completion time, once concluded.

decision
null | enum<string>

Its outcome.

Available options:
ALLOW,
WARN,
BLOCK,
HOLD,
REVIEW_REQUIRED,
FLAG,
BLOCK_RECOMMENDED,
SUSPEND,
END_STREAM
decision_id
string | null

The decision, once there is one.

flow
null | object

The flow the session ran under, when one was named.

review_case_id
string | null

The review case, when the outcome needs a person.

risk_level
null | enum<string>

Its risk level.

Available options:
LOW,
MEDIUM,
HIGH,
CRITICAL