class Plaid::IdentityVerificationRequestUser

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.

Included Modules

Defined in:

plaid/models/identity_verification_request_user.cr

Constructors

Instance Method Summary

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

def self.new(pull : JSON::PullParser) #

[View source]
def self.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) #

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


[View source]

Instance Method Detail

def ==(other : self) #

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


def address : UserAddress | Nil #

[View source]
def address=(new_value : UserAddress | Nil) #

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


[View source]
def address_present=(address_present : Bool) #

[View source]
def address_present? : Bool #

[View source]
def date_of_birth : Time | Nil #

[View source]
def date_of_birth=(new_value : Time | Nil) #

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


[View source]
def email_address : String | Nil #

[View source]
def email_address=(new_value : String | Nil) #

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


[View source]
def hash(hasher) #

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


def id_number : UserIDNumber | Nil #

[View source]
def id_number=(new_value : UserIDNumber | Nil) #

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


[View source]
def id_number_present=(id_number_present : Bool) #

[View source]
def id_number_present? : Bool #

[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def name : Plaid::IdentityVerificationRequestUserName | Nil #

[View source]
def name=(new_value : Plaid::IdentityVerificationRequestUserName | Nil) #

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


[View source]
def name_present=(name_present : Bool) #

[View source]
def name_present? : Bool #

[View source]
def phone_number : String | Nil #

[View source]
def phone_number=(new_value : String | Nil) #

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


[View source]
def phone_number_present=(phone_number_present : Bool) #

[View source]
def phone_number_present? : Bool #

[View source]
def valid? : Bool #

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


[View source]