plaid2.model.address module

class plaid2.model.address.Address(*, data: AddressData, primary: Optional[bool] = None)

Bases: BaseModel

data: AddressData

Data about the components comprising an address.

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

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

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

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

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

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

primary: Optional[bool]

When true, identifies the address as the primary address on an account.