Return Value Options

The Return Values category allows you to select the fields you would like returned with your match. The following sections cover the global defaults return values, which are available for all countries, and the country-specific return values, which apply to a subset of countries.

In Management Console, you can set up country-specific overrides for the global defaults. See Setting Country Overrides for details about setting up these overrides.

Global Defaults

Option Name Country Support Description
Return all available information All When enabled, returns all available return fields and all available options, including any country-specific options are enabled. When disabled, allows you to selectively choose the return fields listed below. Default = disabled.
Parsed Address
Returns the separate address fields, such as mainAddressLine, areaName<1-4>, postcodes and country. The meaning of some of these fields may vary by country. For a list of the returned parsed address fields and their definitions, refer to your country's section in Appendix A - Country-Specific Information.

Country-Specific Return Values

Option Name Country Support Description
  AUS Australia has the following additional return field options:
Original Points
Returns the GNAF original latitude/longitude coordinates, and if applicable, the original latitude/longitude coordinates from a User Dictionary.
Level and Lot
Returns the address level type and number and address lot identifier.
GNAF Identifiers
Returns the following GNAF identifier fields - GNAF PID, Principal PID, Meshblock ID, Geocontainment, Geofeature, Address class, SA1, and Parcel ID - from a match to the GNAF National Address File geocoding dataset.
Street Type Abbreviation
Returns the abbreviated street types instead of the default of fully spelled-out type.
Street frontage
Coordinates returned from the GNAF geocoding dataset can be returned as standard points or as street frontage points. The standard points are the most precise (rooftop) points available and are returned by default. This option returns points that have been relocated to the frontage of the candidate location. This is generally preferable for routing applications.

For detailed descriptions of these output fields, see the Custom Output Fields section of Australia (AUS).

  CAN Canada has the following additional return field options:
Formatted range
Returns the formatted range for the address.
Note: This field is only returned for postal centroid candidates.
Census
Returns the following Census fields for the matched address location: Centrus Tract (CT), Census Metropolitan Area (CMA), Census Division (CD), Census Subdivision (CSD), and Census Dissemination Area (DA).

For detailed descriptions of these output fields, see the Custom Output Fields section of Canada (CAN).

  IND India has the following additional return field options:
Rural status
Indicates when the candidate's address is located in a rural region (village).
POI category
Point of interest category. This return field describes the type of POI, such as a bank, ATM, or restaurant.
Block
Returns block information.
Sublocality
Returns the municipal division below locality (areaName4) level.

For detailed descriptions of these output fields, see the Custom Output Fields section of India (IND).

  JPN Japan has the following additional return field options:
Jusho code
Returns a point ID that represents a unique address.
Address Data
Returns the chooaza, chomoku, go, and banchi address fields.

For detailed descriptions of these output fields, see the Custom Output Fields section of Japan (JPN).

  NZL New Zealand has the following additional return field options:
UFI
Returns the New Zealand UFI. The Unique Identifier (UFI) identifies the street segment that the geocoded address belongs to. UFIs are up to 7-digit numbers, assigned by New Zealand Post, that uniquely identify each postal delivery point.
Mesh block
Returns the New Zealand Meshblock identifier. A Meshblock is the smallest geographic unit for which statistical data is collected by Statistics New Zealand. Meshblocks vary in size from part of a city block to large areas of rural land.
Aliased suburb
Returns the New Zealand Aliased suburb. An alternative to the officially-recognized suburb name.
Original Points
Returns the original latitude and longitude coordinates.

For detailed descriptions of these output fields, see the Custom Output Fields section of New Zealand (NZL).

  USA The USA has the following additional return field options:
Quality Descriptors
Returns the result codes. The result codes indicate how well the input address matched to a known address and assigned a location. They also describe the overall status of a match attempt. For all countries, see Global Result Codes. The USA has additional result codes. For details, see Match and Location Codes for USA.
Census
Census output fields contain U.S. Census information about the address.
Intersection
Returns information resulting from a match to an intersection.
Segment
Segment output fields contain information on the street segment identified by the data provider.
Other
Returns additional information about the match.

For detailed descriptions of these output fields, see the Custom Output Fields section of United States (USA).