International Address Validate

This operation validates international addresses to improve postal accuracy within that country. This ensure that parcels are rated correctly and shipments reach their final destination on time. The International Address Validate operation sends an address for verification, and the response indicates whether the address is valid.
Key Considerations:

  • Validation results include VALIDATED_AND_NOT_CHANGED or VALIDATED_CHANGED for valid addresses. Invalid addresses result in HTTP status 400 with an Error Code of Invalid Address.
SecuritybearerAuth
Request
Request Body schema: application/json
addressLine1
required
string

The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).

addressLine2
string

The addressLine2 contains Street address or Landmark (if any).

addressLine3
string

The addressLine3 contains P.O.Box (if any) near the address.

cityTown
string

The name of the city or town to where the address belongs.

countryCode
required
string

This indicates the two-character ISO code of the country from the ISO country list.

name
string

Name of the person to which this address points.

postalCode
required
string

The postal code or ZIP code of the address.

stateProvince
string

The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.

Responses
200

The address has been verified.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/address/verify/intl
Request samples
application/json
{
  • "addressLine1": "638 Manitobazz",
  • "cityTown": "Winnipeg",
  • "countryCode": "CA",
  • "name": "Paul Wright",
  • "phone": "203-555-1213",
  • "postalCode": "R2W 2H1",
  • "residential": false,
  • "stateProvince": "AB"
}
Response samples
application/json
{
  • "addressLine1": "638 Manitoba Ave",
  • "addressLine2": "",
  • "addressLine3": "",
  • "cityTown": "Winnipeg",
  • "countryCode": "CA",
  • "name": "",
  • "postalCode": "R2W 2H1",
  • "residential": false,
  • "stateProvince": "MB",
  • "status": "VALIDATED_CHANGED"
}