plaid2.model.address_data module

class plaid2.model.address_data.AddressData(*, city: str, region: Optional[str] = None, street: str, postal_code: Optional[str] = None, country: Optional[str] = None)

Bases: BaseModel

city: str

The full city name

country: Optional[str]

The ISO 3166-1 alpha-2 country code

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

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

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

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

postal_code: Optional[str]

The postal code. In API versions 2018-05-22 and earlier, this field is called zip.

region: Optional[str]

The region or state. In API versions 2018-05-22 and earlier, this field is called state. Example: “NC”

street: str

The full street address Example: “564 Main Street, APT 15”