class Stripe::IdentityVerificationSession

Overview

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

Included Modules

Defined in:

stripe/models/identity_verification_session.cr

Constant Summary

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def _type : String | Nil #

[View source]
def _type=(new_value : String | Nil) #

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


[View source]
def client_reference_id : String | Nil #

[View source]
def client_reference_id=(new_value : String | Nil) #

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


[View source]
def client_secret : String | Nil #

[View source]
def client_secret=(new_value : String | Nil) #

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


[View source]
def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]

[View source]
def last_error=(new_value : Stripe::IdentityVerificationSessionLastError | Nil) #

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


[View source]
def last_verification_report : Stripe::IdentityVerificationSessionLastVerificationReport | Nil #

[View source]
def 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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(new_value : Hash(String, String) | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]

[View source]
def options=(new_value : Stripe::IdentityVerificationSessionOptions | Nil) #

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


[View source]

[View source]
def provided_details=(new_value : Stripe::IdentityVerificationSessionProvidedDetails | Nil) #

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


[View source]
def provided_details_present=(provided_details_present : Bool) #

[View source]
def provided_details_present? : Bool #

[View source]

[View source]
def redaction=(new_value : Stripe::IdentityVerificationSessionRedaction | Nil) #

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


[View source]
def related_customer : String | Nil #

[View source]
def related_customer=(new_value : String | Nil) #

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


[View source]
def status : String | Nil #

[View source]
def status=(new_value : String | Nil) #

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


[View source]
def url : String | Nil #

[View source]
def url=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]
def verification_flow : String | Nil #

[View source]
def verification_flow=(new_value : String | Nil) #

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


[View source]

[View source]
def verified_outputs=(new_value : Stripe::IdentityVerificationSessionVerifiedOutputs | Nil) #

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


[View source]
def verified_outputs_present=(verified_outputs_present : Bool) #

[View source]
def verified_outputs_present? : Bool #

[View source]