Address Match Results - enterprise_tax - web_services - 23.1

Spectrum Web Services Guide

Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413
The table below lists the fields returned from the address matching and geocoding process.
Note: Fields denoted by an asterisk "*" are always included in the output regardless of whether or not you choose the associated output data options (for example, census or tax jurisdiction data output options). Contents returned when available; otherwise, left blank.
columnName Field Name Response Element Max. Field Length with null terminator Description

AddressMatch.DataTypeName*

20

Indicates the file from which the match was obtained. One of the following:

  • USPS
  • TIGER
  • TOMTOM - Streets
  • NAVTEQ - Streets
  • TOMTOM_POINT
  • CENTRUS_POINT
  • NAVTEQ_POINT
  • MASTER LOCATION - Master Location Data
  • STATE_FILE
  • USER_AUXILIARY
  • LANDMARK_AUXILIARY
AddressMatch.Firm* 41 The name of the business if the address is a business address.

AddressMatch.GenRC*

2

General Return Code indicating the type of match.

5
ZIP Code match
9
ZIP+4 Code match
A
User Auxiliary file match
C
Street Centroid match
F
Geographic Fallback match
G
State-supplied file match
I
Intersection match
L
Landmark Auxiliary file match
M
Multiple match (multi-match)
O
Input Latitude/Longitude coordinates match
P
Address point match
S
Street address match
U
GeoTAX Auxiliary file match
X
Cancelled processing or expired database
Blank
Did not match
AddressMatch.Lastline* 61 The complete matched last address line (city, state, and postal code).

AddressMatch.LocationCode*

5

The Location Code indicates the methodology used to complete the geocode and may also provide some information about the quality of the geocode.

For the list of location codes, see Location Codes.

AddressMatch.MatchCode*

5

The Match Code indicates the portions of the address that matched or did not match to the reference file.

For the list of match codes, see Match Codes.

AddressMatch.NumCandidates*

2

When there are multiple equally-scored matches, returns the number of multiple match candidates found.

AddressMatch.PBKey 14 A unique address identifier that is returned when an address match is made using the Master Location Database. The pbKey™ unique identifier is used as a lookup key to a GeoEnrichment database, in order to return attribute data for the match.

The AddressMatch.PBKey field has "P" as the leading character, for example: P00001XSF1IF.

AddressMatch.Urbanization* 31 Urbanization name. Used for addresses in Puerto Rico.
AddressMatch.Zip* 6 The matched address five-digit ZIP Code.
AddressMatch.Zip4* 5 The matched address four-digit ZIP Code extension.

Census.MatchCode*

2

The level of match obtained against the databases.

5
ZIP Code level match
9
ZIP + 4 Code level match
A
User Auxiliary file match
C
Street centroid match
F
Geographic fallback match
G
State-supplied file match
I
Intersection match
L
Landmark Auxiliary file match
M
Multiple match (multi-match)
O
Input latitude/longitude coordinates match
P
Address point match
S
Street address match
U
GeoTAX Auxiliary file match
X
Cancelled processing or expired database
Blank
Did not match

Census.MatchLevel*

19

The level of match obtained against the databases.

AbortedExpiredData
Cancelled processing or expired database
Aux2
GeoTAX Auxiliary file match
Auxiliary
Auxiliary street match
FallbackGeographic
Geographic fallback match
Gov
State file address match
Intersection
Intersection match
LatLonInput
Input latitude/longitude coordinates match
LandmarkAux
Landmark Auxiliary file match
MultiMatch
Multiple match
Point
Address point match
Street
Street address match
StreetCentroid
Street centroid match
ZIP
ZIP Code level match
ZIP+4
ZIP + 4 Code level match
NoMatch
Did not match

Confidence*

4

Indicates the confidence in the output provided; from 0 to 100. The higher the score, the higher the confidence in the match. Calculated based on the match results for individual output fields, using the following algorithm:

Census.MatchCode + LatLong.StreetMatchCode + LatLong.MatchCode

The maximum confidence score is 100, so if this calculation results in a value greater than 100, the Confidence score is returned as 100.

The following values are used:

  • Census.MatchCode
    • 5 = 45
    • 9 = 75
    • A = 85
    • C = 55
    • F = 45
    • G = 85
    • I = 85
    • L = 85
    • M = 0
    • O = 85
    • P = 100
    • S = 85
    • U = 85
    • X = 0
    • null = 0
  • LatLong.StreetMatchCode
    • H = 5
    • L = 15
    • S = -10
    • Z = -5
    • null = 0
  • LatLong.MatchCode
    • 2 = 0
    • 4 = 10
    • B = 0
    • C = 0
    • I = 10
    • L = 15
    • O = 15
    • R = 15
    • S = -10
    • T = -2
    • U = 15
    • Z = -5
    • null = -100

County.Code*

4

Extracted from the Census.BlockCode.

County.Name*

26

Name of the county.

GNISCode*

10

Unique nine-digit Geographic Names Information System (GNIS) code.

Standardized input address fields - for field information, see Input Address.    

MCD.DistanceToBorder*

10

Returns the distance in feet between the matched address point to the polygon defined by the Cousub.txb file.

MCD.PointStatus*

2

An address can be compared to a Minor Civil Division (MCD)/county subdivision file (Cousub.txt). This output field returns the result for a comparison between the matched address point to the polygon defined by the Cousub.txb file.

For more information on buffers, see Buffering.

Note: The buffer distance for Cousub.txb is internally set to zero and cannot be modified.
P
The point is in the polygon.
I
The point is in the buffer area inside the polygon.
B
The point is in the buffer area and outside of the polygon.
blank
Polygon not found.

Place.Code*

6

Five-digit Federal Information Processing Standards (FIPS) place code. A "place" is a geographic area defined on the basis of population criteria that vary by state. Or, an area recognized as significant because it is located in an incorporated municipality.

Place.ClassCode*

3

Place class code. Place class codes are used to determine the proper taxing jurisdictions

Place.DistanceToBorder*

10

Returns the distance between the matched address point to the polygon defined by the Place.txb file.

Place.IncorporatedFlag*

8

Indicates whether the address is located in an incorporated or unincorporated place. A "place" is a geographic area defined on the basis of population criteria that vary by state. Or, an area recognized as significant because it is located in an incorporated municipality.

Inc
Incorporated place code.
Uninc
Unincorporated place code.
Unknown
Incorporation status unknown.

Place.LastAnnexedDate*

8

Last annexed date, in the format MM/YYYY, representing the month and year of the most recent boundary change or the most recent available boundary information.

Place.LastUpdatedDate*

8

Last updated date, in the format MM/YYYY, reflecting the month and year when TomTom updated the database to reflect attribute (name change, FIPS change, etc.) or boundary edits to the Place.

Place.LastVerifiedDate*

8

Last verified date, in the format MM/YYYY, representing the month and year that TomTom verified municipality change information.

Place.Name*

41

The name of the "place" where the address is located. A "place" is a geographic area defined on the basis of population criteria that vary by state. Or, an area recognized as significant because it is located in an incorporated municipality.

Place.PointStatus*

2

Returns the result for a comparison between the matched address point to the polygon defined by the Place.txb file.

For more information on buffers, see Buffering.

Note: The buffer distance for Place.txb is internally set to zero and cannot be modified.
P
The point is in the polygon.
I
The point is in the buffer area inside the polygon.
B
The point is in the buffer area and outside of the polygon.
blank
Polygon not found.
ProcessedBy* 4 Always returns GTX.

State.Abbreviation*

3

Two-character state abbreviation.

StateCode*

3

Two-digit Federal Information Processing Standards (FIPS) state code extracted from the Census.BlockCode.