United States (USA)

Custom Preferences

USA supports custom preferences and custom output fields.

Additional topics for USA geocoding are included following the custom tables.

Table 1. Custom Preferences
Preference Description
USE_ADDRESS_POINT_INTERPOLATION When set to true, enables address point interpolation. Default = false. Supported only in forward geocoding.
Note: The address point interpolation feature requires that you have a point-level geocoding dataset installed.
CALCULATE_CENTERLINE_ PROJECTION_OF_POINT Computes the closest point on the street from the parcel point. Default = disabled.
Note: This feature requires that a point-level geocoding dataset is installed.
USE_CENTERLINE_OFFSET When set to true, calculates the centerline offset for point addresses. Default = false. Supported only in forward geocoding.
Note: The centerline feature requires that you have a point-level geocoding dataset installed.
A centerline point match is indicated by a result code beginning with SC.
CENTERLINE_OFFSET When USE_CENTERLINE_OFFSET is enabled, this specifies the distance to offset the point from centerline. Default = 0. Supported in forward geocoding only.
CENTERLINE_OFFSET_UNITS When USE_CENTERLINE_OFFSET is enabled, this specifies the unit type for the centerline offset. Valid values = feet, meters. Default = meters. Supported only in forward geocoding.
FIND_ADDR_POINT_INTERP When set to true, enables address point interpolation. Default = false.
Note: Supported only in forward geocoding.
Note: This feature does not work with point addresses in Auxiliary files.
FIND_ADDRCODE When set to true, attempts to standardize and find an address geocode. Set this option if you want the address parsed and standardized. If this option is not set, only the input ZIP and ZIP+4 address elements are used. Default = false.
Note: Supported only in forward geocoding.
FIND_ADDRESS_RANGE When set to true, returns address range information. Default = false.
Note: Supported only in forward geocoding.
Note: Ignored in CASS and Exact match modes.
FIND_ALTERNATE_LOOKUP Determines whether the preferred lookup is to look for the streets first or the firms first. Default = 3.
Note: Supported only in forward geocoding.
Note: Ignored in CASS match mode.
1
Prefer street lookup: Matches to the address line, if a match is not made, then matches to the placeName line.
2
Prefer firm lookup: Matches to the placeName line, if a match is not made, then matches to the address line.
3
Street lookup only: Matches to the address line. Default.
FIND_APPROXIMATE_PBKEY When set to true, enables the PBKey Fallback option. If an address match is not made to Master Location Data (MLD), but a match is made to a different dataset, the pbKey™ unique identifier of the nearest MLD point located within the search distance is returned. To distinguish when a fallback pbKey™ unique identifier is returned, the PB_KEY return value contains a leading character of "X" rather than "P", for example: X00001XSF1IF. Note, all of the other fields returned for the address match, including the geocode and all associated data, reflect the match results for the input address. The fallback pbKey™ unique identifier can then be used for the lookup to the GeoEnrichment dataset(s), and the attribute data for the fallback location is returned for the match. Default = false.
Note: This option requires that you have licensed and installed the Master Location Dataset.

For more information, see PBKey Fallback.

The search distance for the nearest MLD point with a pbKey™ unique identifier is configurable:

  • For forward geocoding, use the FIND_SEARCH_DIST option. For more information, see FIND_SEARCH_DIST.
  • For reverse geocoding, the search distance is the same that is used for the reverse geocoding search radius, use preferences:distance. For more information, see Reverse Geocode POST Request.
The allowable search radius is 0-5280 feet. The default is 150 feet.
FIND_BUILDING_SEARCH Controls the ability to search by building name entered in the address line. When set to true, enables matching to building names even when no unit numbers are present. Default = false.
Note: Supported only in forward geocoding.
Note: Ignored in CASS match mode.

This option is also used when matching to POI data, an optional index file included in the Master Location Data. See Point of Interest Matching.
FIND_CENTERLINE_OFFSET Offset distance from the street center for a centerline match. Any positive integer, which represents number of feet. Default = 0 feet.
Note: Supported only in forward geocoding.
Note: This feature requires a points dataset is installed.
FIND_CENTERLN_PROJ_OF_POINT When set to true, computes the closest point on the street from the parcel point. Default = false.
Note: Supported only in forward geocoding.
Note: This feature requires a points dataset is installed.
FIND_CLOSEST_POINT When set to true, matches to the nearest point address within the search radius, rather than to the closest feature (e.g. street segment or intersection as well as point addresses). Default = false.
Note: Supported only in reverse geocoding.
Note: This feature requires that at least one points dataset and one streets dataset are installed; otherwise, the match will be made to the closest feature.
FIND_CORRECT_LASTLINE When set to true, corrects elements of the output lastline, providing a good ZIP Code or close match on the soundex even if the address would not match or was non-existent. Default = false.
Note: Supported only in forward geocoding.
FIND_DB_ORDER Allows you to specifically set the order in which User Dictionary and GSD data sets are searched. The default search order is:
  • User Dictionaries
  • Point GSD files
  • Street GSD files
