plaid2.model.mortgage_property_address module

class plaid2.model.mortgage_property_address.MortgagePropertyAddress(*, country: Optional[str] = None, street: Optional[str] = None, postal_code: Optional[str] = None, region: Optional[str] = None, city: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]: The city name.

country: Optional[str]: The ISO 3166-1 alpha-2 country code.

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → MortgagePropertyAddress[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) → MortgagePropertyAddress[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]: The five or nine digit postal code.

region: Optional[str]: The region or state (example “NC”).

street: Optional[str]: The full street address (example “564 Main Street, Apt 15”).