Output Fields - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102
A request to the Geocode service returns a GeocodeServiceResponse object that contains:
  • totalPossibleCandidates— the total number of possible candidates.
  • totalMatches— the total number of matches.
  • candidates — lists one or more candidates that matched to your input address/addresses. Matching and location information is returned for each match candidate.
  • new customValues —custom value returns.

This table describes the possible return fields available for the Geocoding Service. Not every field will be returned with a match candidate.

Field Type Description
totalPossibleCandidates Integer Indicates the total number of possible candidates.
totalMatches Integer Indicates the total number of matches.
candidates object of type Candidate, consisting of an array with one or more match candidates and associated addresses, matching and location information. Contains the following elements:
precisionLevel Integer A code describing the precision of the geocode. One of the following:

0 No coordinate information is available for this candidate address. USA addresses return 0.

1 Interpolated street address.
2 Street segment midpoint.

3 Postal code 1 centroid.

4 Partial postal code 2 centroid.

5 Postal code 2 centroid.

6 Intersection.

7 Point of interest. (If database contains POI data.)

8  State/province centroid.

9  County centroid.

10 City centroid.

11  Locality centroid.

12-15 Reserved for unspecified custom items.

16  The result is an address point.

17 The result was generated by using address point data to modify the candidate's segment data.

18 The result is an address point that was projected using the centerline offset feature. You must have both a point and a street range database to use the centerline offset feature.
19 Inside a buildling structure.

formattedStreetAddress String

The formatted main address line.

formattedLocationAddress String The formatted last address line.
identifier String An ID generated from the underlying source reference data of an address.
precisionCode String A code describing the precision of the geocode.
matching object of type FieldsMatching, consisting of an array with one or more match candidates. Contains the following elements:
matchOnAddressNumber Boolean Indicates if the input address number matched the candidate's address number.
true
The input address number matched the candidate's address number.
False
The input address number did not match the candidate's address number.
matchOnPostCode1 Boolean Indicates if the input postCode1 field matched the candidate's postCode1 field.
true
The input postCode1 matched the candidate's postCode1.
False
The input postCode1 did not match the candidate's postCode1.
matchOnPostCode2 Boolean Indicates if the input postCode2 field (post code extension) matched the candidate's postCode2 field.
true
The input postCode2 matched the candidate's postCode2.
False
The input postCode2 did not match candidate's postCode2.
matchOnAreaName1 Boolean Indicates if the input areaName1 field matched the candidate's areaName1 field.
true
The input areaName1 matched the candidate's areaName1.
False
The input areaName1 did not match the candidate's areaName1.
matchOnAreaName2 Boolean Indicates if the input areaName2 field matched the candidate's areaName2 field.
true
The input areaName2 matched the candidate's areaName2.
False
The input areaName2 did not match the candidate's areaName2.
matchOnAreaName3 Boolean Indicates if the input areaName3 field matched the candidate's areaName3 field.
true
The input areaName3 matched the candidate's areaName3.
False
The input areaName3 did not match the candidate's areaName3.
matchOnAreaName4 Boolean Indicates if the input areaName4 field matched the candidate's areaName4 field.
true
The input areaName4 matched the candidate's areaName4.
False
The input areaName4 did not match the candidate's areaName4.
matchOnStreetName Boolean Indicates if the input street name matched the candidate's street name.
true
The input street name matched the candidate's street name.
False
The input street name did not match the candidate's street name.
matchOnStreetType Boolean Indicates if the input street type matched the candidate's street type.
true
The input street type matched the candidate's street type.
False
The input street type did not match the candidate's street type.
matchOnStreetDirectional Boolean Indicates if the input street directional matched the candidate's street directional.
true
The input street directional matched the candidate's street directional.
False
The input street directional did not match the candidate's street directional.
matchOnPlaceName Boolean Indicates if the input place name matched the candidate's place name.
true
The input place name matched the candidate's place name.
False
The input place name did not match the candidate's place name.
geometry object. Returned geocode consisting of the following elements:
coordinates Double The candidate's geocode, specified as x (longitude) and y (latitiude) coordinates separated by a comma.
type String Geometry type. The return value is always Point.
crs object. Returned coordinate reference system consisting of the following elements:
properties String The coordinate reference system (CRS) used for the candidate's geocode, in epsg:nnnn format. Default is epsg:4326.
type String CRS type. The return value is always Name.
address object. Returned candidate address which may contain some of the following elements:
mainAddressLine String Candidate address line.
addressLastLine String Candidate last address line.
placeName String Firm, company, organization, business or building name.
areaName1 String State, province or region.
areaName2 String County or district.
areaName3 String City, town or suburb.
areaName4 String Locality
postCode1 String Main postal code.
postCode2 String Secondary postal code, where one exists.
country String Name of country in Alpha-2 or Alpha-3 format, or a common name of the country, such as United States of America.
addressNumber String House or building number.
streetName String Street name.
unitType String The type of unit, such as Apt., Ste. or Bldg.
unitValue String The unit number, such as "3B".
ranges: CandidateRange object. Contains information about a candidate's ranges, consisting of the following elements:
placeName String If applicable, indicates the name of the candidate's place or building.
lowHouse String Indicates the low house number in the candidate's street range.
highHouse String Indicates the high house number in the candidate's street range.
side String Provides information on the side of street that the candidate's range is located.
LEFT
The range is on the left side of the street.
RIGHT
The range is on the right side of the street.
BOTH
The range is on both the left and right side of the street.
UNKNOWN
No information is available on the side of the street this range is located.
customValues Map A map of local values associated with the candidate's range.
units: CandidateRangeUnit object. Contains information about a candidate range's units, consisting of the following elements:
placeName String If applicable, indicates the name of the candidate's place or building.
unitType String Indicates the unit type (APT, STE, etc.).
highUnitValue String Indicates the high unit number for this range unit.
lowUnitValue String Indicates the low unit number for this range unit.
customValues Map A map of local values associated with the unit.
Confidence Integer The Confidence value for USA candidates is available as a custom output field on the candidate. The key is “CONFIDENCE”.
MatchScore Integer MatchScore is a number from 0-100 that indicates how much the input was changed in order to match to the output candidate. It currently looks at certain fields including the house and unit numbers, street name, directional, and type, as well as postcode and area name fields. A score of 100 means that all the input fields checked exactly matched the output candidate. It is available for all countries, and the calculation is consistent from one country to another. Note: The Output data (in italics) determines how the penalty is based. See the examples below:

MatchScore Full Example-USA: 187 S Allan Rd #1B, Albny, NY -> 187 S Allen St APT 1B, Albany, NY 12208

Match score = 72
Fields Place Name House Num Street Dir Street Name Street Type Unit Num Locality AN4 City AN3 State AN1 PC1 Country
Input - 187 S Allan Rd 1 - Albny NY - USA
Output - 187 S Allen St 1 - Albany NY 12208 USA
MatchScore Full Example-Germany: Gentter 53A, 13352 Berlin->Genter Straße 53A, 13353 Berlin
Match score = 73
Fields Place Name House Num Street Dir Street Name Street Type Unit Num Locality AN4 City AN3 State AN1 PC1 Country
Input - 53A - Gentter - - - Berlin - 13352 DEU
Output - 53A - Genter Str - Wedding Berlin Berlin 13353 DEU

Custom Output Fields

Field Spectrum Stage Description
ACR Address Correct Result (ACR) code specifies exactly what data has been changed in each record. Example: "L5-P4S4A0T4R0Z4C4-100"

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

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

A Alternate

B Base

APN_ID APN ID The Assessor's Parcel Number Identifier. Not applicable to street intersection matches.
AUX_USERDATA AUXUserData User data from an auxiliary file. Blank if no auxiliary file.
BANCHI Banchi The block number.
BLOCK BlockInformation Block information.
BLOCK_LEFT LeftBlockID Census block ID from the left side of the street. Not applicable to street intersection matches.
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_RIGHT RightBlockID Census block ID from the right side of the street. Not applicable to streetintersection matches.
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_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_LEFT2 BlockSFXLeft2 For intersection matches, the current left block suffix for Census 2010 geography for the second segment in the intersection.
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.
BLOCK_SFX_RIGHT2 BlockSFXRight2 For intersection matches, the current right block suffix for Census 2010 geography for the second segment in the intersection.
CART CART Carrier route ID. Not applicable to street intersection matches.
CBSA_DIVISION_NAME CBSADivisionName Core Based Statistical Area (CBSA) division name.
CBSA_DIVISION_NAME2 CBSADivisionName2 For intersection matches, the Core Based Statistical Area (CBSA) division name for the second segment in the intersection.
CBSA_DIVISION_NUMBER CBSADivisionNumber Core Based Statistical Area (CBSA) division number.
CBSA_DIVISION_NUMBER2 CBSADivisionNumber2 For intersection matches, the Core Based Statistical Area (CBSA) division number for the second segment in the intersection.
CBSA_NAME CBSAName The name of the Core Based Statistical Area (CBSA) in which the address is located.
CBSA_NAME2 CBSAName2 For intersection matches, the name of the Core Based Statistical Area (CBSA) for the second segment in the intersection.
CBSA_NUMBER CBSANumber Core Based Statistical Area (CBSA) number.
CBSA_NUMBER2 CBSANumber2 For intersection matches, the Core Based Statistical Area (CBSA) number for the second segment in the intersection.
CENSUS_CD Census CD The Census Division (CD) in which the address is located.
CENSUS_CMA Census CMA The Census Metropolitan Area (CMA) in which the address is located.
CENSUS_CSD Census CSD The Census Subdivision (CSD) in which the address is located.
CENSUS_CT Census CT The Census Tract (CT) in which the address is located.
CENSUS_DA Census DA The Dissemination Area (DA) in which the address is located.
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:

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 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-leve 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:
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 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:
F
Numbers are forward.
R
Numbers are reversed.
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:
L
Left side of the street
R
Right side of the street
B
Both sides of the street
U
Unknown
CENTERLINE_TYPE CenterlineType For centerline candidates, provides the street type.
CHECK_DIGIT CheckDigit A one-digit code at the end of a mailing label barcode.
CHOMOKU Chomoku The city block number.
CHOOAZA Chooaza The number for a group of city blocks.
CITY ParsedCity The abbreviated city name from the last line of the input or output address the value from
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.

