class

Stripe::IdentityVerificationReport

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie. Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API. Related guide: Accessing verification results.

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_report]."
MAX_LENGTH_FOR_CLIENT_REFERENCE_ID = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_VERIFICATION_FLOW = 5000
MAX_LENGTH_FOR_VERIFICATION_SESSION = 5000
VALID_VALUES_FOR__TYPE = String.static_array("document", "id_number", "verification_flow")
VALID_VALUES_FOR_OBJECT = String.static_array("identity.verification_report")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, client_reference_id : String | Nil = nil, created : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, _type : String | Nil = nil, verification_session : String | Nil = nil, document : Stripe::GelatoDocumentReport | Nil = nil, email : Stripe::GelatoEmailReport | Nil = nil, id_number : Stripe::GelatoIdNumberReport | Nil = nil, options : Stripe::GelatoVerificationReportOptions | Nil = nil, phone : Stripe::GelatoPhoneReport | Nil = nil, selfie : Stripe::GelatoSelfieReport | Nil = nil, verification_flow : String | Nil = nil)

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

Source

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

Type of report.

Source
_type=(new_value : String | Nil)

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

Source
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.

Source
client_reference_id=(new_value : String | Nil)

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

Source
created

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

Source
created=(new_value : Int64 | Nil)

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

Source
document
Source
document=(new_value : Stripe::GelatoDocumentReport | Nil)

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

Source
email
Source
email=(new_value : Stripe::GelatoEmailReport | Nil)

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

Source
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.

Source
id=(new_value : String | Nil)

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

Source
id_number
Source
id_number=(new_value : Stripe::GelatoIdNumberReport | Nil)

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

Source
list_invalid_properties

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

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

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

Source
object

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

Source
object=(new_value : String | Nil)

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

Source
options
Source
options=(new_value : Stripe::GelatoVerificationReportOptions | Nil)

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

Source
phone
Source
phone=(new_value : Stripe::GelatoPhoneReport | Nil)

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

Source
selfie
Source
selfie=(new_value : Stripe::GelatoSelfieReport | Nil)

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

Source
valid?

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

Source
verification_flow

The configuration token of a Verification Flow from the dashboard.

Source
verification_flow=(new_value : String | Nil)

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

Source
verification_session

ID of the VerificationSession that created this report.

Source
verification_session=(new_value : String | Nil)

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

Source