International Address

Shaype has released an enhanced address validation system that enables clients to create customer records for customers located anywhere in the world.

Dynamic Validation

We have updated our validation approach to use the countryIsoCode provided to determine what data is mandatory for that country.

Our swagger contract will be updated to reflect the global mandatory values.

Australian Address Validation

When countryIsoCode is AUS we will apply the same validation and mandatory data rules currently required.

International Address Validation

For all non Australian countries the default valuation rules will apply. A valid address will require line1 and a valid 3 letter countryIsoCode but all other values are optional.

Valid International Address Examples

  "address": {
    "countryCodeIso": "GBR",
    "line1": "His Majesty The King Buckingham Palace",
    "postcode": "SW1A 1AA"
  }

 "address": {
    "countryCodeIso": "CAN",
    "line1": "480 SW Marine Dr",
    "administrativeRegion": "BC"
  }

❗️

Administrative Region

We will be enforcing validation rules for administrativeRegion for non Australian countries if that value is provided in the address.

Please refer to ISO 3166-2 for appropriate values if you wish to include this data in your customers address.