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

GelatoSessionIdNumberOptions

object

Root JSON Schema

{"description":"A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user’s verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)","properties":{"client_secret":{"description":"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) to learn more.","maxLength":5000,"nullable":true,"type":"string"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"last_error":{"anyOf":[{"$ref":"#/components/schemas/gelato_session_last_error"}],"description":"If present, this property tells you the last error encountered when processing the verification.","nullable":true},"last_verification_report":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/identity.verification_report"}],"description":"ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/identity.verification_report"}]}},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"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.","type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["identity.verification_session"],"type":"string"},"options":{"$ref":"#/components/schemas/gelato_verification_session_options"},"redaction":{"anyOf":[{"$ref":"#/components/schemas/verification_session_redaction"}],"description":"Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.","nullable":true},"status":{"description":"Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).","enum":["canceled","processing","requires_input","verified"],"type":"string"},"type":{"description":"The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.","enum":["document","id_number"],"type":"string","x-stripeBypassValidation":true},"url":{"description":"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\u0026type=redirect) to learn how to redirect users to Stripe.","maxLength":5000,"nullable":true,"type":"string"},"verified_outputs":{"anyOf":[{"$ref":"#/components/schemas/gelato_verified_outputs"}],"description":"The user’s verified data.","nullable":true}},"required":["created","id","livemode","metadata","object","options","status","type"],"title":"GelatoVerificationSession","type":"object","x-expandableFields":["last_error","last_verification_report","options","redaction","verified_outputs"],"x-resourceId":"identity.verification_session"}