plaid2.model.asset_report_user module

class plaid2.model.asset_report_user.AssetReportUser(*, last_name: Optional[str] = None, first_name: Optional[str] = None, phone_number: Optional[str] = None, email: Optional[str] = None, middle_name: Optional[str] = None, ssn: Optional[str] = None, client_user_id: Optional[str] = None)[source]

Bases: BaseModel

client_user_id: Optional[str]

An identifier you determine and submit for the user.

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

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

email: Optional[str]

The user’s email address.

first_name: Optional[str]

The user’s first name. Required for the Fannie Mae Day 1 Certainty™ program.

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

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

last_name: Optional[str]

The user’s last name. Required for the Fannie Mae Day 1 Certainty™ program.

middle_name: Optional[str]

The user’s middle name

classmethod parse_obj(data: Any) AssetReportUser[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) AssetReportUser[source]

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

phone_number: Optional[str]

“+14151234567”. Phone numbers provided in other formats will be parsed on a best-effort basis.

Type

The user’s phone number, in E.164 format

Type

+{countrycode}{number}. For example

ssn: Optional[str]

The user’s Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program.

Format: “ddd-dd-dddd”