Verification Session

A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.

A VerificationSession transitions through multiple statuses throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user’s verified data after verification checks are complete.

Related guide: The Verification Sessions API

Endpoints

Create a VerificationSession

• POST /v1/identity/verification_sessions

Update a VerificationSession

• POST /v1/identity/verification_sessions/:id

Retrieve a VerificationSession

• GET /v1/identity/verification_sessions/:id

List VerificationSessions

• GET /v1/identity/verification_sessions

Cancel a VerificationSession

• POST /v1/identity/verification_sessions/:id/cancel

Redact a VerificationSession

• POST /v1/identity/verification_sessions/:id/redact

Events

• identity.verification_session.canceled Occurs whenever a VerificationSession is canceled

• identity.verification_session.created Occurs whenever a VerificationSession is created

• identity.verification_session.processing Occurs whenever a VerificationSession transitions to processing

• identity.verification_session.redacted Occurs whenever a VerificationSession is redacted.

• identity.verification_session.requires_input Occurs whenever a VerificationSession transitions to require user input

• identity.verification_session.verified Occurs whenever a VerificationSession transitions to verified