plaid2.model.income_verification_create_request module

class plaid2.model.income_verification_create_request.IncomeVerificationCreateRequest(*, webhook: str, options: Optional[List[str]] = None, precheck_id: Optional[str] = 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

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[List[str]]: Optional arguments for /income/verification/create

classmethod parse_obj(data: Any) → IncomeVerificationCreateRequest[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) → IncomeVerificationCreateRequest[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

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.

webhook: str: The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process.