Skip to main content

Addresses

Addresses are not the same for all countries around the world. Because of this, we have some settings to allow for address formatting to be different between countries.

Address settings

danger

The Street field is being deprecated (in 2.0.658) in favor of Address1 and Address2. This deprecation includes Addresses:SecondaryAddressLineCountries and Addresses:StreetOptionalCountries

SettingDescriptionValue
Addresses:AutoGeocodeWhether or not to automatically update geocoding on address changes.Boolean, defaults to true.
Addresses:Address1OptionalCountriesCountries where Address 1 is optional.Two-letter ISO 3166-1 Alpha-2 codes.
Addresses:CityOptionalCountriesCountries where city is optional. By default, city is required.Two-letter ISO 3166-1 Alpha-2 codes.
Addresses:HouseNumberRequiredCountriesCountries where house number is required. By default, it is only required in NL and DE.Two-letter ISO 3166-1 Alpha-2 codes.
Addresses:HouseNumberVisibleCountriesCountries where HouseNumber will be displayed. Note: if HouseNumber is shown, the Address1 field will be labeled as ''Street''.Two-letter ISO 3166-1 Alpha-2 codes.
Addresses:Address2VisibleCountriesCountries where Address2 will be displayed.Two-letter ISO 3166-1 Alpha-2 codes.
Addresses:StateLength2CountriesCountries where states should be supplied in a two-letter format.Two-letter ISO 3166-1 Alpha-2 codes.
Addresses:StateVisibleCountriesCountries where the state field should be visible.Two-letter ISO 3166-1 Alpha-2 codes.
Addresses:StateLength3CountriesCountries where states should be supplied in a three-letter format.Three-letter ISO 3166-1 Alpha-3 codes.
Addresses:ZipCodeOptionalCountriesCountries where zip code is optional. By default, zip code is required.Two-letter ISO 3166-1 Alpha-2 codes.
AddressSuggester:FilterOnCountryCountries where the address is to be suggested.Two-letter ISO 3166-1 Alpha-2 codes.

Both ISO-3166-1 Alpha-2 and Alpha-3 codes are available on ISO.org by searching on Country codes.

Address requirements

To be able to fine-tune the conditions of all your address fields, instead of just the ones in the settings here above, we've got the following two services for you:

  • GetAddressRequirements
  • UpdateAddressRequirement

The first field accepts a CountryID and will consequently display all its configured address requirements. By using UpdateAddressRequirement, you can actually set and update new ones. It allows you to pick a PropertyType, such as EmailAddress, to set conditions for. These include for example setting its visiblity and length. For now, it's accessible via API only.

AddressRequirements replacing settings

In some time, front-end functionality will be introduced for creating/updates these requirements and the settings on this page will be deprecated. For now however, the new AddressRequirements functionality is available only via these services. You'll have to explicitly enable the setting UseAddressRequirements for EVA to use the services instead of the settings.