plaid2.model.link_token_create_request_income_verification module

class plaid2.model.link_token_create_request_income_verification.LinkTokenCreateRequestIncomeVerification(*, stated_income_sources: Optional[List[LinkTokenCreateRequestUserStatedIncomeSource]] = None, precheck_id: Optional[str] = None, income_source_types: Optional[List[str]] = None, access_tokens: Optional[List[str]] = None, asset_report_id: Optional[str] = None, income_verification_id: Optional[str] = None, payroll_income: Optional[LinkTokenCreateRequestIncomeVerificationPayrollIncome] = None, bank_income: Optional[LinkTokenCreateRequestIncomeVerificationBankIncome] = None)

Bases: BaseModel

access_tokens: Optional[List[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.

asset_report_id: Optional[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.

bank_income: Optional[LinkTokenCreateRequestIncomeVerificationBankIncome]

Specifies options for initializing Link for use with Bank Income. This field is required if income_verification is included in the products array and bank is specified in income_source_types.

dict(**kwargs: Any) → Dict[str, Any]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

income_source_types: Optional[List[str]]

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.

income_verification_id: Optional[str]

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

json(**kwargs: Any) → str

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestIncomeVerification

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestIncomeVerification

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payroll_income: Optional[LinkTokenCreateRequestIncomeVerificationPayrollIncome]

Specifies options for initializing Link for use with Payroll Income. This field is required if income_verification is included in the products array and payroll is specified in income_source_types.

precheck_id: Optional[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.

stated_income_sources: Optional[List[LinkTokenCreateRequestUserStatedIncomeSource]]

A list of user stated income sources