class

Plaid::IdentityVerificationStepSummary

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

Each step will be one of the following values: active - This step is the user's current step. They are either in the process of completing this step, or they recently closed their Identity Verification attempt while in the middle of this step. Only one step will be marked as active at any given point. success - The Identity Verification attempt has completed this step. failed - The user failed this step. This can either call the user to fail the session as a whole, or cause them to fallback to another step depending on how the Identity Verification template is configured. A failed step does not imply a failed session. waiting_for_prerequisite - The user needs to complete another step first, before they progress to this step. This step may never run, depending on if the user fails an earlier step or if the step is only run as a fallback. not_applicable - This step will not be run for this session. skipped - The retry instructions that created this Identity Verification attempt specified that this step should be skipped. expired - This step had not yet been completed when the Identity Verification attempt as a whole expired. canceled - The Identity Verification attempt was canceled before the user completed this step. pending_review - The Identity Verification attempt template was configured to perform a screening that had one or more hits needing review. manually_approved - The step was manually overridden to pass by a team member in the dashboard. manually_rejected - The step was manually overridden to fail by a team member in the dashboard.

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, accept_tos : Plaid::IdentityVerificationStepStatus | Nil = nil, verify_sms : Plaid::IdentityVerificationStepStatus | Nil = nil, kyc_check : Plaid::IdentityVerificationStepStatus | Nil = nil, documentary_verification : Plaid::IdentityVerificationStepStatus | Nil = nil, selfie_check : Plaid::IdentityVerificationStepStatus | Nil = nil, watchlist_screening : Plaid::IdentityVerificationStepStatus | Nil = nil, risk_check : Plaid::IdentityVerificationStepStatus | Nil = nil)

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

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

accept_tos

accept_tos=(new_value : Plaid::IdentityVerificationStepStatus | Nil)

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

documentary_verification

documentary_verification=(new_value : Plaid::IdentityVerificationStepStatus | Nil)

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

hash(hasher)

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

kyc_check

kyc_check=(new_value : Plaid::IdentityVerificationStepStatus | Nil)

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

list_invalid_properties

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

risk_check

risk_check=(new_value : Plaid::IdentityVerificationStepStatus | Nil)

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

selfie_check

selfie_check=(new_value : Plaid::IdentityVerificationStepStatus | Nil)

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

valid?

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

verify_sms

verify_sms=(new_value : Plaid::IdentityVerificationStepStatus | Nil)

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

watchlist_screening

watchlist_screening=(new_value : Plaid::IdentityVerificationStepStatus | Nil)

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