CITYRANK xx This option returns the city ranking from 1 (highest) to 10 (lowest). Zero (0) means that a rank was not available.
CONFIDENCE Confidence The Confidence value for USA candidates is available as a custom output field on the candidate. The key is CONFIDENCE.
COUNTY County The county FIPS code.
COUNTY_NAME ParsedCountyName The county name.
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.

CPC_BUILDING_TYPE xx

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

1
Residential building
2
Commercial building

CPC_RECORD_TYPE CPCRecordType

Canadian postal code (CPC) record type.
Note: returned only when the candidate contains a full postcode of FSA (Forward Sortation Area) + LDU (Local Delivery Unit).
<blank>
no address match was found
*
Unknown
A1
High-rise building
B1
LVR (Large Volume Receiver) street
C1
Government Street Address
D2
LVR (Large Volume Receiver) Served by Lock Box
E2
Government Served by Lock Box
F2
LVR (Large Volume Receiver) Served by General Delivery
11
Street
21
Street served by route
32
PO Box
CSA_NAME CSAName Combined Statistical Area (CSA) name.
CSA_NAME2 CSAName2 For intersections matches, the Combined Statistical Area (CSA) name for the second segment in the intersection.
CSA_NUMBER CSANumber Combined Statistical Area (CSA) number.
CSA_NUMBER2 CSANumber2 For intersection matches, the Combined Statistical Area (CSA) number for the second segment in the intersection.
CTYST_KEY CountyStateKey USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product).
DATASTOREDDATASET The country used for the data store.
DATATYPE 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 DataTypeName The source data vendor for the candidate match.
DATATYPE2 DataType2 For intersection matches, the type of data used to make the match for the second segment in the intersection.
DFLT DFLT Indicates the return status of HI_RISE_DFLTHighrise DFLT or R_RTE_DFLTRural Routes:
Y
Either HI_RISE_DFLTHighrise DFLT and R_RTE_DFLTRural Routes returned Y.
Blank
Both HI_RISE_DFLTHighrise DFLT and R_RTE_DFLTRural Routes returned N or Blank.
DPBC DPBCCode Delivery Point Barcode.
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.
DPV_FOOTNOTE3 DPVFootNote3 Information about the matched DPV records.
DPV_NO_STAT 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.
DPV_SHUTDOWN 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.
DPV_VACANT 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).
ENHANCEMENTDATASETS

