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:

To include one or more of these categories in the output:

  • In Management Console: Use the Country Filter dropdown menu and select United States. Then, on the Return Values tab, select the desired output category checkboxes.

To return all category output fields:

  • In Management Console: Use the Country Filter dropdown menu and select United States. Then, on the Return Values tab, select the Return all available information checkbox.

Quality Descriptors Output Fields

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

Field Name Description
MatchCode 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.
LocationCode Location codes indicate the accuracy of the assigned geocode. For descriptions of location codes, see Address Location Codes in the appendix.
MMResultCode 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
ParsedAddressLine The address line for single line input addresses.
ParsedCity The abbreviated city name from the last line of the input or output address; the value from ParsedCityName or ParsedPreferredCity.
ParsedCountyName The county name.
ParsedFirmName The name of firm from the USPS data or the input firm name. Not applicable to street intersection matches.
ParsedHouseNumber The house number of input or output address. Not applicable to street intersection matches.
ParsedLastLine The complete last line of the address.
ParsedMainAddress The complete first line of the address.
Parsed Name The street name.
ParsedCityName The city name for the matched address from the City-State record.
ParsedPreferredCity The preferred city name for the output ZIP Code of the matched address.
ParsedState The state abbreviation.
ParsedUnitNumber The unit number. Not applicable to street intersection matches.
ParsedUnitType The unit type (APT, STE, etc.). Not applicable to street intersection matches.
ParsedZip 5-digit ZIP Code. Not applicable to street intersection matches.
ParsedZip4 4-digit ZIP Code extension.
ParsedZip9 9-digit ZIP Code (ZIP + 4).
ParsedZip10 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.
NearestDistance 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.
PBKey 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.
Note: To return this field, select the Return all available information checkbox.
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
CenterlineBearing 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.
CenterlineLeftBlock For centerline candidates, the Census block ID from the left side of the street. Not applicable to street intersection matches.
CenterlineRightBlock For centerline candidates, the Census block ID from the right side of the street. Not applicable to street intersection matches.
CenterlineLeftSFXBlock 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.
CenterlineRightSFXBlock 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.
CenterLineDatatype 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
NAVTEQ Points geocoding dataset
12
Master Location Data
CenterlineIsAlias

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)
CenterLineLatitide For centerline candidates, the latitude in millionths.
CenterLineLongitude For centerline candidates, the longitude in millionths.
CenterlineName For centerline candidates, the primary street name.
CenterlineNearestDistance For centerline candidates, gives the distance, in feet, from the point-level match to the centerline match.
CenterlinePostDirectional For centerline candidates, the street postfix directional. Can be blank, N, S, E, W, NE, NW, SW, or SE.
CenterlinePreDirectional for centerline candidates, the street prefix directional. Can be blank, N, S, E, W, NE, NW, SW, or SE.
CenterlineQCity For centerline candidates, the state, city, or finance numbers.
CenterlineRoadClass 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
CenterlineSegmentHiRange For centerline candidates, provides the high house number in the segment.
CenterlineSegmentLoRange For centerline candidates, provides the low house number in the segment.
CenterlineSegmentDirection For centerline candidates, gives the direction of the segment:
F
Numbers are forward.
R
Numbers are reversed.
CenterlineSegmentID For centerline candidates, the unique segment ID from data vendors.
CenterlineSegmentParity 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
CenterlineType 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
BlockLeft2 For intersection matches, the Census block ID from the left side of the street for the second segment in an intersection.
BlockRight2 For intersection matches, the Census block ID from the right side of the street for the second segment in the intersection.
BlockSFXLeft2 For intersection matches, the current left block suffix for Census 2010 geography for the second segment in the intersection.
BlockSFXRight2 For intersection matches, the current right block suffix for Census 2010 geography for the second segment in the intersection.
CBSADivisionName2 For intersection matches, the Core Based Statistical Area (CBSA) division name for the second segment in the intersection.
CBSADivisionNumber2 For intersection matches, the Core Based Statistical Area (CBSA) division number for the second segment in the intersection.
CBSAName2 For intersection matches, the name of the Core Based Statistical Area (CBSA) for the second segment in the intersection.
CBSANumber2 For intersection matches, the Core Based Statistical Area (CBSA) number for the second segment in the intersection.
CountyName2 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.
CSAName2 For intersections matches, the Combined Statistical Area (CSA) name for the second segment in the intersection.
CSANumber2 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
NAVTEQ Streets geocoding dataset
7
TomTom Points geocoding dataset
8
Centrus Points geocoding dataset
9
Auxiliary file
10
User Dictionary
11
NAVTEQ Points geocoding dataset
12
Master Location Data
MetroFlag2 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.
PostDirectional2 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.
PreDirectional2 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.
RoadClass2 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
SegHiRange2 For intersection matches, provides the high house number of the second segment in the intersection.
SegLoRange2 For intersection matches, provides the low house number of the second segment in the intersection.
SegmentDirection2 For intersection matches, gives the direction of the second segment in the intersection:
F
Numbers are forward.
R
Numbers are reversed.
SegmentID2 For intersection matches, the Segment ID (TLID) or unique ID from premium data vendors for the second segment in the intersection.
SegmentParity2 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.
StateFIPS 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
AltFlag Alternate/base record indicator:
A
Alternate
B
Base
CART Carrier route ID. Not applicable to street intersection matches.
CheckDigit The check digit.
CountyStateKey USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product).
DFLT Indicates the return status of Highrise DFLT and Rural Routes:
Y
Either Highrise DFLT and Rural Routes returned Y.
Blank
Both Highrise DFLT and Rural Routes returned N or Blank.
DPBCCode Delivery Point Barcode.
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.
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 onl
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.
HighriseDFLT 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.
LotCode 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
LotNumber 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.
MailStop Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION.
PMBDesignator PMB designator.
PMBNumber PMB number.
RuralRoutes 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.
URBName The urbanization name for Puerto Rico.
ZipCarrtSort 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.
ZipClass 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.)
ZipFacility 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
DPVCMRA Delivery Point Validation CMRA indicator.
Y
Address found in CMRA table.
N
Address not found in CMRA table.
Blank
DPV not loaded.
DPVConfirm 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_DLT = Y, secondary did not confirm.
Blank
Non-matched input address to USPS ZIP+4 data, or DPV data not loaded.
DPVFalsePOS DPV false-positive indicator.
Y
False-positive match found.
Blank
False-positive match not found.
DPVFootNote1 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.
DPVFootNote2 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.
DPVFootNote3 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.
DPVNoSTAT
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.
DPVShutdown
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.
DPVVacant
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).

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
LACSLinkFlag Indicates if the address is marked for conversion.
L
Address marked for LACS conversion.
Blank
Address not marked for LACS conversion.
LACSLinkIND 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.
LACSLinkRetCode 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.
LACSLinkShutdown
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
ShortAddressline Shortest possible address line that can be constructed from available short street name and other address line components.
ShortCityName 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.
ShortLastline 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
ShortStreetName 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.
ShortPostDirectional Postdir from the ADDRLINE_SHORT field.
ShortPreDirectional Predir from the ADDRLINE_SHORT field.
ShortStreetType 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
LeftBlockID Census block ID from the left side of the street. Not applicable to street intersection matches.
RightBlockID Census block ID from the right side of the street. Not applicable to street intersection matches.
LeftSFXBlock The current left block suffix for Census 2010 geography. This field will be blank if the matched record is from point-level data.
RightSFXBlock 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
NAVTEQ Streets geocoding dataset
7
TomTom Points geocoding dataset
8
Centrus Points geocoding dataset
9
Auxiliary file
10
User Dictionary
11
NAVTEQ Points geocoding dataset
12
Master Location Data
DataTypeName The source data vendor for the candidate match.
HiRange House number at the high end of the range. Not applicable to street intersection matches.
HighUnit 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.
IsStreetAlias 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)
LoRange House number at the low end of the range. Not applicable to street intersection matches.
LowUnit Low unit number. Not applicable to street intersection matches.
LoZip4 Low ZIP+4 for this range. Not applicable to street intersection matches.
NearestDistance Gives the distance, in feet, from the input location to the matched street segment, point address, or intersection.
Note: For reverse geocoding only.
StreetPostDirectional Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.
StreetPreDirectional Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.
QCity State, city, or finance numbers.
RangeParity Indicates the parity of the house number in the range:
E
Even
O
Odd
B
Both
RecType 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.
RoadClass 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.
SegmentHighRange Provides the high house number in the segment.
SegmentLowRange Provides the low house number in the segment.
SegmentDirection Gives the direction of the segment:
F
Numbers are forward.
R
Numbers are reversed.
SegmentID Segment ID (TLID) or unique ID from premium data vendors. Not applicable to street intersection matches.
SegmentParity 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
StreetSide 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).
ThoroughfareType Street type.

Other Output Fields

The Other output fields contain additional information about the match.

Field Name Description
AUXUserData User data from an auxiliary file. Blank if no auxiliary file.
CBSADivisionName Core Based Statistical Area (CBSA) division name.
CBSADivisionNumber Core Based Statistical Area (CBSA) division number.
CBSAName 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
CBSANumber Core Based Statistical Area (CBSA) number.
CSAName Combined Statistical Area (CSA) name.
CSANumber Combined Statistical Area (CSA) number.
LAT The latitude of the address.
LON The longitude of the address.
MatchedDB Index of geocoding dataset for matched record.
MCDName Minor Civil Division name from the auxiliary file. Blank if no auxiliary file match.
MCDNumber Minor Civil Division number from the auxiliary file. Blank if no auxiliary file match.
MetroFlag 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).
ResolvedLine Indicates which line in a 2-line address was used to resolve the address.