Addresses
Addresses
Formatting addresses across bordersAddresses 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
| Setting | Description | Value |
|---|---|---|
| Addresses:AutoGeocode | Whether or not to automatically update geocoding on address changes. | Boolean, defaults to true. |
| Addresses:Address1OptionalCountries | Countries where Address 1 is optional. | Two-letter ISO 3166-1 Alpha-2 codes. |
| Addresses:CityOptionalCountries | Countries where city is optional. By default, city is required. | Two-letter ISO 3166-1 Alpha-2 codes. |
| Addresses:HouseNumberRequiredCountries | Countries where house number is required. By default, it is only required in NL and DE. | Two-letter ISO 3166-1 Alpha-2 codes. |
| Addresses:HouseNumberVisibleCountries | Countries 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:Address2VisibleCountries | Countries where Address2 will be displayed. | Two-letter ISO 3166-1 Alpha-2 codes. |
| Addresses:StateLength2Countries | Countries where states should be supplied in a two-letter format. | Two-letter ISO 3166-1 Alpha-2 codes. |
| Addresses:StateVisibleCountries | Countries where the state field should be visible. | Two-letter ISO 3166-1 Alpha-2 codes. |
| Addresses:StateLength3Countries | Countries where states should be supplied in a three-letter format. | Three-letter ISO 3166-1 Alpha-3 codes. |
| Addresses:ZipCodeOptionalCountries | Countries where zip code is optional. By default, zip code is required. | Two-letter ISO 3166-1 Alpha-2 codes. |
| AddressSuggester:FilterOnCountry | Impacts whether the search address would include matches from multiple countries or not. Example: if you are searching for a street called Main street, your result would include all streets that have that name regardless the country of the organization unit your session is currently active from. | true: will only search the address within the confinements of the users current organization unit country. false: address search will include matches from all over the world. The setting default value is true. |
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:
GetAddressRequirementsUpdateAddressRequirement
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. These include for example setting its visibility and length. For now, it's accessible via API only.
For visibility, when set 1, it displays it; when set to 2, it hides the field; and when set to 3, it displays and enforces the field as required.
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.