The names of the enhancement datasets that have been used.

EWS_MATCH EWSMatch Indicates if an EWS match was made:
Y
Match denied because it matched to EWS data.
Blank
Input record did not match to EWS data.
EXTENDEDACR

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

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

To include this field in the output, select:

Return Values > GNAF Identifiers checkbox.

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

To include this field in the output, select:

Return Values > GNAF Identifiers checkbox.

GEOHASH GEOHASH Uses the latitude and longitude of the geocoded candidate to return a 32-bit encoded string representing an area. The more characters in the string, the more precise the location. By default, the precision level is set to the highest precision of 12 characters. If another level is needed, set the custom preference GEOHASH_LEVEL.
GO Go The house number.
GOVT_FLAG Govt Flag The government building indicator:
A
City government building
B
Federal government building
C
State government building
D
Firm only
E
City government building and firm only
F
Federal government building and firm only
G
State government building and firm only
A, B, C, E, F, and G are valid for alternate records only (ALT_FLAG=A). D is valid for both base and alternate records.
HEXAVIA_CODE French postal street ID such as "01606804"
HEXACLE_CODE French postal housenumber ID such as "83070224ZB"
HI_RISE_DFLT HighriseDFLT Indicates if the match was made to a high-rise building.
HIRANGE HiRange House number at the high end of the range. Not applicable to street intersection matches.
HISTORICALPOSTCODE Historicalpostcode When the input postal code is a historical postal code, returns the previous postal code for this address.
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.
HOUSE_NUMBER ParsedHouseNumber The house number of input or output address. Not applicable to street intersection matches.
INSEE_CODE French city official administrative ID such as "83070". Note: two codes are assigned to each French town (the Postal Code and the INSEE Code or "Code commune").
IRIS_CODE French census tract ID such as "830700102"
IS_ALIAS 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)
12
USPS Preferred Alias
13
ZIPMove match (when using us.gsz).

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

14
Expanded Centroids match (when using us_cent.gsc or bldgcent.gsc)
ISRURAL IsRural When true, indicates the candidate's address is located in a rural region (village).
JUSHO_CODE JushoCode A point ID that represents a unique address.
KEY_UFI KEYUFI New Zealand UFI. The Unique Identifier (UFI) identifies the street segment that the geocoded address belongs to. UFIs are up to 7-digit numbers, assigned by New Zealand Post, that uniquely identify each postal delivery point. The UFI is always returned if available, but you cannot use the UFI for input.
LACS_FLAG LACSLinkFlag Indicates if the address is marked for conversion.
L
Address marked for LACS conversion.
Blank
Address not marked for LACS conversion.
LACSLINK_IND 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.
LACSLINK_RETCODE 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.
LACSLINK_SHUTDOWN LACSLinkShutdown
Y
False-positive occurred and LACSLink library shutdown.
N
LACSLink library has not shutdown or not loaded.
LAST_LINE ParsedLastLine The complete last line of the address.
LASTLINE_SHORT 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
LAT LAT The latitude of the address.
LEVEL_NUMBER LevelNumber

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

Floor 2, 17 Jones Street

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

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

LEVEL_TYPE LevelType

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

Suite 3 Level 7, 17 Jones Street

In this example, Suite 3 is a unit.