Enter a list of geocoding dataset index values [starting at 0, separated by semi-colons] indicating which datasets to search and in what order.
FIND_DPV When set to true, enables delivery point validation. Default = false.
Note: Supported only in forward geocoding.
FIND_EXPANDED_SEARCH_RADIUS Allows the setting of the radius in miles (up to 99) around which your record lies. Must be used with applicable FIND_SEARCH_AREA setting. Default radius setting = 25 miles.
Note: Ignored in CASS match mode.
FIND_EXPND_SRCH_LIM_TO_STATE When set to true, limits an expanded search to a state's border. Must be used with applicable FIND_SEARCH_AREA setting. Default = true.
Note: Ignored in CASS match mode.
FIND_FIRST_LETTER_EXPANDED When set to true, enables extra processing for a bad first letter (missing, wrong, etc.). Default = false.
Note: Supported only in forward geocoding.
Note: Ignored in Exact match mode.
FIND_LACSLINK When set to true, enables LACSLink lookup. Default = false.
Note: Supported only in forward geocoding.
FIND_MATCH_CODE_EXTENDED When set to true, enables the return of additional address match information. Most notably, this is used to indicate whether or not an exact match was made to the input unit number. An address match is still returned if there is not an exact match to the input unit number, but the match is to the main building address without units. This extended match code digit will also provide information about any changes in the house number, unit number and unit type fields. In addition, it can indicate whether there was address information that was ignored. Default = true. For more information, see Extended Match Codes.
Note: Supported only in forward geocoding.
FIND_MIXED_CASE When set to true, returns candidate information in mixed case rather than uppercase. Default = false.
FIND_NEAREST_ADDRESS When set to true, enables matching to addresses interpolated on street segments or to point data locations.

You can use FIND_NEAREST_ADDRESS and FIND_NEAREST_INTERSECTION together to specify reverse geocoding to both addresses and intersections.

Set the reverse geocoding processing find properties: FIND_NEAREST_ADDRESS, FIND_NEAREST_INTERSECTION, and/or FIND_NEAREST_UNRANGED. Default = false.
Note: Supported only in reverse geocoding.
FIND_NEAREST_INTERSECTION When set to true, enables matching to intersections.

You can use FIND_NEAREST_INTERSECTION and FIND_NEAREST_ADDRESS together to specify reverse geocoding to both addresses and intersections.

Set the reverse geocoding processing find properties: FIND_NEAREST_ADDRESS, FIND_NEAREST_INTERSECTION, and/or FIND_NEAREST_UNRANGED. Default = false.

Note: Supported only in reverse geocoding.
FIND_NEAREST_UNRANGED When set to true, enables matching a street segment with no number ranges.

Enabled with FIND_NEAREST_ADDRESS. Ignored for point data and intersection matches.

Note: Supported only in reverse geocoding.
FIND_PREFER_POBOX When set to true, if both a street address and a PO Box are provided in the input address, the PO Box is used for matching. Default = false.
If both FIND_PREFER_POBOX and FIND_PREFER_STREET are set to true, then they are ignored, and the default, FIND_PREFER_STREET is used.
Note: Supported only in forward geocoding.
Note: Ignored in CASS match mode.
FIND_PREFER_STREET When set to true, if both a street address and a PO Box are provided in the input address, the street address is used for matching. Default = false.
If both FIND_PREFER_POBOX and FIND_PREFER_STREET are set to true, the default, FIND_PREFER_STREET is used.
Note: Supported only in forward geocoding.
Note: Ignored in CASS match mode.
FIND_PREFER_ZIP_OVER_CITY When set to true, prefers candidates matching the input ZIP Code over matches to the input city. Default = false.
Note: Supported only in forward geocoding.
Note: Ignored in CASS and Interactive match modes. Interactive match mode attempts to return the best address regardless of this setting.
FIND_SEARCH_AREA This option assists in finding a match when the input address contains limited or inaccurate city or ZIP Code information. One of the following options:
0
Searches the specified city.
1
Searches the entire Finance Area for possible streets. Note: This option has no effect when performing a ZIP centroid match.
2
Allows the setting of an expanded search area. When selected, you can use two other options to set how far to expand the search: FIND_EXPANDED_SEARCH_RADIUS and FIND_EXPND_SRCH_LIM_TO_STATE.
Note: Ignored in CASS match mode.
FIND_SEARCH_DIST When FIND_APPROXIMATE_PBKEY is enabled, this parameter sets the distance to use when searching for the nearest address record with an associated pbKey™ unique identifier. The allowable range is 0-5280 feet. Default = 150 feet.
Note: Supported only in forward geocoding.
FIND_STREET_CENTROID When set to true, enables street locator geocoding. When enabled, if an input street address cannot be found using the street number and name, then the input ZIP Code or city/state is searched for the closest match. If the street is located, a geocode is returned along the matched street segment rather than the geocode for the entered ZIP Code or ZIP + 4.

