Skip to main content
Manja / Stripe
Schema2020-08-27object

identity.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](/docs/identity/verification-checks) to perform. Only create one VerificationSession for each verification in your system. A VerificationSession transitions through [multiple statuses](/docs/identity/how-sessions-work) 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](https://stripe.com/docs/identity/verification-sessions)

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

GelatoVerificationSession

object

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](/docs/identity/verification-checks) to perform. Only create one VerificationSession for each verification in your system. A VerificationSession transitions through [multiple statuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through the verification flow. The VerificationSession …

client_secret string
optionalnullable

The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) t…

maxLength:5000

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

id string
required

Unique identifier for the object.

maxLength:5000

last_error
optionalnullable

If present, this property tells you the last error encountered when processing the verification.

last_verification_report
optionalnullable

ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata object
required

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "identity.verification_session"

redaction
optionalnullable

Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.

status string
required

Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).

Allowed: "canceled""processing""requires_input""verified"

type string
required

The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.

Allowed: "document""id_number"

url string
optionalnullable

The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.

maxLength:5000

verified_outputs
optionalnullable

The user’s verified data.