plaid2.model.owner module

class plaid2.model.owner.Owner(*, addresses: List[Address], phone_numbers: List[PhoneNumber], names: List[str], emails: List[Email])

Bases: BaseModel

addresses: List[Address]

Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.

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

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

emails: List[Email]

A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.

json(**kwargs: Any) → str

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

names: List[str]

A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. If the name of a business is reported, please contact Plaid Support. In the case of a joint account, Plaid will make a best effort to report the names of all account holders.

If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account’s names array.

classmethod parse_obj(data: Any) → Owner

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

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

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

phone_numbers: List[PhoneNumber]

A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.