31 lines (19 loc) · 2.31 KB

AddressValidateResponse

Properties

Name	Type	Description	Notes
addressLine1	String	The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).	[optional]
addressLine2	String	The addressLine2 contains Street address or Landmark (if any).	[optional]
addressLine3	String	The addressLine3 contains P.O.Box (if any) near the address.	[optional]
cityTown	String	The name of the city or town to where the address belongs.	[optional]
countryCode	String	This indicates the two-character ISO code of the country from the ISO country list.	[optional]
name	String	Name of the person to which this address points.	[optional]
postalCode	String	The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.	[optional]
residential	Boolean	The specified adress can be Residential or Official. In case if the adress is Residential, the boolean value will be 'true', else it will take 'false'.	[optional]
stateProvince	String	The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.	[optional]
status	StatusEnum	>- This field applies to the Validate Address and Suggest Addresses APIs. The field indicates whether the submitted address is valid and whether the API made changes to the address. Possible values are: <br>-`VALIDATED_CHANGED`: The address is valid, but the API made changes to improve the address. For example, if an address has a valid street number and street name (e.g. “100 Elm”) but is missing the street suffix (e.g. “St”), the API would add the suffix. <br>-`VALIDATED_AND_NOT_CHANGED`: The address is valid. The API made no changes.	[optional]

Enum: StatusEnum

Name	Value
CHANGED	"VALIDATED_CHANGED"
AND_NOT_CHANGED	"VALIDATED_AND_NOT_CHANGED"