API documentation Address Validation

Contents

• Validate address
  • Example

Validate address

Validates address and displays errors if any.

Endpoint

[POST] /v4/address_validation

Attributes

Key	Description	Datatype	Constraints	Errors
service	Name	String	Optional. The name of the delivery service that is planned to be used with the submitted address. It will be used to check if that courier charges extra for delivering to the given address. 200 OK with an additional JSON payload of warnings (See example). The address is still considered valid and can be used in subsequent requests despite the warning.	Service not recognized
name1	Name	String	Maximum 35 characters. Must only contain latin or printable ASCII characters. Must not contain line breaks.	Name1 can't be blank Name1 is too long (maximum is 35 characters) Name1 must only contain latin or printable ASCII characters Name1 must not contain multiple lines
name2	Name (continued)	String	Optional. Maximum 35 characters. Must only contain latin or printable ASCII characters. Must not contain line breaks.	Name2 must only contain latin or printable ASCII characters Name2 is too long (maximum is 35 characters) Name2 must not contain multiple lines
street	Street	String	Maximum 70 characters. Must only contain latin or printable ASCII characters. Must not contain line breaks. Must not contain zip code. Must not contain city.	Street can't be blank Street is too long (maximum is 70 characters) Street must not contain city, building, or company name Street must only contain latin or printable ASCII characters Street must not contain multiple lines
city	City	String	2-35 characters. Must only contain latin or printable ASCII characters. Must not contain line breaks.	City can't be blank City is too short (minimum is 2 characters) City is too long (maximum is 35 characters) City must only contain latin or printable ASCII characters City must not contain multiple lines
country	Country	String	2 character ISO 3166-Alpha 2 country code.	Country can't be blank Country is unknown or not supported Country is invalid
zip	Zip	String	Zipcode associated with the address	ZIP can't be blank ZIP has invalid format (country-specific)
email	Email of recipient	String	Optional. Maximum 50 characters	Email can't be blank Email is not a valid email address Email is too long (maximum is 50 characters)
phone	Phone number	String	Optional. Maximum 15 characters. Must only contain characters 0-9, plus and minus.	Phone can't be blank Phone must only contain characters 0-9, plus and minus Phone is too long (maximum is 25 characters)

Examples

Request

• Without the service parameter

  {
    "name1": "Mr Appleseed",
    "name2": "The Fruit Company, Building A",
    "street": "Example Street 1",
    "city": "Example City",
    "zip": "12345",
    "country": "FR",
    "phone": "0044123456"
  }

• With the service parameter

  {
    "name1": "Mr Appleseed",
    "street": "Example Street 1",
    "city": "Example City",
    "zip": "12345",
    "country": "FR",
    "phone": "0044123456",
    "service": "UPS_NL_MULTI"
  }

Responses

• If a service is not supported

  STATUS 422 UNPROCESSABLE ENTITY
  {"errors" => ["Service not recognized"]}