When using street locator geocoding, if no exact matching house number is found, a match code of either E029 (no matching range, single street segment found), or E030 (no matching range, multiple street segment) is returned.

Default = false.
Note: Supported only in forward geocoding.
Note: Ignored in CASS match mode.
FIND_SUITELINK When set to true, enables SuiteLink lookup. Default = false.
Note: Supported only in forward geocoding.
Note: Ignored in Exact match mode.
FIND_Z_CODE When set to true, attempts to find any ZIP centroid match. Default = true.
Note: Supported only in forward geocoding.
FIND_Z5_CODE When set to true, attempts to find a ZIP centroid match (no ZIP + 4 or ZIP+2). Default = false.
Note: Supported only in forward geocoding.
FIND_Z7_CODE When set to true, attempts to find a ZIP+2 centroid match only (no ZIP+4 or ZIP). Default = false.
Note: Supported only in forward geocoding.
FIND_Z9_CODE When set to true, attempts to find a ZIP+4 centroid match only. Default = false.
Note: Supported only in forward geocoding.
RETURN_LAT_LON_AS_INTEGER_VALUE When set to true, returns the LAT and LON custom fields as integer values in millionths of degrees. Default = false, returns the LAT and LON custom fields as decimal values.
Note: Supported only in forward geocoding.

Custom Output Fields

This section lists the unique output fields for USA. Unless otherwise noted, these fields can be returned for both forward and reverse geocoding.

The following categories of output fields are defined:

Quality Descriptors Output Fields

The Quality Descriptors output fields provide information about the results of the matching and geocoding processes.

Field Name Description
CONFIDENCE The Confidence value for USA candidates is available as a custom output field on the candidate. The key is “CONFIDENCE”.
LOC_CODE Location codes indicate the accuracy of the assigned geocode. For descriptions of location codes, see Address Location Codes in the appendix.
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 Match Codes in the appendix.
POSTAL_FALLBACK USA fallback candidates returns the correct MatchCode and LocationCode indicating a postal fallback, rather than codes indicating a postal level geocode.
MM_RESULT_CODE The MapMarker result code for this candidate. See result codes in Global Result Codes in the appendix.

Parsed Address Output Fields

The Parsed Address output fields provide the components of a matched address which have been parsed and standardized by the geocoder.

Field Name Description
ADDRLINE The address line for single line input addresses.
CITY The abbreviated city name from the last line of the input or output address; the value from NAME_CITY or PREF_CITY.
COUNTY_NAME The county name.
FIRM_NAME The name of firm from the USPS data or the input firm name. Not applicable to street intersection matches.
HOUSE_NUMBER The house number of input or output address. Not applicable to street intersection matches.
LAST_LINE The complete last line of the address.
MAINADDRLINE The complete first line of the address.
NAME The street name.
NAME_CITY The city name for the matched address from the City-State record.
PREF_CITY The preferred city name for the output ZIP Code of the matched address.
STATE The state abbreviation.
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.
ZIP 5-digit ZIP Code. Not applicable to street intersection matches.
ZIP4 4-digit ZIP Code extension.
ZIP9 9-digit ZIP Code (ZIP + 4).
ZIP10 10-digit ZIP Code (ZIP + 4) with dash separator.

Point Output Fields

The Point output fields provide additional information about the geocode resulting from a match using point-level data.

Note: Except where noted, supported only in forward geocoding.
Field Name Description
APN_ID The Assessor's Parcel Number Identifier. Not applicable to street intersection matches.
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.
PARCEN_ELEVATION The elevation of the geocode at the parcel centroid. Not applicable to street intersection matches.
PB_KEY A unique address identifier that is returned when an address match is made using the Master Location Dataset. The pbKey™ unique identifier 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.
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.

