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 |
|---|---|
| CONFIDENCE Confidence | The Confidence value for USA candidates is available as a custom output field on the candidate. The key is "CONFIDENCE". |
| LOC_CODE LocationCode | Location codes indicate the accuracy of the assigned geocode. For descriptions of location codes, see Address Location Codes in the appendix. |
| MATCH_CODE 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. |
| POSTAL_FALLBACK PostalFallback | USA fallback candidates returns the correct MatchCode and LocationCode indicating a postal fallback, rather than codes indicating a postal level geocode. |
| MM_RESULT_CODE 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 |
|---|---|
| ADDRLINE ParsedAddressLine | The address line for single line input addresses. |
| CITY ParsedCity | The abbreviated city name from the last line of the input or output address;
the value from NAME_CITYParsedCityName or PREF_CITYParsedPreferredCity. |
| COUNTY_NAME ParsedCountyName | The county name. |
| FIRM_NAME ParsedFirmName | The name of firm from the USPS data or the input firm name. Not applicable to street intersection matches. |
| HOUSE_NUMBER ParsedHouseNumber | The house number of input or output address. Not applicable to street intersection matches. |
| LAST_LINE ParsedLastLine | The complete last line of the address. |
| MAINADDRLINE ParsedMainAddress | The complete first line of the address. |
| NAME Parsed Name | The street name. |
| NAME_CITY ParsedCityName | The city name for the matched address from the City-State record. |
| PREF_CITY ParsedPreferredCity | The preferred city name for the output ZIP Code of the matched address. |
| STATE ParsedState | The state abbreviation. |
| UNIT_NUMBER ParsedUnitNumber | The unit number. Not applicable to street intersection matches. |
| UNIT_TYPE ParsedUnitType | The unit type (APT, STE, etc.). Not applicable to street intersection matches. |
| ZIP ParsedZip | 5-digit ZIP Code. Not applicable to street intersection matches. |
| ZIP4 ParsedZip4 | 4-digit ZIP Code extension. |
| ZIP9 ParsedZip9 | 9-digit ZIP Code (ZIP + 4). |
| ZIP10 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.
| Field Name | Description |
|---|---|
| APN_ID APN ID | The Assessor's Parcel Number Identifier. Not applicable to street intersection matches. |
| NEAREST_DIST 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 Parcen Elevation | The elevation of the geocode at the parcel centroid. Not applicable to street intersection matches. |
| PB_KEY 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 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.
| Field Name | Description |
|---|---|
| CENTERLINE_BEARING 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. |
| CENTERLINE_BLOCK_LEFT CenterlineLeftBlock | For centerline candidates, the Census block ID from the left side of the street. Not applicable to street intersection matches. |
| CENTERLINE_BLOCK_RIGHT CenterlineRightBlock | For centerline candidates, the Census block ID from the right side of the street. Not applicable to street intersection matches. |
| CENTERLINE_BLOCK_SFX_LEFT 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. |
| CENTERLINE_BLOCK_SFX_RIGHT 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. |
| CENTERLINE_DATATYPE CenterLineDatatype | For centerline candidates, the data type used to make the centerline match.
|
| CENTERLINE_IS_ALIAS CenterlineIsAlias |
Three characters indicating that a centerline match was located by an index alias. The first character:
The next 2 characters:
|
| CENTERLINE_LAT CenterLineLatitide | For centerline candidates, the latitude as integer value in millionths of degrees. |
| CENTERLINE_LON CenterLineLongitude | For centerline candidates, the longitude as integer value in millionths of degrees. |
| CENTERLINE_NAME CenterlineName | For centerline candidates, the primary street name. |
| CENTERLINE_NEAREST_DIST CenterlineNearestDistance | For centerline candidates, gives the distance, in feet, from the point-level match to the centerline match. |
| CENTERLINE_POSTDIR CenterlinePostDirectional | For centerline candidates, the street postfix directional. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
| CENTERLINE_PREDIR CenterlinePreDirectional | For centerline candidates, the street prefix directional. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
| CENTERLINE_QCITY CenterlineQCity | For centerline candidates, the state, city, or finance numbers. |
| CENTERLINE_ROAD_CLASS CenterlineRoadClass | For centerline candidates, the road class code:
|
| CENTERLINE_SEG_HIRANGE CenterlineSegmentHiRange | For centerline candidates, provides the high house number in the segment. |
| CENTERLINE_SEG_LORANGE CenterlineSegmentLoRange | For centerline candidates, provides the low house number in the segment. |
| CENTERLINE_SEGMENT_DIRECTION CenterlineSegmentDirection | For centerline candidates, gives the direction of the segment:
|
| CENTERLINE_SEGMENT_ID CenterlineSegmentID | For centerline candidates, the unique segment ID from data vendors. |
| CENTERLINE_SEGMENT_PARITY CenterlineSegmentParity | For centerline candidates, provides the segment parity. The parity indicates
which side of the street the odd numbers in the segment are located:
|
| CENTERLINE_TYPE 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 |
|---|---|
| BLOCK_LEFT2 BlockLeft2 | For intersection matches, the Census block ID from the left side of the street for the second segment in an intersection. |
| BLOCK_RIGHT2 BlockRight2 | For intersection matches, the Census block ID from the right side of the street for the second segment in the intersection. |
| BLOCK_SFX_LEFT2 BlockSFXLeft2 | For intersection matches, the current left block suffix for Census 2010 geography for the second segment in the intersection. |
| BLOCK_SFX_RIGHT2 BlockSFXRight2 | For intersection matches, the current right block suffix for Census 2010 geography for the second segment in the intersection. |
| CBSA_DIVISION_NAME2 CBSADivisionName2 | For intersection matches, the Core Based Statistical Area (CBSA) division name for the second segment in the intersection. |
| CBSA_DIVISION_NUMBER2 CBSADivisionNumber2 | For intersection matches, the Core Based Statistical Area (CBSA) division number for the second segment in the intersection. |
| CBSA_NAME2 CBSAName2 | For intersection matches, the name of the Core Based Statistical Area (CBSA) for the second segment in the intersection. |
| CBSA_NUMBER2 CBSANumber2 | For intersection matches, the Core Based Statistical Area (CBSA) number for the second segment in the intersection. |
| COUNTY_NAME2 CountyName2 | For intersection matches, the County name for the second segment in the intersection. |
| COUNTY2 County2 | For intersection matches, the county FIPS code for the second segment in the intersection. |
| CSA_NAME2 CSAName2 | For intersections matches, the Combined Statistical Area (CSA) name for the second segment in the intersection. |
| CSA_NUMBER2 CSANumber2 | For intersection matches, the Combined Statistical Area (CSA) number for the second segment in the intersection. |
| DATATYPE2 DataType2 | For intersection matches, the type of data used to make the match for the
second segment in the intersection.
|
| METRO_FLAG2 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:
|
| NAME2 Name2 | For intersection matches, the street name for the second segment of the intersection. |
| POSTDIR2 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. |
| PREDIR2 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. |
| ROAD_CLASS2 RoadClass2 | For intersection matches, the road class code of the second segment in the
intersection:
|
| SEG_HIRANGE2 SegHiRange2 | For intersection matches, provides the high house number of the second segment in the intersection. |
| SEG_LORANGE2 SegLoRange2 | For intersection matches, provides the low house number of the second segment in the intersection. |
| SEGMENT_DIRECTION2 SegmentDirection2 | For intersection matches, gives the direction of the second segment in the
intersection:
|
| SEGMENT_ID2 SegmentID2 | For intersection matches, the Segment ID (TLID) or unique ID from premium data vendors for the second segment in the intersection. |
| SEGMENT_PARITY2 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:
|
| TYPE2 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 Block | 15-digit census block ID/census FIPS code, using the syntax
sscccttttttgbbb where:
|
| COUNTY County | The county FIPS code. |
| STATE_FIPS StateFIPS | The state FIPS code. |
Postal Output Fields
The Postal output fields contain detailed postal information for the address.
| Field Name | Description |
|---|---|
| ALT_FLAG AltFlag | Alternate/base record indicator:
|
| CART CART | Carrier route ID. Not applicable to street intersection matches. |
| CHECK_DIGIT CheckDigit | A one-digit code at the end of a mailing label barcode. |
| CTYST_KEY CountyStateKey | USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product). |
| DFLT DFLT | Indicates the return status of HI_RISE_DFLTHighrise DFLT or
R_RTE_DFLTRural Routes:
|
| DPBC DPBCCode | Delivery Point Barcode. |
| EWS_MATCH EWSMatch | Indicates if an EWS match was made:
|
| GOVT_FLAG Govt Flag | The government building indicator:
|
| HI_RISE_DFLT HighriseDFLT | Indicates if the match was made to a highrise.
|
| LOT_CODE 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.
|
| LOT_NUM 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. |
| MAIL_STOP MailStop | Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION. |
| PMB_DESIGNATOR PMBDesignator | PMB designator. |
| PMB_NUMBER PMBNumber | PMB number. |
| R_RTE_DFLT RuralRoutes | Match indicator for rural routes.
|
| URB_NAME URBName | The urbanization name for Puerto Rico. |
| ZIP_CARRTSORT ZipCarrtSort | Indicates the type of cart sort allowed:
|
| ZIP_CLASS ZipClass | ZIP Classification Code:
|
| ZIP_FACILITY ZipFacility | 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_CMRA DPVCMRA | Delivery Point Validation CMRA indicator.
|
| DPV_CONFIRM DPVConfirm | Indicates if a match occurred for DPV data.
|
| DPV_FALSE_POS DPVFalsePOS | DPV false-positive indicator.
|
| DPV_FOOTNOTE1 DPVFootNote1 | Information about the matched DPV records.
|
| DPV_FOOTNOTE2 DPVFootNote2 | 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_FOOTNOTE3 DPVFootNote3 | Information about the matched DPV records.
|
| DPV_NO_STAT DPVNoSTAT |
|
| DPV_SHUTDOWN DPVShutdown |
|
| DPV_VACANT DPVVacant |
|
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_FLAG LACSLinkFlag | Indicates if the address is marked for conversion.
|
| LACSLINK_IND LACSLinkIND | LACSLink indicator.
|
| LACSLINK_RETCODE LACSLinkRetCode | LACSLink return code.
|
| LACSLINK_SHUTDOWN LACSLinkShutdown |
|
SuiteLink Output Fields
The SuiteLink output fields contain information about a match made using the SuiteLink dataset.
| Field Name | Description |
|---|---|
| SUITELINK_RET_CODE SuiteLink_Ret_Code |
|
Short Address Output Fields
The short address output fields contain abbreviated elements of the matched address.
| Field Name | Description |
|---|---|
| ADDRLINE_SHORT ShortAddressline | Shortest possible address line that can be constructed from available short street name and other address line components. |
| CITY_SHORT 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. |
| LASTLINE_SHORT ShortLastline | The address last line. Whenever possible, this field is 29 characters or less:
|
| NAME_SHORT 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 |
| POSTDIR_SHORT ShortPostDirectional | Postdir from the ADDRLINE_SHORT field. |
| PREDIR_SHORT ShortPreDirectional | Predir from the ADDRLINE_SHORT field. |
| TYPE_SHORT 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 |
|---|---|
| BLOCK_LEFT LeftBlockID | Census block ID from the left side of the street. Not applicable to street intersection matches. |
| BLOCK_RIGHT RightBlockID | Census block ID from the right side of the street. Not applicable to street intersection matches. |
| BLOCK_SFX_LEFT LeftSFXBlock | 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 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 DataType | The type of data used to make the match.
|
| DATATYPE_NAME DataTypeName | The source data vendor for the candidate match. |
| HIRANGE HiRange | House number at the high end of the range. Not applicable to street intersection matches. |
| HIUNIT HighUnit | High unit number for the range. Not applicable to street intersection matches. |
| HIZIP4 HiZip4 | High ZIP+4 for the range. Not applicable to street intersection matches. |
| IS_ALIAS IsStreetAlias | The first character:
The next 2 characters:
|
| LORANGE LoRange | House number at the low end of the range. Not applicable to street intersection matches. |
| LOUNIT LowUnit | Low unit number. Not applicable to street intersection matches. |
| LOZIP4 LoZip4 | Low ZIP+4 for this range. Not applicable to street intersection matches. |
| NEAREST_DIST NearestDistance | Gives the distance, in feet, from the input
location to the matched street segment, point address, or intersection.
Note: For reverse geocoding only. |
| POSTDIR StreetPostDirectional | Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
| PREDIR StreetPreDirectional | Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
| QCITY QCity | State, city, or finance numbers. |
| RANGE_PARITY RangeParity | Indicates the parity of the house number in the range:
|
| REC_TYPE RecType | The range record type:
|
| ROAD_CLASS RoadClass | The road class code:
|
| SEG_HIRANGE SegmentHighRange | Provides the high house number in the segment. |
| SEG_LORANGE SegmentLowRange | Provides the low house number in the segment. |
| SEGMENT_DIRECTION SegmentDirection | Gives the direction of the segment:
|
| SEGMENT_ID SegmentID | Segment ID (TLID) or unique ID from premium data vendors. Not applicable to street intersection matches. |
| SEGMENT_PARITY SegmentParity | Provides the segment parity. The parity indicates which side of the street the
odd numbers in the segment are located:
|
| STREET_SIDE StreetSide | The matched address is on the following side of the street:
|
| TYPE ThoroughfareType | Street type. |
Other Output Fields
The Other output fields contain additional information about the match.
| Field Name | Description |
|---|---|
| AUX_USERDATA AUXUserData | User data from an auxiliary file. Blank if no auxiliary file. |
| CBSA_DIVISION_NAME CBSADivisionName | Core Based Statistical Area (CBSA) division name. |
| CBSA_DIVISION_NUMBER CBSADivisionNumber | Core Based Statistical Area (CBSA) division number. |
| CBSA_NAME 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 |
| CBSA_NUMBER CBSANumber | Core Based Statistical Area (CBSA) number. |
| CSA_NAME CSAName | Combined Statistical Area (CSA) name. |
| CSA_NUMBER CSANumber | Combined Statistical Area (CSA) number. |
| LAT LAT | The latitude of the address. |
| LON LON | The longitude of the address. |
| MATCHED_DB MatchedDB | Index of geocoding dataset for matched record. |
| MCD_NAME MCDName | Minor Civil Division name from the auxiliary file. Blank if no auxiliary file match. |
| MCD_NUMBER MCDNumber | Minor Civil Division number from the auxiliary file. Blank if no auxiliary file match. |
| METRO_FLAG 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:
|
| 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 ResolvedLine | Indicates which line in a 2-line address was used to resolve the address. |