Return Values

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.

Global Defaults


Option Name	Country Support	Description
Return all available information	All	When enabled, returns all available return fields. 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 Country-Specific Information.

Country-Specific Return Values


Option Name	Country Support	Description
	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).
	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).