Centerline Output Fields

Centerline matching is used with point-level matching to tie a point-level geocode with its parent street segment. This type of match provides you with additional data about the parent street segment that is not available with only a point-level match. The output information also includes the bearing and distance from the point data geocode to the centerline match.

Note: Supported only in forward geocoding.
Field Name Description
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.
0
USPS
1
TIGER
2
TomTom Streets geocoding dataset
6
NAVTEQ 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
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-level 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.

Intersection Output Fields

The Intersection output fields provide data about the second segment in an intersection match.

Field Name Description
BLOCK_LEFT2 For intersection matches, the Census block ID from the left side of the street for the second segment in an intersection.
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_LEFT2 For intersection matches, the current left block suffix for Census 2010 geography for the second segment in the intersection.
BLOCK_SFX_RIGHT2 For intersection matches, the current right block suffix for Census 2010 geography for the second segment in the intersection.
CBSA_DIVISION_NAME2 For intersection matches, the Core Based Statistical Area (CBSA) division name for the second segment in the intersection.
CBSA_DIVISION_NUMBER2 For intersection matches, the Core Based Statistical Area (CBSA) division number for the second segment in the intersection.
CBSA_NAME2 For intersection matches, the name of the Core Based Statistical Area (CBSA) for the second segment in the intersection.
CBSA_NUMBER2 For intersection matches, the Core Based Statistical Area (CBSA) number for the second segment in the intersection.
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.
CSA_NAME2 For intersections matches, the Combined Statistical Area (CSA) name for the second segment in the intersection.
CSA_NUMBER2 For intersection matches, the Combined Statistical Area (CSA) number for the second segment in the intersection.
DATATYPE2 For intersection matches, the type of data used to make the match for the second segment in the intersection.
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
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).
NAME2 For intersection matches, the street name for the second segment of the intersection.
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.
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.
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_HIRANGE2 For intersection matches, provides the high house number of the second segment in the intersection.
SEG_LORANGE2 For intersection matches, provides the low house number of the second segment in the intersection.
SEGMENT_DIRECTION2 For intersection matches, gives the direction of the second segment in the intersection:
F
Numbers are forward.
R
Numbers are reversed.
SEGMENT_ID2 For intersection matches, the Segment ID (TLID) or unique ID from premium data vendors for the second segment in the intersection.
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
TYPE2 For intersection matches, the street type for the second segment in the intersection.

Census Output Fields

Census output fields contain U.S. Census information about the address.

Field Name Description
BLOCK 15-digit census block ID/census FIPS code, using the syntax sscccttttttgbbb where:
  • ss—2-digit State FIPS Code
  • ccc—3-digit County FIPS Code
  • tttttt—6-digit Census Tract FIPS Code (without period)
  • g—Single-digit Block FIPS Code
  • bbb—Block FIPS Code
Not applicable to street intersection matches.
COUNTY The county FIPS code.
STATE_FIPS The state FIPS code.

Postal Output Fields

The Postal output fields contain detailed postal information for the address.

Note: Supported only in forward geocoding.
Field Name Description
ALT_FLAG Alternate/base record indicator:
A
Alternate
B
Base
CART Carrier route ID. Not applicable to street intersection matches.
CHECK_DIGIT A one-digit code at the end of a mailing label barcode.
CTYST_KEY USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product).
DFLT Indicates the return status of HI_RISE_DFLT or R_RTE_DFLT:
Y
Either HI_RISE_DFLT and R_RTE_DFLT returned Y.
Blank
Both HI_RISE_DFLT and R_RTE_DFLT returned N or Blank.
DPBC Delivery Point Barcode.
EWS_MATCH 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.
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.
HI_RISE_DFLT Indicates if the match was made to a highrise.
N
Matched to an exact highrise record or a street record.
Y
Did not match to an exact record. Matched to the USPS default highrise record or a street record. Check the input address for accuracy and completeness.
Blank
Does not apply to the input address (for example, PO Boxes and General Delivery addresses) or did not find a match.
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.
A
Ascending
D
Descending
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.
MAIL_STOP Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION.
PMB_DESIGNATOR PMB designator.
PMB_NUMBER PMB number.
R_RTE_DFLT Match indicator for rural routes.
N
Matched to an exact rural route record.
Y
Did not find an exact record. Matched to the USPS default rural route record. Check the input address for accuracy and completeness.
Blank
Does not apply to the input address (for example, street addresses, P.O. Boxes, and General Delivery addresses) or no match found.
URB_NAME The urbanization name for Puerto Rico.
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

