class

Plaid::LinkTokenCreateRequestIncomeVerification

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

Specifies options for initializing Link for use with the Income product. This field is required if income_verification is included in the products array.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, income_verification_id : String | Nil = nil, asset_report_id : String | Nil = nil, access_tokens : Array(String) | Nil = nil, income_source_types : Array(IncomeVerificationSourceType) | Nil = nil, bank_income : Plaid::LinkTokenCreateRequestIncomeVerificationBankIncome | Nil = nil, payroll_income : Plaid::LinkTokenCreateRequestIncomeVerificationPayrollIncome | Nil = nil, stated_income_sources : Array(Plaid::LinkTokenCreateRequestUserStatedIncomeSource) | 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

access_tokens

An array of access tokens corresponding to Items that a user has previously connected with. Data from these institutions will be cross-referenced with document data received during the Document Income flow to help verify that the uploaded documents are accurate. If the transactions product was not initialized for these Items during link, it will be initialized after this Link session. This field should only be used with the payroll income source type.

Source
access_tokens=(new_value : Array(String) | Nil)

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

Source
access_tokens_present=(access_tokens_present : Bool)
Source
access_tokens_present?
Source
asset_report_id

The asset_report_id of an asset report associated with the user, as provided by /asset_report/create. Providing an asset_report_id is optional and can be used to verify the user through a streamlined flow. If provided, the bank linking flow will be skipped.

Source
asset_report_id=(new_value : String | Nil)

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

Source
bank_income
Source
bank_income=(new_value : Plaid::LinkTokenCreateRequestIncomeVerificationBankIncome | Nil)

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

income_source_types

The types of source income data that users will be permitted to share. Options include bank and payroll. Currently you can only specify one of these options.

Source
income_source_types=(new_value : Array(IncomeVerificationSourceType) | Nil)

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

Source
income_verification_id

The income_verification_id of the verification instance, as provided by /income/verification/create.

Source
income_verification_id=(new_value : String | Nil)

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

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

Source
stated_income_sources

A list of user stated income sources

Source
stated_income_sources=(new_value : Array(Plaid::LinkTokenCreateRequestUserStatedIncomeSource) | Nil)

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