class

Plaid::IdentityVerificationCreateRequestUser

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

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.

Constants

MIN_LENGTH_FOR_CLIENT_USER_ID = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

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

address
Source
address=(new_value : UserAddress | Nil)

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

Source
address_present=(address_present : Bool)
Source
address_present?
Source
client_user_id

Specifying user.client_user_id is deprecated. Please provide client_user_id at the root level instead.

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
client_user_id_present=(client_user_id_present : Bool)
Source
client_user_id_present?
Source
date_of_birth

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Source
date_of_birth=(new_value : Time | Nil)

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

Source
email_address

A valid email address.

Source
email_address=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] email_address 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_number
Source
id_number=(new_value : UserIDNumber | Nil)

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

Source
id_number_present=(id_number_present : Bool)
Source
id_number_present?
Source
list_invalid_properties

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

Source
name
Source
name=(new_value : Plaid::IdentityVerificationRequestUserName | Nil)

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

Source
name_present=(name_present : Bool)
Source
name_present?
Source
phone_number

A phone number in E.164 format.

Source
phone_number=(new_value : String | Nil)

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

Source
phone_number_present=(phone_number_present : Bool)
Source
phone_number_present?
Source
valid?

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

Source