DPV Output Fields

DPV data output fields contain information about a match made using DPV data.

Note: Supported only in forward geocoding.
Field 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 (HI_RISE_DFLT = Y, secondary did not confirm.
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).

Residential Delivery Indicator (RDI) Output Fields

The Residential Delivery Indicator (RDI™) is a United States Postal Service (USPS®) data product that identifies whether a delivery type is classified as residential or business. If you are shipping to residences, you may lower costs by shipping with the Postal Service™ and avoid residential delivery surcharges typically charged by other shipping companies.

Note: To use RDI, Delivery Point Validation (DPV) must also be enabled and a US Streets dataset loaded.

Field Name Description
RDIRetCode

USPS Residential Delivery Indicator (RDI) return codes:

• Y = Residence

• N = Business

• Blank = Not processed through RDI.

LACSLink Output Fields

LACSLink data output fields contain information about a match made using the LACSLink dataset.

Note: Supported only in forward geocoding.
Field Name Description
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.

SuiteLink Output Fields

The SuiteLink output fields contain information about a match made using the SuiteLink dataset.

Note: Supported only in forward geocoding.
Field Name Description
SUITELINK_RET_CODE
A
SuiteLink record match.
00
No SuiteLink match.
Blank
This address was not processed through SuiteLink.

Short Address Output Fields

The short address output fields contain abbreviated elements of the matched address.

Note: Supported only in forward geocoding.
Field Name Description
ADDRLINE_SHORT Shortest possible address line that can be constructed from available short street name and other address line components.
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.
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
NAME_SHORT The short street name used to construct the short address line.

All attempts are made to abbreviate this name according to the process specified by the USPS in the 30 Character Abbreviation - Cycle M Flow Chart. If an abbreviated address cannot be constructed that is 30 characters or less, this field then contains the same street name value as the NAME field return.
POSTDIR_SHORT Postdir from the ADDRLINE_SHORT field.
PREDIR_SHORT Predir from the ADDRLINE_SHORT field.
TYPE_SHORT Street type from the ADDRLINE_SHORT field.

Segment Output Fields

Segment output fields contain information on the street segment identified by the data provider.

Field Name Description
BLOCK_LEFT Census block ID from the left side of the street. Not applicable to street intersection matches.
BLOCK_RIGHT Census block ID from the right side of the street. Not applicable to street intersection matches.
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_RIGHT The current right block suffix for Census 2010 geography. This field will be blank if the matched record is from point-level data.
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.
HIRANGE House number at the high end of the range. Not applicable to street intersection matches.
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.
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)
LORANGE House number at the low end of the range. Not applicable to street intersection matches.
LOUNIT Low unit number. Not applicable to street intersection matches.
LOZIP4 Low ZIP+4 for this range. Not applicable to street intersection matches.
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.
POSTDIR Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.
PREDIR Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.
QCITY State, city, or finance numbers.
RANGE_PARITY Indicates the parity of the house number in the range:
E
Even
O
Odd
B
Both
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.
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.
SEG_HIRANGE Provides the high house number in the segment.
SEG_LORANGE Provides the low house number in the segment.
SEGMENT_DIRECTION Gives the direction of the segment:
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_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
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).
TYPE Street type.

Other Output Fields

The Other output fields contain additional information about the match.

Field Name Description
AUX_USERDATA User data from an auxiliary file. Blank if no auxiliary file.
CBSA_DIVISION_NAME Core Based Statistical Area (CBSA) division name.
CBSA_DIVISION_NUMBER Core Based Statistical Area (CBSA) division number.
CBSA_NAME The name of the Core Based Statistical Area (CBSA) in which the address is located.

A CBSA is a collective term that refers to both metropolitan and micropolitan areas. A metropolitan area has a population of more than 50,000, and a micropolitan area has a population between 10,000 and 49,999. For more information, see Metropolitan and Micropolitan Statistical Areas section of the U.S. Census Bureau website:http://www.census.gov/population/www/metroareas/metroarea.html
CBSA_NUMBER Core Based Statistical Area (CBSA) number.
CSA_NAME Combined Statistical Area (CSA) name.
CSA_NUMBER Combined Statistical Area (CSA) number.
LAT The latitude of the address.
LON The longitude of the address.
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.
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).
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.
RESOLVED_LINE Indicates which line in a 2-line address was used to resolve the address.