class Plaid::IdentityVerification
- Plaid::IdentityVerification
- Reference
- Object
Overview
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.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
plaid/models/identity_verification.crConstant Summary
-
MIN_LENGTH_FOR_CLIENT_USER_ID =
1
Constructors
- .new(pull : JSON::PullParser)
-
.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)
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.
- #client_user_id : String | Nil
-
#client_user_id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #completed_at : Time | Nil
-
#completed_at=(new_value : Time | Nil)
Custom attribute writer method checking allowed values (enum).
- #created_at : Time | Nil
-
#created_at=(new_value : Time | Nil)
Custom attribute writer method checking allowed values (enum).
- #documentary_verification : DocumentaryVerification | Nil
-
#documentary_verification=(new_value : DocumentaryVerification | 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).
- #kyc_check : KYCCheckDetails | Nil
-
#kyc_check=(new_value : KYCCheckDetails | Nil)
Custom attribute writer method checking allowed values (enum).
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
- #previous_attempt_id : String | Nil
-
#previous_attempt_id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #redacted_at : Time | Nil
-
#redacted_at=(new_value : Time | Nil)
Custom attribute writer method checking allowed values (enum).
- #risk_check : RiskCheckDetails | Nil
-
#risk_check=(new_value : RiskCheckDetails | Nil)
Custom attribute writer method checking allowed values (enum).
- #selfie_check : SelfieCheck | Nil
-
#selfie_check=(new_value : SelfieCheck | Nil)
Custom attribute writer method checking allowed values (enum).
- #shareable_url : String | Nil
-
#shareable_url=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #status : Plaid::IdentityVerificationStatus | Nil
-
#status=(new_value : Plaid::IdentityVerificationStatus | Nil)
Custom attribute writer method checking allowed values (enum).
- #steps : IdentityVerificationStepSummary | Nil
-
#steps=(new_value : IdentityVerificationStepSummary | Nil)
Custom attribute writer method checking allowed values (enum).
- #template : IdentityVerificationTemplateReference | Nil
-
#template=(new_value : IdentityVerificationTemplateReference | Nil)
Custom attribute writer method checking allowed values (enum).
- #user : IdentityVerificationUserData | Nil
-
#user=(new_value : IdentityVerificationUserData | 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
- #watchlist_screening_id : String | Nil
-
#watchlist_screening_id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
Instance methods inherited from module OpenApi::Json
after_initialize
after_initialize,
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
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] client_user_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] completed_at Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] created_at Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] documentary_verification Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] kyc_check Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] previous_attempt_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] redacted_at Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] risk_check Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] selfie_check Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] steps Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] template Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] user Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid
Custom attribute writer method checking allowed values (enum). @param [Object] watchlist_screening_id Object to be assigned