LOC_CODE LocationCode Location codes indicate the accuracy of the assigned geocode. For descriptions of location codes, see Address Location Codes in the appendix.
LOCATION (Addressing API) The location metadata is an explanation of the precision level of the match. This is an evolving feature and will get more robust as we enrich our data.
LON LON The longitude of the address.
LORANGE LoRange House number at the low end of the range. Not applicable to street intersection matches.
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.
LOT_NUMBER LotNumber Lot numbers are returned for GNAF candidates because some rural addresses do not have adequate physical or house number information.
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.
OUTERMATCHSCORE A score that measures changes to each address line.
MAIL_STOP MailStop Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION.
MAINADDRLINE ParsedMainAddress The complete first line of the address.
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.
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.
MESH_BLOCK_ID MeshblockIdentifier A Meshblock is the smallest geographic unit for which statistical data is collected by the Australian Bureau of Statistics (ABS). Meshblocks usually contain a minimum of 20 to 50 households. This is about one fifth the size of a Collection District (CD). You can use the Meshblock ID to do additional attributions against your own data.
METRO_FLAG 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).
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:
Y
The address is located in a Metropolitan Statistical Area. Metropolitan areas have a population greater than 50,000.
N
The address is not located in a Metropolitan Statistical Area. It is located in a micropolitan area. Micropolitan areas have a population between 10,000 and 49,999.
Blank
Is blank (the county does not contain a CBSA).
MM_RESULT_CODE MMResultCode The MapMarker result code for this candidate. See Global Result Codes in the appendix.
MULTIPLE_AREAS_FOR_POSTCODE MULTIPLE_AREAS_FOR_POSTCODE Postal centroid candidates return a value of "true" when more than one town is contained within the postcode. The Area Name fields (city/town, state/region, etc.) will be populated when available.
NAME Parsed Name The street name.
NAME_CITY ParsedCityName The city name for the matched address from the City-State record.
NAME_SHORT ShortStreetName The short street name used to construct the short address line.
NAME2 Name2 For intersection matches, the street name for the second segment of the intersection.
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.
NZL_MESHBLOCK_ID MeshBlockID New Zealand Meshblock identifier. A Meshblock is the smallest geographic unit for which statistical data is collected by Statistics New Zealand. Meshblocks vary in size from part of a city block to large areas of rural land.
ORIGINAL_LATITUDE OriginalLatitude The original latitude value.
ORIGINAL_LONGITUDE OriginalLongitude The original longitude value.
ORIGINAL_LATITUDE OriginalLatitude The original GNAF latitude.
ORIGINAL_LONGITUDE OriginalLongitude The original GNAF longitude.
OUTERMATCHSCORE

A score that measures changes to each address line.

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 returned when an address match is made using the Master Location Dataset (MLD). It is used as a lookup key to a GeoEnrichment dataset, in order to return attribute data for the match.
Note: For forward and reverse geocoding.
Note: To return this field, select the Return all available information option.
PERCENT_GEOCODE Percentage along the street segment to the interpolated match. The range is 0.0 - 100.0. The range is always 0.0 for point data.
Note: For reverse geocoding only.
PLOT PLOT Plot number. For example, Thai address points contain plot numbers and house numbers to support the Plot/House used in Thai addresses such as "7/22 Moo 5" (house 22 on plot 7).
PMB_DESIGNATOR PMBDesignator U.S. Postal Service allows the use of "PMB" or the "#"sign as the Private mailbox (PMB) designator.
PMB_NUMBER PMBNumber Private mailbox number.
POI_CATEGORY POICategory Point of interest category. This field describes the type of POI, such as a bank, ATM, or restaurant.
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.
POSTAL_FALLBACK PostalFallback USA fallback candidates returns the correct MatchCode and LocationCode indicating a postal fallback, rather than codes indicating a postal level geocode.
POSTAL_VERIFIED YES - the postal code is valid

NO - the postal code is invalid

POSTCODE_COUNT_IN_AREA POSTCODE_COUNT_IN_AREA City/town-level candidates (match code G3) display the number of postcodes found in a town. The Postcode field will also be output when available.
POST_DIRECTIONAL StreetPostDirectional Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.
POSTDIR_SHORT ShortPostDirectional Postdir from the ADDRLINE_SHORT field.
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.
POST_THOROUGHFARE_TYPE Street type after the main address, such as "Main St".
PRE_THOROUGHFARE_TYPE Street type before the main address, such as "Via Veneto".
PRECISION_CODE

A code that describes the precision of the address match for the input address.

