Setting Country-Level Preference Overrides

The options for matching, geocoding and reverse geocoding have default values/settings that can be overriden on a per country basis. The following list provides some of the overridable options:
  • Matching options - match nodes and must match field settings
  • Geocoding options - geocode placement (street and corner offsets), geocoding fallback and coordinate reference system
  • Reverse Geocoding options - search distance, geocode placement (street and corner offfsets), client locale and coordinate reference system
  • Candidate Return Information - maximum candidate return information, return all candidate information, return all custom fields, return custom field keys, return match descriptor, return street address fields and return unit information

    The following table provides information on how to set a country preference.

Note: Overriding the preferences on a country by country level may lead to unexpected results – overrides should only be used where there is a need for it.
REST API Feature Implementation
Services: Geocode, reverseGeocode
Request Type: POST
Object : Element preferences : customPreferences, where the option is specified using a key/value pair. The ISO-3166 3-character country code and a period (.) precedes the key constant. The options that can be set on a per country basis are located in the following objects:
  • preferences
  • mustMatchFields
  • returnFieldsDescriptor

For more information, see Geocode POST Request and Reverse Geocode POST Request.