Default
The following table lists the output fields that are globally available:
| Fields | Description |
|---|---|
| CITYRANK | City ranking integer value is returned when candidate is found in the world places dataset. City rank of 1 (highest) to 10 (lowest). Zero (0) means that a rank was not available. |
| CLOSEST_HOUSE_NUMBER | When fallback to street centroid geocoding preference is enabled the closest house for the given input is returned. For example, the input of “Calle Major 123” will now return the "Calle Major" with precision of S4 along with the “CLOSEST_HOUSE_NUMBER” candidate for “78”, if the closest house number in the data is "78". (Not avaliable for USA) |
| EXTENDED_MATCH_CODE | Extended Match Code: Provides detailed match information about all address component fields. See link for more details |
| FROM_WORLD_FALLBACK | Returns (true,false) when candidate is found in the world places data set |
| GENERIC_FIELD_1 | Generic input retained address information |
| GEOHASH | A 32-bit encoded string representing an area based on latitude
and longitude of the geocoded candidate. Note:
Not available for Verify API |
| GLOBAL_DELIVERY_INDICATOR | The Global Delivery Indicator (GDI) is a software feature designed to identify whether an address is deliverable and/or mailable. See link for more details |
| H3HEX | H3 is a geospatial indexing system that partitions the world into hexagonal cells. Returned when custom preference "RETURN_H3HEX" is set to true |
| LANGUAGE | The language supported (e.g., en) |
| MAIN_ADDRESS | The main street address name (e.g., WELLESLEY) |
| MATCH_TYPE | Describes the level of address match. Possible values: ADDRESS, STREET, ADMIN, POBOX, POI and NOMATCH |
| MULTIPLE_AREAS_FOR_POSTCODE | Indicates if more than one town exists within the same postal code. Information can be returned for non USA countries when (Z match) occurs. |
| PB_KEY | A unique address identifier returned when a match is made using the Master Location Dataset (MLD). Example: P0012QRKNCIM |
| POST_DIRECTIONAL | Postfix direction for the street, such as N, S, E, W, etc |
| POST_THOROUGHFARE_TYPE | Street type after the main address, e.g., "Main St". |
| POSTCODE_COUNT_IN_AREA | Number of postcodes found within a city or town (for non USA countries when G3 match occurs) |
| PRE_DIRECTIONAL | Prefix direction for the street, e.g., N, S, E, W, etc. |
| PRE_THOROUGHFARE_TYPE | Street type before the main address, e.g., "Via Veneto" |
| PRECISION_CODE | A code that describes the precision of the address match for the input address (e.g., S8HPNTSCZA) |
| PRECISION_LEVEL | Location code that indicate the precision of the geocode. 19 Building centroid, 16 Address Point |
| PRIMARY_AREA_FOR_POSTCODE | Indicates if the town is the primary town for a given postcode when multiple towns are associated with the postcode. Information can be returned for non USA countries when (Z match) occurs. |
| RESULT_CODE | The result code for this candidate (e.g., S8HPNTSCZA). |
| SEGMENT_ID | Street segment id |
| SIMPLE_MATCH_CODE | Simple Match Code: Focuses on the match status of a subset of address component fields. See link for more details |
| STREETDATATYPE | Integer value that indicates the type of street |
| SUB_DIVISION_CODE | A country's primary subdivision (such as a province or state, for example) is represented by its subdivision code in ISO 3166-1. Based on the two-letter ISO 3166-1 code element, this code consists of a separator and up to three alphanumeric characters. |
| THOROUGHFARE_TYPE | Street Type, either pre or post type |