class

Plaid::LinkTokenCreateRequestUser

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

An object specifying information about the end user who will be linking their account.

Constants

MIN_LENGTH_FOR_CLIENT_USER_ID = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, client_user_id : String | Nil = nil, legal_name : String | Nil = nil, name : Plaid::LinkTokenCreateRequestUserName | Nil = nil, phone_number : String | Nil = nil, phone_number_verified_time : Time | Nil = nil, email_address : String | Nil = nil, email_address_verified_time : Time | Nil = nil, ssn : String | Nil = nil, date_of_birth : Time | Nil = nil, address : Plaid::LinkTokenCreateRequestUserAddress | Nil = nil, id_number : Plaid::LinkTokenCreateRequestUserIdNumber | 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 : Plaid::LinkTokenCreateRequestUserAddress | Nil)

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

Source
client_user_id

A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. It is currently used as a means of searching logs for the given user in the Plaid Dashboard.

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
date_of_birth

To be provided in the format "yyyy-mm-dd". Can be used to prefill Link fields when used with Identity Verification.

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
date_of_birth_present=(date_of_birth_present : Bool)
Source
date_of_birth_present?
Source
email_address

The user's email address. This field is optional, but required to enable the pre-authenticated returning user flow. Can also be used to prefill Link fields when used with Identity Verification.

Source
email_address=(new_value : String | Nil)

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

Source
email_address_verified_time

The date and time the email address was verified in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). This was previously an optional field used in the returning user experience. This field is no longer required to enable the returning user experience. Only pass a verification time for an email address that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch. Example: 2020-01-01T00:00:00Z

Source
email_address_verified_time=(new_value : Time | Nil)

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

Source
email_address_verified_time_present=(email_address_verified_time_present : Bool)
Source
email_address_verified_time_present?
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 : Plaid::LinkTokenCreateRequestUserIdNumber | Nil)

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

Source
legal_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] legal_name 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
name
Source
name=(new_value : Plaid::LinkTokenCreateRequestUserName | Nil)

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

Source
phone_number

The user's phone number in E.164 format. This field is optional, but required to enable the returning user experience. Can also be used to prefill Link fields when used with Identity Verification.

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_verified_time

The date and time the phone number was verified in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). This was previously an optional field used in the returning user experience. This field is no longer required to enable the returning user experience. Only pass a verification time for a phone number that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch. Example: 2020-01-01T00:00:00Z

Source
phone_number_verified_time=(new_value : Time | Nil)

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

Source
phone_number_verified_time_present=(phone_number_verified_time_present : Bool)
Source
phone_number_verified_time_present?
Source
ssn

Deprecated and not currently used, use the id_number field instead.

Source
ssn=(new_value : String | Nil)

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