plaid2.model.income_verification_precheck_request module

class plaid2.model.income_verification_precheck_request.IncomeVerificationPrecheckRequest(*, employer: Optional[IncomeVerificationPrecheckEmployer] = None, transactions_access_tokens: Optional[List[str]] = None, us_military_info: Optional[IncomeVerificationPrecheckMilitaryInfo] = None, transactions_access_token: Optional[str] = None, user: Optional[IncomeVerificationPrecheckUser] = None)[source]

Bases: BaseModel

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

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

employer: Optional[IncomeVerificationPrecheckEmployer]

Information about the end user’s employer

json(**kwargs: Any) str[source]

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

classmethod parse_obj(data: Any) IncomeVerificationPrecheckRequest[source]

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

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) IncomeVerificationPrecheckRequest[source]

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

transactions_access_token: Optional[str]
transactions_access_tokens: Optional[List[str]]

An array of access tokens corresponding to Items belonging to the user whose eligibility is being checked. Note that if the Items specified here are not already initialized with transactions, providing them in this field will cause these Items to be initialized with (and billed for) the Transactions product.

us_military_info: Optional[IncomeVerificationPrecheckMilitaryInfo]

Data about military info in the income verification precheck.

user: Optional[IncomeVerificationPrecheckUser]

Information about the user whose eligibility is being evaluated.