Redeem a verification session ticket
Exchange a verification session’s ticket for the token that starts identity capture. Call this as the signed-in user the session was created for; the session is checked against that identity before it is spent.
A ticket can be redeemed once. A ticket that belongs to someone else is refused without being spent, so signing in as the right account and trying again works. An unknown, spent, or expired ticket is final — start a new session instead.
Send an Idempotency-Key header to make a retry safe: a repeat of the same redemption returns a token rather than spending a second session.
Headers
Client-generated key identifying one logical redemption. Reuse the same value when retrying so a lost response cannot spend the session twice.
Tenant org ID for multi-tenant auth
Controls how timestamp fields are serialized in JSON response bodies.
Default (header omitted or any other value): epoch milliseconds as integers.
iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.
Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".
Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.
Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.
"iso8601"
Path Parameters
Ticket issued when the verification session was created.
Response
Session redeemed
The verification credential a redeemed session buys.
HAL-style hypermedia links for navigation.
Short-lived access token for Sumsub Web SDK initialization.
Token validity period in seconds.
User ID associated with this token.
Verification level the token was minted against — use it to configure the SDK.
Identifier of the verification session that was redeemed.