plaid2.model.deposit_switch_target_user module

class plaid2.model.deposit_switch_target_user.DepositSwitchTargetUser(*, phone: str, family_name: str, email: str, tax_payer_id: Optional[str] = None, given_name: str, address: Optional[DepositSwitchAddressData] = None)

Bases: BaseModel

address: Optional[DepositSwitchAddressData]

The user’s address.

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

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

email: str

The email address of the user.

family_name: str

The family name (last name) of the user.

given_name: str

The given name (first name) of the user.

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) → DepositSwitchTargetUser

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

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

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

phone: str

The phone number of the user. The endpoint can accept a variety of phone number formats, including E.164.

tax_payer_id: Optional[str]

The taxpayer ID of the user, generally their SSN, EIN, or TIN.