Address Verify HTTP Response - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Within the Addressing REST API, a request to the Address Verify Service returns a list of results. Not every field will be returned with a result.

Below are the Response fields returned:

Field Type Description
errorMessage String Exception message. The error message returned from the service with an error code
status Status Status of the response.
results <Result array List of results based on the specified criteria.

Address Verify API Examples:

Below is an example response for Matched Addresses:
{
  "responses": [
    {
      "status": "OK",
      "results": [
        {
          "score": 97,
          "address": {
            "formattedAddress": "1700 DISTRICT AVE STE 300, BURLINGTON MA 01803-5231, United States",
            "formattedStreetAddress": "1700 DISTRICT AVE STE 300",
            "formattedLocationAddress": "BURLINGTON, MA  01803-5231",
            "addressNumber": "1700",
            "country": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "isoAlpha3Code": "USA",
              "isoNumericCode": "840"
            },
            "admin1": {
              "longName": "Massachusetts",
              "shortName": "MA"
            },
            "admin2": {
              "longName": "MIDDLESEX COUNTY",
              "shortName": "MIDDLESEX COUNTY"
            },
            "city": {
              "longName": "BURLINGTON",
              "shortName": "BURLINGTON"
            },
            "postalCode": "01803",
            "postalCodeExt": "5231",
            "unit": "300",
            "unitType": "STE",
            "street": "DISTRICT"
          },
          "addressLines": [
            "1700 DISTRICT AVE STE 300",
            "BURLINGTON MA 01803-5231",
            "United States"
          ],
          "explanation": {
            "addressMatch": {
              "type": "ADDRESS",
              "description": [
                {
                  "label": "placeName",
                  "matchType": "NONE"
                },
                {
                  "label": "addressNumber",
                  "matchType": "EXACT"
                },
                {
                  "label": "admin1",
                  "matchType": "EXACT"
                },
                {
                  "label": "admin2",
                  "matchType": "NONE"
                },
                {
                  "label": "city",
                  "matchType": "EXACT"
                },
                {
                  "label": "neighborhood",
                  "matchType": "NONE"
                },
                {
                  "label": "suburb",
                  "matchType": "NONE"
                },
                {
                  "label": "street",
                  "matchType": "EXACT"
                },
                {
                  "label": "postalCode",
                  "matchType": "NONE"
                },
                {
                  "label": "streetType",
                  "matchType": "EXACT"
                },
                {
                  "label": "postalCodeExt",
                  "matchType": "NONE"
                },
                {
                  "label": "streetDirectional",
                  "matchType": "EXACT"
                }
              ]
            },
            "source": {
              "label": "ggs"
            }
          },
          "customFields": {
            "RESBUS": "B",
            "LOTSIZE_METERS": "14677",
            "CSA_NUMBER": "148",
            "TYPE_SHORT": "AVE",
            "THOROUGHFARE_TYPE": "AVE",
            "HIUNIT": "300",
            "PARCEN_ELEVATION_METERS": "44.2",
            "ROAD_CLASS": "01",
            "MATCH_CODE": "S902",
            "RDI_RETCODE": "N",
            "COUNTY": "25017",
            "PB_KEY": "P0000BJ4F90Q",
            "LANGUAGE": "en",
            "UNIT_TYPE": "STE",
            "ADDRTYPE": "M",
            "INC_IND": "N",
            "BLOCK_2010": "250173324002012",
            "POINT_ID": "100893034",
            "CHECK_DIGIT": "5",
            "METRO_FLAG": "Y",
            "BLOCK": "250173324011003",
            "POST_THOROUGHFARE_TYPE": "AVE",
            "QCITY": "250065000",
            "ZIP_FACILITY": "P",
            "TFID": "258319428",
            "UNIT_RANGE_PARITY": "E",
            "APN_ID": "048 46-51-0",
            "LOT_CODE": "A",
            "LOT_NUM": "0212",
            "CTYST_KEY": "V21569",
            "UACEPOP": "4181019",
            "NAME": "DISTRICT",
            "ZIP_CARRTSORT": "B",
            "PARENT_ID": "P0000BJ68DL3",
            "LORANGE": "1700",
            "CLOSE_MATCH": "T",
            "STREET_SIDE": "L",
            "DATATYPE": "12",
            "INTERSECTION": "F",
            "ZIP_CITY_DELV": "Y",
            "LOUNIT": "300",
            "LOC_CODE": "AP05",
            "CART": "C023",
            "NAME_CITY": "BURLINGTON",
            "BLOCK_LEFT": "250173324011003",
            "COUNTY_FIPS": "25017",
            "HIRANGE": "1700",
            "UACE": "09271",
            "REC_TYPE": "H",
            "HI_RISE_DFLT": "N",
            "URBANICITY": "L",
            "RESOLVED_LINE": "0",
            "MATCH_TYPE": "ADDRESS",
            "PARCEN_ELEVATION": "145",
            "PREF_CITY": "BURLINGTON",
            "CBSA_NUMBER": "14460",
            "ALT_FLAG": "B",
            "SEGMENT_DIRECTION": "F",
            "ADDRLINE_SHORT": "1700 DISTRICT AVE STE 300",
            "LOTSIZE": "157983",
            "CONFIDENCE": "89",
            "HIZIP4": "5231",
            "DATATYPE_NAME": "MASTER LOCATION",
            "SEGMENT_PARITY": "R",
            "CBSA_DIVISION_NAME": "CAMBRIDGE-NEWTON-FRAMINGHAM, MA METROPOLITAN DIVISION",
            "LOZIP4": "5231",
            "CSA_NAME": "BOSTON-WORCESTER-PROVIDENCE, MA-RI-NH-CT COMBINED STATISTICAL AREA",
            "DPBC": "75",
            "LASTLINE_SHORT": "BURLINGTON, MA  01803-5231",
            "PLACE": "2509875",
            "CITY_SHORT": "BURLINGTON",
            "NAME_SHORT": "DISTRICT",
            "ZIP9": "018035231",
            "IS_ALIAS": "N01",
            "PRECISION_CODE": "S8HPNTSC-A",
            "ZIP10": "01803-5231",
            "CBSA_NAME": "BOSTON-CAMBRIDGE-NEWTON, MA-NH METROPOLITAN STATISTICAL AREA",
            "RANGE_PARITY": "E",
            "CBSA_DIVISION_NUMBER": "15764"
          }
        }
      ]
    }
  ]
}

