class Stripe::IdentityVerificationReport

• Stripe::IdentityVerificationReport
• Reference
• Object

Overview

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.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

stripe/models/identity_verification_report.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_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)
• .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

Instance Method Summary

• #==(other : self)

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

• #_type : String | Nil
• #_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #client_reference_id : String | Nil
• #client_reference_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #document : Stripe::GelatoDocumentReport | Nil
• #document=(new_value : Stripe::GelatoDocumentReport | Nil)

  Custom attribute writer method checking allowed values (enum).

• #email : Stripe::GelatoEmailReport | Nil
• #email=(new_value : Stripe::GelatoEmailReport | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #id_number : Stripe::GelatoIdNumberReport | Nil
• #id_number=(new_value : Stripe::GelatoIdNumberReport | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #options : Stripe::GelatoVerificationReportOptions | Nil
• #options=(new_value : Stripe::GelatoVerificationReportOptions | Nil)

  Custom attribute writer method checking allowed values (enum).

• #phone : Stripe::GelatoPhoneReport | Nil
• #phone=(new_value : Stripe::GelatoPhoneReport | Nil)

  Custom attribute writer method checking allowed values (enum).

• #selfie : Stripe::GelatoSelfieReport | Nil
• #selfie=(new_value : Stripe::GelatoSelfieReport | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

• #verification_flow : String | Nil
• #verification_flow=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #verification_session : String | Nil
• #verification_session=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

Constructor Detail

Instance Method Detail