class

Stripe::IdentityVerificationSession

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < 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 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

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [document, id_number, verification_flow]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [identity.verification_session]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [canceled, processing, requires_input, verified]."

MAX_LENGTH_FOR_CLIENT_REFERENCE_ID = 5000

MAX_LENGTH_FOR_CLIENT_SECRET = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_RELATED_CUSTOMER = 5000

MAX_LENGTH_FOR_URL = 5000

MAX_LENGTH_FOR_VERIFICATION_FLOW = 5000

VALID_VALUES_FOR__TYPE = String.static_array("document", "id_number", "verification_flow")

VALID_VALUES_FOR_OBJECT = String.static_array("identity.verification_session")

VALID_VALUES_FOR_STATUS = String.static_array("canceled", "processing", "requires_input", "verified")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, client_reference_id : String | Nil = nil, client_secret : String | Nil = nil, created : Int64 | Nil = nil, id : String | Nil = nil, last_error : Stripe::IdentityVerificationSessionLastError | Nil = nil, last_verification_report : Stripe::IdentityVerificationSessionLastVerificationReport | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, options : Stripe::IdentityVerificationSessionOptions | Nil = nil, redaction : Stripe::IdentityVerificationSessionRedaction | Nil = nil, related_customer : String | Nil = nil, status : String | Nil = nil, _type : String | Nil = nil, url : String | Nil = nil, provided_details : Stripe::IdentityVerificationSessionProvidedDetails | Nil = nil, verification_flow : String | Nil = nil, verified_outputs : Stripe::IdentityVerificationSessionVerifiedOutputs | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_type

The type of verification check to be performed.

_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

client_reference_id

A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.

client_reference_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] client_reference_id Object to be assigned

client_secret

The short-lived client secret used by Stripe.js to show a verification 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 to learn more.

client_secret=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] client_secret Object to be assigned

created

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

created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

last_error

last_error=(new_value : Stripe::IdentityVerificationSessionLastError | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_error Object to be assigned

last_verification_report

last_verification_report=(new_value : Stripe::IdentityVerificationSessionLastVerificationReport | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_verification_report Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

livemode

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

livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

metadata

metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

object

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

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

options

options=(new_value : Stripe::IdentityVerificationSessionOptions | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] options Object to be assigned

provided_details

provided_details=(new_value : Stripe::IdentityVerificationSessionProvidedDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] provided_details Object to be assigned

provided_details_present=(provided_details_present : Bool)

provided_details_present?

redaction

redaction=(new_value : Stripe::IdentityVerificationSessionRedaction | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] redaction Object to be assigned

related_customer

Token referencing a Customer resource.

related_customer=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] related_customer Object to be assigned

status

Status of this VerificationSession. Learn more about the lifecycle of sessions.

status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

url

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 to learn how to redirect users to Stripe.

url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] url Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

verification_flow

The configuration token of a Verification Flow from the dashboard.

verification_flow=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] verification_flow Object to be assigned

verified_outputs

verified_outputs=(new_value : Stripe::IdentityVerificationSessionVerifiedOutputs | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] verified_outputs Object to be assigned

verified_outputs_present=(verified_outputs_present : Bool)

verified_outputs_present?