Response Fields

The Below table lists the response fields returned:

Response Element Type Description
address ResponseAddress Displays components of the address
addressLines <String> array Displays multiple formatted lines to support the postal standard of a given country.
"PRIME MINISTER& FIRST LORD OF THE TREASURY",
"10 DOWNING STREET",
"LONDON",
"SW1A 2AA",
"UNITED KINGDOM"
addressNumber String House or building number.

"10" or "630"

admin1 AdminField Specifies the largest geographic area, typically a state or province.

"New York" or "Maharashtra".

admin2 AdminField Specifies the secondary geographic area, typically a county or district.

"Douglas County" or "West Mumbai".
borough AdminField Unit of local government or other administrative subdivision.

"Vazira" or "Manhattan"

building String A roofed and walled structure built for permanent use.
city AdminField Specifies a city or town name.

"New York City"

country CountryField Values are based on the ISO 3166-1 standard for country codes (returned in alpha-2, alpha-3, or numeric format).
customFields Object

Returns additional information about the address; see Custom Output fields below for more details.
extended_match_code string Provides detailed information about all address component fields.
Example of Extended Global Match Code 
V4-D0M0B0U4F0G0P4S4Q0X0A0T4E0R6W0Z4Y4C4-5
explanation Explanation Describes the level of matching for each component of an address.
floor String Each level within a building.
formattedAddress String All components of the address, formatted to the country's standard, on one line.
"PRIME MINISTER& FIRST LORD OF THE TREASURY, 10 DOWNING STREET, LONDON, SW1A 2AA"

or "630 168TH ST, NEW YORK NY 10032-3725"

formattedLocationAddress String Location portion of the address, formatted to the country's standard.

"LONDON SW1A 2AA" or "NEW YORK, NY 10032-3725"

formattedStreetAddress String Street portion of the address, including the directional and street suffix, formatted to the country's standard.

"10 DOWNING STREET" or "630 W 168TH ST"

geometry Geometry Provides the candidate's geometry.
location Location

Describes the location type and coordinates.
neighborhood AdminField Specifies a city subdivision or locality.

"Chelsea"

parsed ParsedAddress

Shows how the address was parsed, using the specified addressing process.
placeName String If applicable, indicates the name of the candidate's place or building.

"PRIME MINISTER& FIRST LORD OF THE TREASURY"

postalCode String Main postal code.

"80125"

postalCodeExt String Secondary postal code, if one exists. For example, in the US, a ZIP+4 is 80125-8012.

"8012"

properties Object crsName - The coordinate reference system (CRS) used for the candidate's geocode. Expressed in epsg:nnnn format; the default is epsg:4326.
room String A single room within a building.
score Integer Provides a number from 0-100 to indicate how much the input was changed in order to match to the output candidate. It looks at certain fields including the house and unit numbers, street name, directional, and type, as well as postcode and area name fields. A score of 100 means that all the input fields checked exactly matched the output candidate. Available for all countries and the calculation is consistent from one country to another.
simple_match_code string Focuses on the status of a subset of address component fields.
Example of Simple Global Match Code 
V4-P4S4A0T4R6Z4C4-5
street String Street name only (no directional or street suffix).

"FRASER RIVER" or "168TH"

suburb AdminField Mixed-use or residential area within commuting distance of a city or urban area.

""

type String Feature
unit String The unit number, such as "3B".
unitType String A group or suite of rooms within a building that are under common ownership or tenancy, typically having a common entrance. (APT, STE, FLAT, etc.).

Custom Output fields

Below table lists the custom output fields returned:
Table 1. Custom Output Fields
   
CR Address Correct Result (ACR) code specifies exactly what data has been changed in each record. Example: "L5-P4S4A0T4R0Z4C4-100"

The three segments of the code correspond to the address status, component status, and the validation match score. For a complete explanation of the codes within each segment, please refer to the.

