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
- Parsed Address
- Point
- Centerline
- Intersection
- Census
- Postal
- DPV
- Residential Delivery Indicator (RDI)
- LACSLink
- SuiteLink
- Short Address
- Segment
- Other
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 |
---|---|
CONFIDENCEConfidence | The Confidence value for USA candidates is available as a custom output field on the candidate. The key is “CONFIDENCE”. |
LOC_CODELocationCode | Location codes indicate the accuracy of the assigned geocode. For descriptions of location codes, see Address Location Codes in the appendix. |
MATCH_CODEMatchCode | 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_FALLBACKPostalFallback | USA fallback candidates returns the correct MatchCode and LocationCode indicating a postal fallback, rather than codes indicating a postal level geocode. |
MM_RESULT_CODEMMResultCode | 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 |
---|---|
ADDRLINEParsedAddressLine | The address line for single line input addresses. |
CITYParsedCity | The abbreviated city name from the last line of the input or output address;
the value from NAME_CITY ParsedCityName or PREF_CITY ParsedPreferredCity . |
COUNTY_NAMEParsedCountyName | The county name. |
FIRM_NAMEParsedFirmName | The name of firm from the USPS data or the input firm name. Not applicable to street intersection matches. |
HOUSE_NUMBERParsedHouseNumber | The house number of input or output address. Not applicable to street intersection matches. |
LAST_LINEParsedLastLine | The complete last line of the address. |
MAINADDRLINEParsedMainAddress | The complete first line of the address. |
NAMEParsed Name | The street name. |
NAME_CITYParsedCityName | The city name for the matched address from the City-State record. |
PREF_CITYParsedPreferredCity | The preferred city name for the output ZIP Code of the matched address. |
STATEParsedState | The state abbreviation. |
UNIT_NUMBERParsedUnitNumber | The unit number. Not applicable to street intersection matches. |
UNIT_TYPEParsedUnitType | The unit type (APT, STE, etc.). Not applicable to street intersection matches. |
ZIPParsedZip | 5-digit ZIP Code. Not applicable to street intersection matches. |
ZIP4ParsedZip4 | 4-digit ZIP Code extension. |
ZIP9ParsedZip9 | 9-digit ZIP Code (ZIP + 4). |
ZIP10ParsedZip10 | 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.
Field Name | Description |
---|---|
APN_IDAPN ID | The Assessor's Parcel Number Identifier. Not applicable to street intersection matches. |
NEAREST_DISTNearestDistance | Gives the distance, in feet, from the input
location to the matched street segment, point address, or intersection.
Note: For reverse geocoding only. |
PARCEN_ELEVATIONParcen Elevation | The elevation of the geocode at the parcel centroid. Not applicable to street intersection matches. |
PB_KEYPBKey | 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_IDPoint 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.
Field Name | Description |
---|---|
CENTERLINE_BEARINGCenterlineBearing | 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_LEFTCenterlineLeftBlock | For centerline candidates, the Census block ID from the left side of the street. Not applicable to street intersection matches. |
CENTERLINE_BLOCK_RIGHTCenterlineRightBlock | For centerline candidates, the Census block ID from the right side of the street. Not applicable to street intersection matches. |
CENTERLINE_BLOCK_SFX_LEFTCenterlineLeftSFXBlock | 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_RIGHTCenterlineRightSFXBlock | 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_DATATYPECenterLineDatatype | For centerline candidates, the data type used to make the centerline match.
|
CENTERLINE_IS_ALIASCenterlineIsAlias | Three characters indicating that a centerline match was located by an index alias. The first character:
The next 2 characters:
|
CENTERLINE_LATCenterLineLatitide | For centerline candidates, the latitude as integer value in millionths of degrees. |
CENTERLINE_LONCenterLineLongitude | For centerline candidates, the longitude as integer value in millionths of degrees. |
CENTERLINE_NAMECenterlineName | For centerline candidates, the primary street name. |
CENTERLINE_NEAREST_DISTCenterlineNearestDistance | For centerline candidates, gives the distance, in feet, from the point-level match to the centerline match. |
CENTERLINE_POSTDIRCenterlinePostDirectional | For centerline candidates, the street postfix directional. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
CENTERLINE_PREDIRCenterlinePreDirectional | For centerline candidates, the street prefix directional. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
CENTERLINE_QCITYCenterlineQCity | For centerline candidates, the state, city, or finance numbers. |
CENTERLINE_ROAD_CLASSCenterlineRoadClass | For centerline candidates, the road class code:
|
CENTERLINE_SEG_HIRANGECenterlineSegmentHiRange | For centerline candidates, provides the high house number in the segment. |
CENTERLINE_SEG_LORANGECenterlineSegmentLoRange | For centerline candidates, provides the low house number in the segment. |
CENTERLINE_SEGMENT_DIRECTIONCenterlineSegmentDirection | For centerline candidates, gives the direction of the segment:
|
CENTERLINE_SEGMENT_IDCenterlineSegmentID | For centerline candidates, the unique segment ID from data vendors. |
CENTERLINE_SEGMENT_PARITYCenterlineSegmentParity | For centerline candidates, provides the segment parity. The parity indicates
which side of the street the odd numbers in the segment are located:
|
CENTERLINE_TYPECenterlineType | 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_LEFT2BlockLeft2 | For intersection matches, the Census block ID from the left side of the street for the second segment in an intersection. |
BLOCK_RIGHT2BlockRight2 | For intersection matches, the Census block ID from the right side of the street for the second segment in the intersection. |
BLOCK_SFX_LEFT2BlockSFXLeft2 | For intersection matches, the current left block suffix for Census 2010 geography for the second segment in the intersection. |
BLOCK_SFX_RIGHT2BlockSFXRight2 | For intersection matches, the current right block suffix for Census 2010 geography for the second segment in the intersection. |
CBSA_DIVISION_NAME2CBSADivisionName2 | For intersection matches, the Core Based Statistical Area (CBSA) division name for the second segment in the intersection. |
CBSA_DIVISION_NUMBER2CBSADivisionNumber2 | For intersection matches, the Core Based Statistical Area (CBSA) division number for the second segment in the intersection. |
CBSA_NAME2CBSAName2 | For intersection matches, the name of the Core Based Statistical Area (CBSA) for the second segment in the intersection. |
CBSA_NUMBER2CBSANumber2 | For intersection matches, the Core Based Statistical Area (CBSA) number for the second segment in the intersection. |
COUNTY_NAME2CountyName2 | For intersection matches, the County name for the second segment in the intersection. |
COUNTY2County2 | For intersection matches, the county FIPS code for the second segment in the intersection. |
CSA_NAME2CSAName2 | For intersections matches, the Combined Statistical Area (CSA) name for the second segment in the intersection. |
CSA_NUMBER2CSANumber2 | For intersection matches, the Combined Statistical Area (CSA) number for the second segment in the intersection. |
DATATYPE2DataType2 | For intersection matches, the type of data used to make the match for the
second segment in the intersection.
|
METRO_FLAG2MetroFlag2 | 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:
|
NAME2Name2 | For intersection matches, the street name for the second segment of the intersection. |
POSTDIR2PostDirectional2 | 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. |
PREDIR2PreDirectional2 | 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_CLASS2RoadClass2 | For intersection matches, the road class code of the second segment in the
intersection:
|
SEG_HIRANGE2SegHiRange2 | For intersection matches, provides the high house number of the second segment in the intersection. |
SEG_LORANGE2SegLoRange2 | For intersection matches, provides the low house number of the second segment in the intersection. |
SEGMENT_DIRECTION2SegmentDirection2 | For intersection matches, gives the direction of the second segment in the
intersection:
|
SEGMENT_ID2SegmentID2 | For intersection matches, the Segment ID (TLID) or unique ID from premium data vendors for the second segment in the intersection. |
SEGMENT_PARITY2SegmentParity2 | 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:
|
TYPE2Type2 | 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 |
---|---|
BLOCKBlock | 15-digit census block ID/census FIPS code, using the syntax
sscccttttttgbbb where:
|
COUNTYCounty | The county FIPS code. |
STATE_FIPSStateFIPS | The state FIPS code. |
Postal Output Fields
The Postal output fields contain detailed postal information for the address.
Field Name | Description |
---|---|
ALT_FLAGAltFlag | Alternate/base record indicator:
|
CARTCART | Carrier route ID. Not applicable to street intersection matches. |
CHECK_DIGITCheckDigit | A one-digit code at the end of a mailing label barcode. |
CTYST_KEYCountyStateKey | USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product). |
DFLTDFLT | Indicates the return status of HI_RISE_DFLT Highrise DFLT or
R_RTE_DFLT Rural Routes :
|
DPBCDPBCCode | Delivery Point Barcode. |
EWS_MATCHEWSMatch | Indicates if an EWS match was made:
|
GOVT_FLAGGovt Flag | The government building indicator:
|
HI_RISE_DFLTHighriseDFLT | Indicates if the match was made to a highrise.
|
LOT_CODELotCode | 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_NUMLotNumber | 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_STOPMailStop | Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION. |
PMB_DESIGNATORPMBDesignator | PMB designator. |
PMB_NUMBERPMBNumber | PMB number. |
R_RTE_DFLTRuralRoutes | Match indicator for rural routes.
|
URB_NAMEURBName | The urbanization name for Puerto Rico. |
ZIP_CARRTSORTZipCarrtSort | Indicates the type of cart sort allowed:
|
ZIP_CLASSZipClass | ZIP Classification Code:
|
ZIP_FACILITYZipFacility | Returns the USPS City State Name Facility Code:
|
DPV Output Fields
DPV data output fields contain information about a match made using DPV data.
Field Name | Description |
---|---|
DPV_CMRADPVCMRA | Delivery Point Validation CMRA indicator.
|
DPV_CONFIRMDPVConfirm | Indicates if a match occurred for DPV data.
|
DPV_FALSE_POSDPVFalsePOS | DPV false-positive indicator.
|
DPV_FOOTNOTE1DPVFootNote1 | Information about the matched DPV records.
|
DPV_FOOTNOTE2DPVFootNote2 | Information about the matched DPV records.
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_FOOTNOTE3DPVFootNote3 | Information about the matched DPV records.
|
DPV_NO_STATDPVNoSTAT |
|
DPV_SHUTDOWNDPVShutdown |
|
DPV_VACANTDPVVacant |
|
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.
Field Name | Description |
---|---|
LACS_FLAGLACSLinkFlag | Indicates if the address is marked for conversion.
|
LACSLINK_INDLACSLinkIND | LACSLink indicator.
|
LACSLINK_RETCODELACSLinkRetCode | LACSLink return code.
|
LACSLINK_SHUTDOWNLACSLinkShutdown |
|
SuiteLink Output Fields
The SuiteLink output fields contain information about a match made using the SuiteLink dataset.
Field Name | Description |
---|---|
SUITELINK_RET_CODESuiteLink_Ret_Code |
|
Short Address Output Fields
The short address output fields contain abbreviated elements of the matched address.
Field Name | Description |
---|---|
ADDRLINE_SHORTShortAddressline | Shortest possible address line that can be constructed from available short street name and other address line components. |
CITY_SHORTShortCityName | 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_SHORTShortLastline | The address last line. Whenever possible, this field is 29 characters or less:
|
NAME_SHORTShortStreetName | 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 |
POSTDIR_SHORTShortPostDirectional | Postdir from the ADDRLINE_SHORT field. |
PREDIR_SHORTShortPreDirectional | Predir from the ADDRLINE_SHORT field. |
TYPE_SHORTShortStreetType | 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_LEFTLeftBlockID | Census block ID from the left side of the street. Not applicable to street intersection matches. |
BLOCK_RIGHTRightBlockID | Census block ID from the right side of the street. Not applicable to street intersection matches. |
BLOCK_SFX_LEFTLeftSFXBlock | 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_RIGHTRightSFXBlock | The current right block suffix for Census 2010 geography. This field will be blank if the matched record is from point-level data. |
DATATYPEDataType | The type of data used to make the match.
|
DATATYPE_NAMEDataTypeName | The source data vendor for the candidate match. |
HIRANGEHiRange | House number at the high end of the range. Not applicable to street intersection matches. |
HIUNITHighUnit | High unit number for the range. Not applicable to street intersection matches. |
HIZIP4HiZip4 | High ZIP+4 for the range. Not applicable to street intersection matches. |
IS_ALIASIsStreetAlias | The first character:
The next 2 characters:
|
LORANGELoRange | House number at the low end of the range. Not applicable to street intersection matches. |
LOUNITLowUnit | Low unit number. Not applicable to street intersection matches. |
LOZIP4LoZip4 | Low ZIP+4 for this range. Not applicable to street intersection matches. |
NEAREST_DISTNearestDistance | Gives the distance, in feet, from the input
location to the matched street segment, point address, or intersection.
Note: For reverse geocoding only. |
POSTDIRStreetPostDirectional | Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
PREDIRStreetPreDirectional | Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
QCITYQCity | State, city, or finance numbers. |
RANGE_PARITYRangeParity | Indicates the parity of the house number in the range:
|
REC_TYPERecType | The range record type:
|
ROAD_CLASSRoadClass | The road class code:
|
SEG_HIRANGESegmentHighRange | Provides the high house number in the segment. |
SEG_LORANGESegmentLowRange | Provides the low house number in the segment. |
SEGMENT_DIRECTIONSegmentDirection | Gives the direction of the segment:
|
SEGMENT_IDSegmentID | Segment ID (TLID) or unique ID from premium data vendors. Not applicable to street intersection matches. |
SEGMENT_PARITYSegmentParity | Provides the segment parity. The parity indicates which side of the street the
odd numbers in the segment are located:
|
STREET_SIDEStreetSide | The matched address is on the following side of the street:
|
TYPEThoroughfareType | Street type. |
Other Output Fields
The Other output fields contain additional information about the match.
Field Name | Description |
---|---|
AUX_USERDATAAUXUserData | User data from an auxiliary file. Blank if no auxiliary file. |
CBSA_DIVISION_NAMECBSADivisionName | Core Based Statistical Area (CBSA) division name. |
CBSA_DIVISION_NUMBERCBSADivisionNumber | Core Based Statistical Area (CBSA) division number. |
CBSA_NAMECBSAName | 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_NUMBERCBSANumber | Core Based Statistical Area (CBSA) number. |
CSA_NAMECSAName | Combined Statistical Area (CSA) name. |
CSA_NUMBERCSANumber | Combined Statistical Area (CSA) number. |
LATLAT | The latitude of the address. |
LONLON | The longitude of the address. |
MATCHED_DBMatchedDB | Index of geocoding dataset for matched record. |
MCD_NAMEMCDName | Minor Civil Division name from the auxiliary file. Blank if no auxiliary file match. |
MCD_NUMBERMCDNumber | Minor Civil Division number from the auxiliary file. Blank if no auxiliary file match. |
METRO_FLAGMetroFlag | 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:
|
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_LINEResolvedLine | Indicates which line in a 2-line address was used to resolve the address. |