class Plaid::IdentityVerificationCreateRequestUser

• Plaid::IdentityVerificationCreateRequestUser
• Reference
• Object

Overview

User information collected outside of Link, most likely via your own onboarding process. Each of the following identity fields are optional: #email_address #phone_number #date_of_birth #name #address #id_number Specifically, these fields are optional in that they can either be fully provided (satisfying every required field in their subschema) or omitted from the request entirely by not providing the key or value. Providing these fields via the API will result in Link skipping the data collection process for the associated user. All verification steps enabled in the associated Identity Verification Template will still be run. Verification steps will either be run immediately, or once the user completes the accept_tos step, depending on the value provided to the gave_consent field. If you are not using the shareable URL feature, you can optionally provide these fields via /link/token/create instead; both /identity_verification/create and /link/token/create are valid ways to provide this information. Note that if you provide a non-null user data object via /identity_verification/create, any user data fields entered via /link/token/create for the same #client_user_id will be ignored when prefilling Link.

Included Modules

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

Defined in:

plaid/models/identity_verification_create_request_user.cr

Constant Summary

MIN_LENGTH_FOR_CLIENT_USER_ID = 1

Constructors

• .new(pull : JSON::PullParser)
• .new(*, email_address : String | Nil = nil, phone_number : String | Nil = nil, date_of_birth : Time | Nil = nil, name : Plaid::IdentityVerificationRequestUserName | Nil = nil, address : UserAddress | Nil = nil, id_number : UserIDNumber | Nil = nil, client_user_id : 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.

• #address : UserAddress | Nil
• #address=(new_value : UserAddress | Nil)

  Custom attribute writer method checking allowed values (enum).

• #address_present=(address_present : Bool)
• #address_present? : Bool
• #client_user_id : String | Nil
• #client_user_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #client_user_id_present=(client_user_id_present : Bool)
• #client_user_id_present? : Bool
• #date_of_birth : Time | Nil
• #date_of_birth=(new_value : Time | Nil)

  Custom attribute writer method checking allowed values (enum).

• #email_address : String | Nil
• #email_address=(new_value : String | 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_number : UserIDNumber | Nil
• #id_number=(new_value : UserIDNumber | Nil)

  Custom attribute writer method checking allowed values (enum).

• #id_number_present=(id_number_present : Bool)
• #id_number_present? : Bool
• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #name : Plaid::IdentityVerificationRequestUserName | Nil
• #name=(new_value : Plaid::IdentityVerificationRequestUserName | Nil)

  Custom attribute writer method checking allowed values (enum).

• #name_present=(name_present : Bool)
• #name_present? : Bool
• #phone_number : String | Nil
• #phone_number=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #phone_number_present=(phone_number_present : Bool)
• #phone_number_present? : Bool
• #valid? : Bool

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

Constructor Detail

Instance Method Detail