ADDRLINE The address line for single line input addresses.
ADDRLINE_SHORT Shortest possible address line that can be constructed from available short street name and other address line components.
ALIASED_SUBURB New Zealand Aliased suburb. An alternative to the officially-recognized suburb name.
ALT_FLAG Alternate/base record indicator:

A Alternate

B Base
APN_ID The Assessor's Parcel Number Identifier. Not applicable to street intersection matches.
AUX_USERDATA User data from an auxiliary file. Blank if no auxiliary file.
BANCHI The block number.
BLOCK Block information.
BLOCK_LEFT Census block ID from the left side of the street. Not applicable to street intersection matches.
BLOCK_LEFT2 For intersection matches, the Census block ID from the left side of the street for the second segment in an intersection.
BLOCK_RIGHT Census block ID from the right side of the street. Not applicable to streetintersection matches.
BLOCK_RIGHT2 For intersection matches, the Census block ID from the right side of the street for the second segment in the intersection.
BLOCK_SFX_LEFT The current left block suffix for Census 2010 geography. This field will be blank if the matched record is from point-level data.
BLOCK_SFX_LEFT2 For intersection matches, the current left block suffix for Census 2010 geography for the second segment in the intersection.
BLOCK_SFX_RIGHT The current right block suffix for Census 2010 geography. This field will be blank if the matched record is from point-level data.
BLOCK_SFX_RIGHT2 For intersection matches, the current right block suffix for Census 2010 geography for the second segment in the intersection.
CART Carrier route ID. Not applicable to street intersection matches.
CBSA_DIVISION_NAME Core Based Statistical Area (CBSA) division name.
CBSA_DIVISION_NAME2 For intersection matches, the Core Based Statistical Area (CBSA) division name for the second segment in the intersection.
CBSA_DIVISION_NUMBER Core Based Statistical Area (CBSA) division number.
CBSA_DIVISION_NUMBER2 For intersection matches, the Core Based Statistical Area (CBSA) division number for the second segment in the intersection.
CBSA_NAME The name of the Core Based Statistical Area (CBSA) in which the address is located.
CBSA_NAME2 For intersection matches, the name of the Core Based Statistical Area (CBSA) for the second segment in the intersection.
CBSA_NUMBER Core Based Statistical Area (CBSA) number.
CBSA_NUMBER2 For intersection matches, the Core Based Statistical Area (CBSA) number for the second segment in the intersection.
CENSUS_CD The Census Division (CD) in which the address is located.
CENSUS_CMA The Census Metropolitan Area (CMA) in which the address is located.
CENSUS_CSD The Census Subdivision (CSD) in which the address is located.
CENSUS_CT The Census Tract (CT) in which the address is located.
CENSUS_DA The Dissemination Area (DA) in which the address is located.
CENTERLINE_BEARING For centerline candidates, provides the compass direction, in decimal degrees, from the point data match to the centerline match. Measured clockwise from 0 degrees north.
CENTERLINE_BLOCK_LEFT For centerline candidates, the Census block ID from the left side of the street. Not applicable to street intersection matches.
CENTERLINE_BLOCK_RIGHT For centerline candidates, the Census block ID from the right side of the street. Not applicable to street intersection matches.
CENTERLINE_BLOCK_SFX_LEFT For centerline candidates, the current left block suffix for Census 2010 geography. This field will be blank if the matched record is from point-level data.
CENTERLINE_BLOCK_SFX_RIGHT For centerline candidates, the current right block suffix for Census 2010 geography. This field will be blank if the matched record is from point-level data.
CENTERLINE_DATATYPE For centerline candidates, the data type used to make the centerline match.
CENTERLINE_IS_ALIAS

Three characters indicating that a centerline match was located by an index alias.

The first character:

N
Normal street match
A
Alias match (including buildings, aliases, firms, etc.)

The next 2 characters:

01
Basic index, normal address match
02
USPS street name alias index
03
USPS building index
05
Statewide intersection alias (when using the Usw.gsi, Use.gsi,or Us.gsi file)
06
Spatial data street name alias (when using the Us_pw.gsi, Usw.gsi, Us_pe.gsi, Use.gsi, Us_ps.gsi, Usp.gsi, Us_psw.gsi, or Us_pse.gsi file is required.)
07
Alternate index (when using ZIP9.gsu, ZIP9E.gsu, and ZIP9W.gsu)
08
LACSLink
09
Unused
09
Auxiliary file match
10
Centrus Alias index (when using usca.gsi)
11
POI index (when using poi.gsi)
12
USPS Preferred Alias
13
ZIPMove match (when using us.gsz)

The us.gsz data file contains ZIP+4 codes that have been realigned and a change in city name and/or finance number has occurred. Specifically, ZIPMove allows a change in finance area because CASS searching does not allow a change of finance area unless the input city occurs in more than one finance area, or ZIPMove data contains the old address.

