Output Field Name | Description | Applicable for |
---|---|---|
Default Fields - The following fields will be returned by default. | ||
X | Longitude of the candidate. | Geocoding |
Y | Latitude of the candidate. | Geocoding |
Precision Code | A code describing the precision of the geocode. The possible match categories are as follows:
|
Geocoding |
The matches in the 'S' category indicate that the record was matched to a single address candidate.
|
Geocoding | |
PO Box candidates return a result code beginning with the letter B.
|
Reverse Geocoding | |
Additional match information is of the format
HPNTSCSZA . If a match result was not made for
the specified component, a dash (-) will appear in place of a letter.
|
Geocoding | |
Source Dictionary | Identifies the dictionary that is the source for the candidate information and data. The source dictionary is a 0-based integer value that indicates which configured dictionary the candidate came from. | Geocoding/Reverse Geocoding |
Country | The three-letter ISO 3166-1 Alpha-3 country code. For a listing of the countries and associated ISO country codes, see Supported Countries. | Geocoding/Reverse Geocoding |
Optional Fields - The following fields may be selected to be returned as desired. | ||
Formatted Street Address | The formatted main address line. | Geocoding/Reverse Geocoding |
Formatted Location Address | The formatted last address line. | Geocoding/Reverse Geocoding |
Place Name | The building name, place name, Point of Interest (POI), company or firm name associated with the address. | Geocoding/Reverse Geocoding |
Area Name 1 | The largest geographic area, such as a state, province or region. | Geocoding/Reverse Geocoding |
Area Name 2 | The secondary geographic area, such as a county or district. | Geocoding/Reverse Geocoding |
Area Name 3 | The town or city. | Geocoding/Reverse Geocoding |
Area Name 4 | The city subdivision or locality. For Puerto Rico, the urbanization. | Geocoding/Reverse Geocoding |
Post Code 1 | The postal code in the appropriate format for the country. | Geocoding/Reverse Geocoding |
Post Code 2 | The secondary postal code, if used, in the appropriate format for the country. For USA, the 4-digit ZIP Code extension. | Geocoding/Reverse Geocoding |
Street Side |
USA only. Indicates which side of the street the address
is located on. One of the following:
|
Geocoding/Reverse Geocoding |
Range Parity |
USA only. Indicates the parity of the house number in the
range:
|
Geocoding/Reverse Geocoding |
County Name | USA only. The county. | Geocoding/Reverse Geocoding |
Block |
USA only. The 15-digit census block ID/census FIPS code,
using the syntax sscccttttttgbbb where:
|
Geocoding/Reverse Geocoding |
Match Code | USA only. Match codes indicate the portions of the address that matched or did not match to the reference data. For descriptions of match codes, see USA Match Codes. | Geocoding/Reverse Geocoding |
MM Result Code | The MapMarker result code for the address. See result codes in MapMarker (MM) Result Codes. | Geocoding/Reverse Geocoding |
LOC Code | USA only. Location codes indicate the accuracy of the assigned geocode. For descriptions of location codes, see USA Location Codes. | Geocoding/Reverse Geocoding |
Datatype Name | The data set used to geocode the address. | Geocoding/Reverse Geocoding |
Precision Level | A code describing the precision of the geocode. One of the
following:
|
Geocoding/Reverse Geocoding |
Errors |
|
Geocoding/Reverse Geocoding |
REVERSE_GEOCODE_DISTANCE | Reverse geocode distance. | Reverse Geocode |
REVERSE_GEOCODE_DISTANCE_UNIT | Reverse geocode distance unit. | Reverse Geocode |
GNAF_PID | GNAF unique identifier. | Geocoding/Reverse Geocoding |
GNAF_CONFIDENCE | The confidence level of an address indicates the level of usage of each address by the contributor address datasets. | Geocoding/Reverse Geocoding |
GNAF_RELIABILITY | Refers to the geocode precision and is linked to how the geocode was generated. | Geocoding/Reverse Geocoding |
GNAF_PARCEL_ID | The parcel id. | Geocoding/Reverse Geocoding |
GNAF_GEOCODE_LEVEL | The geocode level type indicates which geocodes have been assigned to an address. | Geocoding/Reverse Geocoding |
GNAF_ADDRESS_CLASS | The geocoded address class. | Geocoding/Reverse Geocoding |
PreciselyID | Unique ID for an addressable location. Note: PreciselyID was
previously known as PB Key.
|
Geocoding/Reverse Geocoding |
LOT_NUMBER | The lot number. | Geocoding/Reverse Geocoding |
GEOCONTAINMENT | The geo containment. | Geocoding/Reverse Geocoding |
GEOFEATURE | Characteristic of a feature (e.g. name of an area). | Geocoding/Reverse Geocoding |
DPV Fields | Delivery Point Validation (DPV) validates the address as a known
USPS address record. This allows users to identify potential
addressing issues that may cause problems with delivery. To know about DPV output fields and description, see DPV Output Fields. |
Geocoding |
DPV Output Fields
Output Fields Name | Description |
---|---|
DPV_CMRA |
Delivery Point Validation CMRA indicator. Y: Address found in CMRA table. N: Address not found in CMRA table Blank: DPV not loaded. |
DPV_CONFIRM |
Indicates if a match occurred for DPV data. N: Nothing confirmed Y: Everything confirmed (ZIP+4, primary and secondary) S: ZIP+4 and primary (house number) confirmed.
D: ZIP+4 and primary (house number) confirmed and a default match
Blank: Non-matched input address to USPS ZIP+4 data, or DPV data not loaded. |
DPV_FALSE_POS |
DPV false-positive indicator. Y: False-positive match found. Blank: False-positive match not found. |
DPV_FOOTNOTE1 |
Information about the matched DPV records. AA: ZIP+4 matched A1: Failure to match a ZIP+4. Blank: Address not presented to hash table or DPV data not loaded. |
DPV_FOOTNOTE2 |
Information about the matched DPV records. BB: All DPV categories matched. CC: DPV matched primary/house number, where the secondary/unit number did not match (present but invalid). M1: Missing primary/house number M3: Invalid primary/house number. N1: DPV matched primary/house number, with a missing secondary number. P1: Missing PS, RR, or HC Box number. P3: Invalid PS, RR or HC Box number. F1: All military addresses. G1: All general delivery addresses. U1: All unique ZIP Code addresses.
Blank: Address not presented to hash table or DPV data not
loaded.
Note: A unique ZIP Code is a ZIP Code assigned to a company,
agency, or entity with sufficient mail volume to receive its own ZIP
Code.
|
DPV_FOOTNOTE3 |
Information about the matched DPV records. R1: Matched to CMRA but PMB designator not present. R2: Matched to CMRA and PMB designator present (PMB 123 or #123). Blank: Address not presented to hash table or DPV data not loaded. |
DPV_NO_STAT |
Y: The address is valid for CDS pre-processing. N: The address is not valid for CDS pre-processing. Blank: DPV is not loaded or DPV did not confirm. |
DPV_SHUTDOWN |
Y: Address was found in false-positive table. N: Address was not found in false-positive table. Blank: Address was not presented to hash table or DPV data not loaded. |
DPV_VACANT |
Y: The address is vacant. N: The address is not vacant. Blank: DPV is not loaded or DPV did not confirm (so vacancy is irrelevant). |