Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 2.66 KB

LinkTokenCreateRequestIncomeVerification.md

File metadata and controls

20 lines (15 loc) · 2.66 KB

LinkTokenCreateRequestIncomeVerification

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

Properties

Name Type Description Notes
income_verification_id str The `income_verification_id` of the verification instance, as provided by `/income/verification/create`. [optional]
asset_report_id str 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. [optional]
precheck_id str The ID of a precheck created with `/income/verification/precheck`. Will be used to improve conversion of the income verification flow by streamlining the Link interface presented to the end user. [optional]
access_tokens [str] 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. [optional]
income_source_types [IncomeVerificationSourceType] 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. [optional]
bank_income LinkTokenCreateRequestIncomeVerificationBankIncome [optional]
payroll_income LinkTokenCreateRequestIncomeVerificationPayrollIncome [optional]
stated_income_sources [LinkTokenCreateRequestUserStatedIncomeSource] A list of user stated income sources [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]