14
Expanded Centroids match (when using us_cent.gsc or bldgcent.gsc)
CENTERLINE_LAT For centerline candidates, the latitude as integer value in millionths of degrees.
CENTERLINE_LON For centerline candidates, the longitude as integer value in millionths of degrees.
CENTERLINE_NAME For centerline candidates, the primary street name.
CENTERLINE_NEAREST_DIST For centerline candidates, gives the distance, in feet, from the point-leve match to the centerline match.
CENTERLINE_POSTDIR For centerline candidates, the street postfix directional. Can be blank, N, S, E, W, NE, NW, SW, or SE.
CENTERLINE_PREDIR For centerline candidates, the street prefix directional. Can be blank, N, S, E, W, NE, NW, SW, or SE.
CENTERLINE_QCITY For centerline candidates, the state, city, or finance numbers.
CENTERLINE_ROAD_CLASS For centerline candidates, the road class code:
0
Minor road, main data file
1
Major road, main data file
10
Minor road, supplemental file
11
Major road, supplemental data file
CENTERLINE_SEG_HIRANGE For centerline candidates, provides the high house number in the segment.
CENTERLINE_SEG_LORANGE For centerline candidates, provides the low house number in the segment.
CENTERLINE_SEGMENT_DIRECTION For centerline candidates, gives the direction of the segment:
F
Numbers are forward.
R
Numbers are reversed.
CENTERLINE_SEGMENT_ID For centerline candidates, the unique segment ID from data vendors.
CENTERLINE_SEGMENT_PARITY For centerline candidates, provides the segment parity. The parity indicates which side of the street the odd numbers in the segment are located:
L
Left side of the street
R
Right side of the street
B
Both sides of the street
U
Unknown
CENTERLINE_TYPE For centerline candidates, provides the street type.
CHECK_DIGIT A one-digit code at the end of a mailing label barcode.
CHOMOKU The city block number.
CHOOAZA The number for a group of city blocks.
CITY The abbreviated city name from the last line of the input or output address the value from
CITY_SHORT The output city name that appears in LASTLINE_SHORT. This value is determined by logic similar to CITY. Whenever possible, this city name is 13 characters or less.

This output city name is determined by CASS rules. This can be either City State Name, City State Name Abbreviation, or Preferred Last Line City State Name.
CITYRANK This option returns the city ranking from 1 (highest) to 10 (lowest). Zero (0) means that a rank was not available.
CONFIDENCE The Confidence value for USA candidates is available as a custom output field on the candidate. The key is CONFIDENCE.
COUNTY The county FIPS code.
COUNTY_NAME The county name.
COUNTY_NAME2 For intersection matches, the County name for the second segment in the intersection.
COUNTY2 For intersection matches, the county FIPS code for the second segment in the intersection.

CPC_BUILDING_TYPE

Only seen in REST responses when Return All Information is set to true and the type is known. Note: CPC fields are not present when SYNTHETIC_LDU = true or t.

1
Residential building
2
Commercial building

CPC_RECORD_TYPE

 Canadian postal code (CPC) record type.
Note: returned only when the candidate contains a full postcode of FSA (Forward Sortation Area) + LDU (Local Delivery Unit).
<blank>
no address match was found
*
Unknown
A1
High-rise building
B1
LVR (Large Volume Receiver) street
C1
Government Street Address
D2
LVR (Large Volume Receiver) Served by Lock Box
E2
Government Served by Lock Box
F2
LVR (Large Volume Receiver) Served by General Delivery
11
Street
21
Street served by route
32
PO Box
42
Route service
CSA_NAME Combined Statistical Area (CSA) name.
CSA_NAME2 For intersections matches, the Combined Statistical Area (CSA) name for the second segment in the intersection.
CSA_NUMBER Combined Statistical Area (CSA) number.
CSA_NUMBER2 For intersection matches, the Combined Statistical Area (CSA) number for the second segment in the intersection.
CTYST_KEY USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product).
DATASTORE The country used for the data store.
DATATYPE The type of data used to make the match.
0
USPS
1
TIGER
2
TomTom Streets geocoding dataset
6
HERE Streets geocoding dataset
7
TomTom Points geocoding dataset
8
Centrus Points geocoding dataset
9
Auxiliary file
10
User Dictionary
11
HERE Points geocoding dataset
12
Master Location Data
DATATYPE_NAME The source data vendor for the candidate match.
DATATYPE2 For intersection matches, the type of data used to make the match for the second segment in the intersection.
DELIVERY_INSTALLATION_AREANAME Name of the delivery installation area associated with the address.
DELIVERY_INSTALLATION_QUALIFIERNAME Qualifier or descriptor that further identifies the delivery installation.
DELIVERY_INSTALLATION_TYPEDESCRIPTION Description of the delivery installation type (e.g., station, depot, facility).
DFLT Indicates the return status of HI_RISE_DFLT Highrise DFLT or R_RTE_DFLT Rural Routes:
Y
Either HI_RISE_DFLT Highrise DFLT and R_RTE_DFLT Rural Routes returned Y.
Blank
Both HI_RISE_DFLT Highrise DFLT and R_RTE_DFLT Rural Routes returned N or Blank.
DPBC Delivery Point Barcode.
DPV_CMRA Delivery Point Validation CMRA indicator.
DPV_CONFIRM Indicates if a match occurred for DPV data.
DPV_FALSE_POS DPV false-positive indicator.
DPV_FOOTNOTE1 Information about the matched DPV records.
DPV_FOOTNOTE2 Information about the matched DPV records.
DPV_FOOTNOTE3 Information about the matched DPV records.
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).
ENHANCEMENTDATASETS

