class

Plaid::IdentityVerificationGetResponse

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

A identity verification attempt represents a customer's attempt to verify their identity, reflecting the required steps for completing the session, the results for each step, and information collected in the process.

Constants

MIN_LENGTH_FOR_CLIENT_USER_ID = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, client_user_id : String | Nil = nil, created_at : Time | Nil = nil, completed_at : Time | Nil = nil, previous_attempt_id : String | Nil = nil, shareable_url : String | Nil = nil, template : IdentityVerificationTemplateReference | Nil = nil, user : IdentityVerificationUserData | Nil = nil, status : Plaid::IdentityVerificationStatus | Nil = nil, steps : IdentityVerificationStepSummary | Nil = nil, documentary_verification : DocumentaryVerification | Nil = nil, selfie_check : SelfieCheck | Nil = nil, kyc_check : KYCCheckDetails | Nil = nil, risk_check : RiskCheckDetails | Nil = nil, watchlist_screening_id : String | Nil = nil, redacted_at : Time | Nil = nil, request_id : 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

client_user_id

A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the /link/token/create client_user_id to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

Source
client_user_id=(new_value : String | Nil)

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

Source
completed_at

An ISO8601 formatted timestamp.

Source
completed_at=(new_value : Time | Nil)

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

Source
created_at

An ISO8601 formatted timestamp.

Source
created_at=(new_value : Time | Nil)

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

Source
documentary_verification
Source
documentary_verification=(new_value : DocumentaryVerification | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] documentary_verification 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

ID of the associated Identity Verification attempt.

Source
id=(new_value : String | Nil)

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

Source
kyc_check
Source
kyc_check=(new_value : KYCCheckDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] kyc_check 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
previous_attempt_id

The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.

Source
previous_attempt_id=(new_value : String | Nil)

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

Source
redacted_at

An ISO8601 formatted timestamp.

Source
redacted_at=(new_value : Time | Nil)

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

Source
request_id

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Source
request_id=(new_value : String | Nil)

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

Source
risk_check
Source
risk_check=(new_value : RiskCheckDetails | Nil)

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

Source
selfie_check
Source
selfie_check=(new_value : SelfieCheck | Nil)

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

Source
shareable_url

A shareable URL that can be sent directly to the user to complete verification

Source
shareable_url=(new_value : String | Nil)

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

Source
status
Source
status=(new_value : Plaid::IdentityVerificationStatus | Nil)

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

Source
steps
Source
steps=(new_value : IdentityVerificationStepSummary | Nil)

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

Source
template
Source
template=(new_value : IdentityVerificationTemplateReference | Nil)

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

Source
user
Source
user=(new_value : IdentityVerificationUserData | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] user 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
watchlist_screening_id

ID of the associated screening.

Source
watchlist_screening_id=(new_value : String | Nil)

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

Source