PRE_DIRECTIONAL StreetPreDirectional Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE.
PREDIR_SHORT ShortPreDirectional Prefix direction from the ADDRLINE_SHORT field.
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.
PREF_CITY ParsedPreferredCity The preferred city name for the output ZIP Code of the matched address.
PRIMARY_AREA_FOR_POSTCODE PRIMARY_AREA_FOR_POSTCODE If more than one town is contained within the postcode, candidates return a value of "true" if the current town is the primary town for this postcode. The area names (city/town, state/region, etc.) fields will be populated when available.
QCITY QCity State, city, or finance numbers.
R_RTE_DFLT RuralRoutes Match indicator for rural routes.
RANGE_PARITY RangeParity Indicates the parity of the house number in the range:
E
Even
O
Odd
B
Both
RDIRetCode RDIRetCode Residential Delivery Indicator identifies whether a delivery type is classified as residential or business.
Note: To use RDI, Delivery Point Validation (DPV) must also be enabled and a US Streets dataset configured.
Y
Residence
N
Business
Blank
Not processed through RDI
REC_TYPE 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.
RESOLVED_LINE ResolvedLine Indicates which line in a 2-line address was used to resolve the address.
ROAD_CLASS 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.
ROAD_CLASS2 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
SEG_HIRANGE SegmentHighRange Provides the high house number in the segment.
SEG_HIRANGE2 SegHiRange2 For intersection matches, provides the high house number of the second segment in the intersection.
SEG_LORANGE SegmentLowRange Provides the low house number in the segment.
SEG_LORANGE2 SegLoRange2 For intersection matches, provides the low house number of the second segment in the intersection.
SEGMENT_DIRECTION SegmentDirection Gives the direction of the segment:
F
Numbers are forward.
R
Numbers are reversed.
SEGMENT_DIRECTION2 SegmentDirection2 For intersection matches, gives the direction of the second segment in the intersection:
F
Numbers are forward.
R
Numbers are reversed.
SEGMENT_ID SegmentID Segment ID (TLID) or unique ID from premium data vendors. Not applicable to street intersection matches.
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_PARITY 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
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:
L
Left side of the street
R
Right side of the street
B
Both sides of the street
U
Unknown
STATE ParsedState The state abbreviation.
STATE_FIPS StateFIPS The state FIPS code.
STREET_SIDE 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).
STREET_TYPE_ABB StreetTypeAbbreviation The abbreviation for the street type, which is spelled out by default.
SUB_LOCALITY Sublocality The municipal division below locality (areaName4) level. This returns an SL result code.
SUITELINK_RET_CODE SuiteLink_Ret_Code
A
SuiteLink record match.
00
No SuiteLink match.
Blank
This address was not processed through SuiteLink.
SYNTHETIC_LDU SyntheticLDU

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

For Geocode and Reverse Geocode candidates, the SYNTHETIC_LDU is only returned for cases when it is true. Interactive candidates will return a “t” or an “f” depending on whether the candidate has a SYNTHETIC_LDU or not.
Note: Available in Canadian Master Location Data (CAN MLD CA8/ 8CA)
THOROUGHFARE_TYPE ThoroughfareType Street type.
TYPE_SHORT ShortStreetType Street type from the ADDRLINE_SHORT field.
TYPE2 Type2 For intersection matches, the street type for the second segment in the intersection.
UD_ORIGINAL_LATITUDE UDOriginalLatitude The original latitude returned from a point-based user dictionary.
UD_ORIGINAL_LONGITUDE UDOriginalLongitude The original longitude returned from a point-based user dictionary.
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.
URB_NAME URBName The urbanization name for Puerto Rico.
VALIDATION_CONFIDENCE A calculated score ranging from 0 to 100, indicating the level of confidence that the match results are correct. Confidence codes are calculated based on an algorithm that takes into account the match results for individual output fields. Output fields included in this calculation are:
Addressing API Geocoding API
country country
city areaName3
admin1 areaName1
street streetName
addressNumber addressNumber
streetPreDirectional PRE_DIRECTIONAL
streetPostDirectional POST_DIRECTIONAL
streetSuffix POST_THOROUGHFARE_TYPE
VALIDATIONDATASET The name of the validation dataset used during address validation calls.
VALIDATIONRULE Validation Rule code. This field is populated by address, geocoding and enhancement datasets. The codes are dataset-specific and provide extra information about the processing of the data.
ZIP ParsedZip 5-digit ZIP Code. Not applicable to street intersection matches.
ZIP_CARRTSORT 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.
ZIP_CLASS 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.)
ZIP_FACILITY 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
ZIP10 ParsedZip10 10-digit ZIP Code (ZIP + 4) with dash separator.
ZIP4 ParsedZip4 4-digit ZIP Code extension.
ZIP9 ParsedZip9 9-digit ZIP Code (ZIP + 4).
ORGANISATIONAL_NAME  
BUILDING_NAME  
DEPARTMENT_NAME  
SUB_BUILDING_NAME  
STAIR  
FLOOR  
BUILDING_GROUP  
BUILDING_ENTRANCE  
CLOSET_HOUSE_NUMBER