The names of the enhancement datasets that have been used.
EWSMatch Indicates if an EWS match was made:
Y
Match denied because it matched to EWS data.
Blank
Input record did not match to EWS data.
EXTENDEDACR

Extended Address Correction Result (ACR). The three segments of the code correspond to the address status, component status, and the validation match score. For a complete explanation of the codes within each segment.

FIRM_NAME The name of firm from the USPS data or the input firm name. Not applicable to street intersection matches.
FORMATTED_STREET_RANGE The formatted range data for the address. This field is only returned for postal centroid candidates.
Geocontainment This specifies whether the returned coordinates are inside or outside the address boundary. Values are YES for coordinates within, or NO for coordinates outside the boundary.

To include this field in the output, select:

Return Values > GNAF Identifiers checkbox.
GEOFEATURE The physical or virtual reference of the geocode. Physical features associated with the address point may include mailbox, driveway, water meter, building. Virtual features are mathematically- or geometrically-derived spatial-reference points such as the centroid of a lot or property.
GEOFEATURE This field returns a geocode feature type if that was not provided in other GNAF fields. GEOFEATURE corresponds to Geocode Types (GEOCODE_TYPE_AUT Codes) that are described in the PSMA Data Product Description Version 2.7 (Aug. 2012).

To include this field in the output, select:

Return Values > GNAF Identifiers checkbox.
GEOHASH Uses the latitude and longitude of the geocoded candidate to return a 32-bit encoded string representing an area. The more characters in the string, the more precise the location. By default, the precision level is set to the highest precision of 12 characters. If another level is needed, set the custom preference GEOHASH_LEVEL.
GLOBAL_DELIVERY_INDICATOR Indicates the overall mailability and locatability status of the verified address.
1

Address is locatable and mailable

2

Locatable but not mailable

4
Mailable but not locatable (e.g., PO Boxes, military)
5
New construction, not yet mailable
6
Vacant address
7
Historical / gone‑away address
9

Not locatable and not mailable

Z

Unknown address

GO The house number.
GOVT_FLAG The government building indicator:
A
City government building
B
Federal government building
C
State government building
D
Firm only
E
City government building and firm only
F
Federal government building and firm only
G
State government building and firm only
A, B, C, E, F, and G are valid for alternate records only (ALT_FLAG=A). D is valid for both base and alternate records.
HEXAVIA_CODE French postal street ID such as "01606804"
HEXACLE_CODE French postal housenumber ID such as "83070224ZB"
HI_RISE_DFLT Indicates if the match was made to a high-rise building.
HIRANGE House number at the high end of the range. Not applicable to street intersection matches.
HISTORICALPOSTCODE When the input postal code is a historical postal code, returns the previous postal code for this address.
HIUNIT High unit number for the range. Not applicable to street intersection matches.
HIZIP4 High ZIP+4 for the range. Not applicable to street intersection matches.
HOUSE_NUMBER The house number of input or output address. Not applicable to street intersection matches.
INPOSTAL The INPOSTAL field (Postal Verified Indicator) in the Ordnance Survey Address Base Premium Dataset (GB10) is a flag that confirms whether an address has been verified against postal service databases.
INSEE_CODE French city official administrative ID such as "83070". Note: two codes are assigned to each French town (the Postal Code and the INSEE Code or "Code commune").
IRIS_CODE French census tract ID such as "830700102"
IS_ALIAS The first character:
N
Normal street match
A
Alias match (including buildings, aliases, firms, etc.)

The next 2 characters:

01
Basic index, normal address match
02
USPS street name alias index
03
USPS building index
05
Statewide intersection alias (when using the Usw.gsi, Use.gsi,or Us.gsi file)
06
Spatial data street name alias (when using the Us_pw.gsi, Usw.gsi, Us_pe.gsi, Use.gsi, Us_ps.gsi, Usp.gsi, Us_psw.gsi, or Us_pse.gsi file is required.)
07
Alternate index (when using ZIP9.gsu, ZIP9E.gsu, and ZIP9W.gsu)
08
LACSLink
09
Unused
09
Auxiliary file match
10
Centrus Alias index (when using usca.gsi)
11
POI index (when using poi.gsi)
12
USPS Preferred Alias
13
ZIPMove match (when using us.gsz).

The us.gsz data file contains ZIP+4 codes that have been realigned and a change in city name and/or finance number has occurred. Specifically, ZIPMove allows a change in finance area because CASS searching does not allow a change of finance area unless the input city occurs in more than one finance area, or ZIPMove data contains the old address.

14
Expanded Centroids match (when using us_cent.gsc or bldgcent.gsc)
ISRURAL When true, indicates the candidate's address is located in a rural region (village).
IS_MUP Indicates whether the property is a multi-unit property.

"IS_MUP": "true"

The following countries support multi-unit properties

  • United Kingdom (GBR)
  • Australia (AUS)
  • New Zealand (NZL)
  • Canada (CAN)
