plaid2.model.user_address module

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

Bases: BaseModel

city: str

City from the end user’s address

country: str

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

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

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

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

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

postal_code: str

The postal code for the associated address. Between 2 and 10 alphanumeric characters.

region: str

An ISO 3166-2 subdivision code. Related terms would be “state”, “province”, “prefecture”, “zone”, “subdivision”, etc.

street: str

The primary street portion of an address. If the user has submitted their address, this field will always be filled.

street_2: Optional[str]

Extra street information, like an apartment or suite number.