Geocode Preferences

Preferences supported by the Geocode Service include a variety of settings for match mode, geocoding to a street or administrative area, fallback to a less specific location if an exact match cannot be found, and more. The following table describes the preferences available to all countries.

Parameter Type Description
maxResults integer The maximum number of candidates to return. Default = 1
returnAllInfo boolean Specifies whether to return all available information for each candidate
factoryDescription String Controls which address processor will process the request.
clientLocale String Specifies the locale value. For example, specify "th" for the Thai language.
clientCoordSysName String Specifies the coordinate system that you want to convert the geometry to. The format must be the European Petroleum Survey Group (EPSG) code or the SRID code. Default = EPSG:4326.
distance number Displays the defined search radius.

streetOffset specifies the offset distance from the street segments to use in street-level geocoding. Default 5 meters

cornerOffset specifies the distance to offset the street end points in street-level matching Default 7 meters.
originXY number XY coordinates of the origin address.
matchMode String Match modes determine the leniency used to make a match between the input address and the reference data.
returnOfAdditionalFields String Allows user to control which additional fields to return, if they choose not to return all the data.

type

 String

Indicates the geocode type to be performed. Optional.

ADDRESS
Geocode to a street address. Default.
GEOGRAPHIC
Geocode to the geographic centroid of a city or state.
POSTAL
Geocode to a postal code.

returnAllCandidateInfo

 Boolean Specifies whether to return all available information for each candidate.
true
Return all available information for each candidate.
false
Do not return all available information for each candidate. Default.

fallbackToGeographic

 Boolean Specifies whether to attempt to determine a geographic region centroid when an address-level geocode cannot be determined. Optional.
true
Return a geographic centroid when an address-level centroid cannot be determined. Default.
false
Do not return a geographic centroid when an address-level centroid cannot be determined.

fallbackToPostal

 Boolean Specifies whether to attempt to determine a post code centroid when an address-level geocode cannot be determined. Optional.
true
Return a post code centroid when an address-level centroid cannot be determined. Default.
false
Do not return a post code centroid when an address-level centroid cannot be determined.

maxReturnedCandidates

 Integer
matchOnAddressNumber Boolean
true
A match must be made to the input address number.
false
A match does not need to be made to the input address number. Default.

matchOnPostCode1

 Boolean
true
A match must be made to the input PostCode1 field.
false
A match does not need to be made to the input PostCode1 field. Default.

matchOnPostCode2

 Boolean
true
A match must be made to the input PostCode2 field.
false
A match does not need to be made to the input PostCode2 field. Default.

matchOnAreaName1

 Boolean
true
A match must be made to the input AreaName1 field.
false
A match does not need to be made to the input AreaName1 field. Default.

matchOnAreaName2

 Boolean
true
A match must be made to the input AreaName2 field.
false
A match does not need to be made to the input AreaName2 field. Default.
Note: This option is not supported by USA.

matchOnAreaName3

 Boolean
true
A match must be made to the input AreaName3 field.
false
A match does not need to be made to the input AreaName3 field. Default.

matchOnAreaName4

 Boolean
true
A match must be made to the input AreaName4 field.
false
A match does not need to be made to the input AreaName4 field. Default.

matchOnAllStreetFields

 Boolean
true
A match must be made to the input street name, type and directional fields.
false
A match does not need to be made to the input street name, type and directional fields. Default.

returnAllCustomFields

 Boolean
true
Return all of the custom fields for the candidate.
false
Return only the standard set of fields for the candidate. Default.

returnedCustomFieldKeys

 List<String> Specifies a list of keys that represent the custom fields to be returned in the candidate's customFields output. To specify multiple key/value pairs for a country, use spaces to separate the names of the custom fields to be returned. Custom fields vary by country. For example: “CTYST_KEY” or “DATATYPE”. Default: empty.

returnMatchDescriptor

 Boolean
true
Return the match descriptor object, which indicates the parts of the candidate that matched the input address.
false
Do not return the match descriptor object. Default.

returnStreetAddressFields

 Boolean
true
Return all of the individual street fields that make up the formattedStreetAddress field separately, as follows:
  • MAIN_ADDRESS
  • THOROUGHFARE_TYPE
  • ADDRESS_ID
  • PRE_ADDRESS
  • POST_ADDRESS
  • PRE_DIRECTIONAL
  • POST_DIRECTIONAL
false
Do not return the individual street fields separately; return these values in the formattedStreetAddress field. Default.
returnUnitInformation Boolean
true
Where available, return unit type and unit value information separately in the unitType and unitValue fields, as well as in the formattedStreetAddress field.
false
Where available, return unit type and unit value information only in the formattedStreetAddress field. Default.