JUSHO_CODE A point ID that represents a unique address.
KEY_UFI 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. The UFI is always returned if available, but you cannot use the UFI for input.
LACS_FLAG Indicates if the address is marked for conversion.
L
Address marked for LACS conversion.
Blank
Address not marked for LACS conversion.
LACSLINK_IND LACSLink indicator.
Y
Matched LACSLink record.
N
LACSLink match NOT found.
F
False-positive LACSLink record.
S
Secondary information (unit number) removed to make a LACSLink match.
Blank
Not processed through LACSLink.
LACSLINK_RETCODE LACSLink return code.
A
Matched LACSLink record.
00
LACSLink match NOT found.
09
Matched to highrise default, but no LACSLink conversion.
14
Found LACSLink match, but no LACSLink conversion.
92
Secondary information (unit number) removed to make a LACSLink match.
Blank
Not processed through LACSLink.
LACSLINK_SHUTDOWN
Y
False-positive occurred and LACSLink library shutdown.
N
LACSLink library has not shutdown or not loaded.
LAST_LINE The complete last line of the address.
LASTLINE_SHORT The address last line. Whenever possible, this field is 29 characters or less:
  • 13-character city name
  • 2 (comma and space)
  • 2-character state abbreviation
  • 2 spaces
  • 10-digit ZIP Code
LAT The latitude of the address.
LEVEL_NUMBER

The number of a floor or level in a multistory building. For example,

Floor 2, 17 Jones Street

The GNAF database includes level information for some Australian states. Level information may be associated with unit information, but not necessarily. If the GNAF database contains multiple records with the same level, the level information is returned only if the input address contains unique content (such as a unit number). If the GNAF dictionary has level information for an address, that information is returned with the matched candidate.

The correct level information is returned (when available) even if the input address did not include level information, or if the input had the wrong level information. If the input address has level information but the GNAF database does not include level information for the matching address, then the input level information is discarded since it is not validated in the GNAF data.
LEVEL_TYPE

The label used for a floor of a multistory building. For example, "Level" or "Floor". In this example, the level type is "Level":

Suite 3 Level 7, 17 Jones Street

In this example, Suite 3 is a unit.
LOC_CODE Location codes indicate the accuracy of the assigned geocode. For descriptions of location codes, see ../Geocoding/GlobalGeocodingGuide/source/ResultCodes/US_Geocoding/GeocodingLocationCodes.html#reftxt_geocodinglocationcodes in the appendix.
LOCATION (Addressing API) The location metadata is an explanation of the precision level of the match. This is an evolving feature and will get more robust as we enrich our data.
LON The longitude of the address.
LORANGE House number at the low end of the range. Not applicable to street intersection matches.
LOT_CODE Lot ascending and descending value. Only available for addresses that can be standardized. Blank if running in CASS mode and you have not initialized DPV or the output address does not DPV confirm.
LOT_NUM 4-digit eLot number. Requires an input address that can be standardized. Blank if running in CASS mode and you have not initialized DPV or the output address does not DPV-confirm.
LOT_NUMBER Lot numbers are returned for GNAF candidates because some rural addresses do not have adequate physical or house number information.
LOUNIT Low unit number. Not applicable to street intersection matches.
LOZIP4 Low ZIP+4 for this range. Not applicable to street intersection matches.
OUTERMATCHSCORE A score that measures changes to each address line.
MAIL_STOP Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION.
MAINADDRLINE The complete first line of the address.
MATCH_CODE Match codes indicate the portions of the address that matched or did not match to the reference file. For descriptions of match codes, see ../Geocoding/GlobalGeocodingGuide/source/ResultCodes/US_Geocoding/GeocodingMatchCodes_intro.html#matchcodes in the appendix.
MATCHED_DB Index of geocoding dataset for matched record.
MCD_NAME Minor Civil Division name from the auxiliary file. Blank if no auxiliary file match.
MCD_NUMBER Minor Civil Division number from the auxiliary file. Blank if no auxiliary file match.
MESH_BLOCK_ID A Meshblock is the smallest geographic unit for which statistical data is collected by the Australian Bureau of Statistics (ABS). Meshblocks usually contain a minimum of 20 to 50 households. This is about one fifth the size of a Collection District (CD). You can use the Meshblock ID to do additional attributions against your own data.
METRO_FLAG Indicates whether the Core Based Statistical Area (CBSA) in which the address is located is a metropolitan area or a micropolitan area. One of the following:
Y
The address is located in a Metropolitan Statistical Area. Metropolitan areas have a population greater than 50,000.
N
The address is not located in a Metropolitan Statistical Area. It is located in a micropolitan area. Micropolitan areas have a population between 10,000 and 49,999.
Blank
Is blank (the county does not contain a CBSA).
METRO_FLAG2 Indicates whether the Core Based Statistical Area (CBSA) in which the address is located is a metropolitan area or a micropolitan area. One of the following:
Y
The address is located in a Metropolitan Statistical Area. Metropolitan areas have a population greater than 50,000.
N
The address is not located in a Metropolitan Statistical Area. It is located in a micropolitan area. Micropolitan areas have a population between 10,000 and 49,999.
Blank
Is blank (the county does not contain a CBSA).
MM_RESULT_CODE The MapMarker result code for this candidate. See ../Geocoding/GlobalGeocodingGuide/source/ResultCodes/Intl_Geocoding/resultcodes_title.html#ResultCodes_title in the appendix.
MULTIPLE_AREAS_FOR_POSTCODE Postal centroid candidates return a value of "true" when more than one town is contained within the postcode. The Area Name fields (city/town, state/region, etc.) will be populated when available.
NAME The street name.
NAME_CITY The city name for the matched address from the City-State record.
NAME_SHORT The short street name used to construct the short address line.
NAME2 For intersection matches, the street name for the second segment of the intersection.
NEAREST_DIST Gives the distance, in feet, from the input location to the matched street segment, point address, or intersection.
Note: For reverse geocoding only.
NZL_MESHBLOCK_ID 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.
ORIGINAL_LATITUDE The original latitude value.
ORIGINAL_LONGITUDE The original longitude value.
ORIGINAL_LATITUDE The original GNAF latitude.
ORIGINAL_LONGITUDE The original GNAF longitude.
OUTERMATCHSCORE

A score that measures changes to each address line.
PARCEN_ELEVATION The elevation of the geocode at the parcel centroid. Not applicable to street intersection matches.
PB_KEY A unique address identifier returned when an address match is made using the Master Location Dataset (MLD). It is used as a lookup key to a GeoEnrichment dataset, in order to return attribute data for the match.
Note: For forward and reverse geocoding.
Note: To return this field, select the Return all available information option.
PERCENT_GEOCODE Percentage along the street segment to the interpolated match. The range is 0.0 - 100.0. The range is always 0.0 for point data.
Note: For reverse geocoding only.
PLOT Plot number. For example, Thai address points contain plot numbers and house numbers to support the Plot/House used in Thai addresses such as "7/22 Moo 5" (house 22 on plot 7).
PMB_DESIGNATOR U.S. Postal Service allows the use of "PMB" or the "#"sign as the Private mailbox (PMB) designator.
PMB_NUMBER Private mailbox number.
POI_CATEGORY Point of interest category. This field describes the type of POI, such as a bank, ATM, or restaurant.
POINT_ID The unique point ID of the matched record when matched to point-level data. Blank if the matched record is not from point-level data. Not applicable to street intersection matches.
POSTAL_FALLBACK USA fallback candidates returns the correct MatchCode and LocationCode indicating a postal fallback, rather than codes indicating a postal level geocode.
POSTAL_VERIFIED YES - the postal code is valid

NO - the postal code is invalid
POSTCODE_COUNT_IN_AREA City/town-level candidates (match code G3) display the number of postcodes found in a town. The Postcode field will also be output when available.
POSTDIR Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.
POSTDIR_SHORT Postdir from the ADDRLINE_SHORT field.
POSTDIR2 For intersection matches, the postfix direction of the second street in the intersection. Can be blank, N, S, E, W, NE, NW, SW, or SE.
POST_THOROUGHFARE_TYPE Street type after the main address, such as "Main St".
PRE_THOROUGHFARE_TYPE Street type before the main address, such as "Via Veneto".
PRECISION_CODE

A code that describes the precision of the address match for the input address.
PREDIR Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.
PREDIR_SHORT Prefix direction from the ADDRLINE_SHORT field.
PREDIR2 For intersection matches, the prefix direction of the second street in the intersection. Can be blank, N, S, E, W, NE, NW, SW, or SE.
PREF_CITY The preferred city name for the output ZIP Code of the matched address.
PRIMARY_AREA_FOR_POSTCODE If more than one town is contained within the postcode, candidates return a value of "true" if the current town is the primary town for this postcode. The area names (city/town, state/region, etc.) fields will be populated when available.
QCITY State, city, or finance numbers.
R_RTE_DFLT Match indicator for rural routes.
RANGE_PARITY Indicates the parity of the house number in the range:
E
Even
O
Odd
B
Both
RDIRetCode Residential Delivery Indicator identifies whether a delivery type is classified as residential or business.
Note: To use RDI, Delivery Point Validation (DPV) must also be enabled and a US Streets dataset configured.
Y
Residence
N
Business
Blank
Not processed through RDI
REC_TYPE The range record type:
A
Auxiliary file
F
Firm
G
General Delivery
H
Highrise
P
Post Office/PO Box
R
Rural Route
S
Street
T
TIGER record match
U
User Dictionary
Not applicable to street intersection matches.
RESOLVED_LINE Indicates which line in a 2-line address was used to resolve the address.
ROAD_CLASS The road class code:
0
Minor road, main data file
1
Major road, main data file
10
Minor road, supplemental file
11
Major road, supplemental data file
Not applicable to street intersection matches.
ROAD_CLASS2 For intersection matches, the road class code of the second segment in the intersection:
0
Minor road, main data file
1
Major road, main data file
10
Minor road, supplemental file
11
Major road, supplemental data file
SEG_HIRANGE Provides the high house number in the segment.
SEG_HIRANGE2 For intersection matches, provides the high house number of the second segment in the intersection.
SEG_LORANGE Provides the low house number in the segment.
SEG_LORANGE2 For intersection matches, provides the low house number of the second segment in the intersection.
SEGMENT_DIRECTION Gives the direction of the segment:
F
Numbers are forward.
R
Numbers are reversed.
SEGMENT_DIRECTION2 For intersection matches, gives the direction of the second segment in the intersection:
F
Numbers are forward.
R
Numbers are reversed.
SEGMENT_ID Segment ID (TLID) or unique ID from premium data vendors. Not applicable to street intersection matches.
SEGMENT_ID2 For intersection matches, the Segment ID (TLID) or unique ID from premium data vendors for the second segment in the intersection.
SEGMENT_PARITY Provides the segment parity. The parity indicates which side of the street the odd numbers in the segment are located:
L
Left side of the street
R
Right side of the street
B
Both sides of the street
U
Unknown
SEGMENT_PARITY2 For intersection matches, provides the segment parity for the second segment in the intersection. The parity indicates which side of the street the odd numbers in the segment are located:
L
Left side of the street
R
Right side of the street
B
Both sides of the street
U
Unknown
STATE The state abbreviation.
STATE_FIPS The state FIPS code.
STREET_SIDE The matched address is on the following side of the street:
L
Left side of the street.
R
Right side of the street.
B
Both sides of the street.
U
Unknown side of the street.
This is relative to the segment end points and the segment direction (SEGMENT_DIRECTION).
STREET_TYPE_ABB The abbreviation for the street type, which is spelled out by default.
SUB_LOCALITY The municipal division below locality (areaName4) level. This returns an SL result code.
SUITELINK_RET_CODE
A
SuiteLink record match.
00
No SuiteLink match.
Blank
This address was not processed through SuiteLink.
SYNTHETIC_LDU

The Local Delivery Unit (LDU) is assigned to postal addresses by the Canada Post. If an address has not been assigned an LDU, Precisely has assigned a "Synthetic LDU". Synthetic LDUs are not recognized by Canada Post. However, our methodology for assigning them is geographically congruent with LDUs assigned by Canada Post.

For Geocode and Reverse Geocode candidates, the SYNTHETIC_LDU is only returned for cases when it is true. Autocomplete candidates will return a "t" or an "f" depending on whether the candidate has a SYNTHETIC_LDU or not.
Note: Available in Canadian Master Location Data (CAN MLD CA8/ 8CA)
THOROUGHFARE_TYPE Street type.
TYPE_SHORT Street type from the ADDRLINE_SHORT field.
TYPE2 For intersection matches, the street type for the second segment in the intersection.
UD_ORIGINAL_LATITUDE The original latitude returned from a point-based user dictionary.
UD_ORIGINAL_LONGITUDE The original longitude returned from a point-based user dictionary.
UNIT_NUMBER The unit number. Not applicable to street intersection matches.
UNIT_TYPE The unit type (APT, STE, etc.). Not applicable to street intersection matches.
URB_NAME The urbanization name for Puerto Rico.
VALIDATION_CONFIDENCE A calculated score ranging from 0 to 100, indicating the level of confidence that the match results are correct. Confidence codes are calculated based on an algorithm that takes into account the match results for individual output fields. Output fields included in this calculation are:
Addressing API
country
city
admin1
street
addressNumber
streetPreDirectional
streetPostDirectional
streetSuffix
VALIDATIONDATASET The name of the validation dataset used during address validation calls.
VALIDATIONRULE Validation Rule code. This field is populated by address, geocoding and enhancement datasets. The codes are dataset-specific and provide extra information about the processing of the data.
ZIP 5-digit ZIP Code. Not applicable to street intersection matches.
ZIP_CARRTSORT Indicates the type of cart sort allowed:
A
Automation cart allowed, optional cart merging allowed.
B
Automation cart allowed, optional cart merging not allowed.
C
Automation cart not allowed, optional cart merging allowed.
D
Automation cart not allowed, optional cart merging not allowed.
ZIP_CLASS ZIP Classification Code:
Blank
Standard ZIP Code
M
Military ZIP Code
P
ZIP Code has P.O. Boxes only
U
Unique ZIP Code. (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.)
ZIP_FACILITY Returns the USPS City State Name Facility Code:
A
Airport Mail Facility (AMF)
B
Branch
C
Community Post Office (CPO)
D
Area Distribution Center (ADC)
E
Sectional Center Facility (SCF)
F
Delivery Distribution Center (DDC)
G
General Mail Facility (GMF)
K
Bulk Mail Center (BMC)
M
Money Order Unit
N
Non-Postal Community Name, Former Postal Facility, or Place Name
P
Post Office
S
Station
U
Urbanization
ZIP10 10-digit ZIP Code (ZIP + 4) with dash separator.
ZIP4 4-digit ZIP Code extension.
ZIP9 9-digit ZIP Code (ZIP + 4).

Status Codes

Each response to a request contains an HTTP status code. The Address Verify Service will return one of the following status codes:

Response Status Code Description
OK 200 The request was valid and results were found.
Unauthorized 401 Invalid Token
ZERO_RESULTS 200 The request was valid but no results were found.
INVALID_REQUEST 400 Invalid information was encountered in the request.
INVALID_CLIENT_INPUT 400 Request body or parameter format is not correct.
INVALID_TOKEN 401 Invalid Token was encountered.
UNAUTHORIZED 401 Unauthorized request encountered
BATCH_SIZE_EXCEEDED 413 Batch size exceeded for the request.
INTERNAL_ERROR 500 An internal error occurred.
SERVICE_UNAVAILABLE 503 Service is not available to serve the request.