GeoTAX HTTP Response - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

A request to the GeoTAX Service Rest endpoint returns a list of results. Not every field will be returned with a result.

Below are the Response fields returned:

Field Type Description
errorMessage String Error message: The error message returned from the service with an error code.
status Status Status of the response.
results <Result array> List of results based on the specified criteria.

GeoTAX API Response Example:

Below is a sample geotax by Address API response:
{
    "response": {
        "status": "OK",
        "results": [
            {
                "gnisCode": "002410703",
                "confidence": 100.0,
                "jurisdiction": {
                    "state": {
                        "code": "48",
                        "name": "TX"
                    },
                    "county": {
                        "code": "061",
                        "name": "CAMERON"
                    },
                    "place": {
                        "name": "HARLINGEN",
                        "code": "32372",
                        "gnisCode": "002410703",
                        "classCode": "C1",
                        "incorporatedFlag": "Inc",
                        "lastAnnexedDate": "01/2022",
                        "lastUpdatedDate": "08/2023",
                        "lastVerifiedDate": "08/2023",
                        "pointStatus": "P",
                        "distanceToBorder": "1092"
},
                    "geoTaxKeyMatchCode": " "{
                    },
                "matchedAddress": {
                    "formattedAddress": "201 N ALTAS PALMAS DR HARLINGEN, TX 78552-4616",
                    "formattedStreetAddress": "201 N ALTAS PALMAS DR",
                    "formattedLocationAddress": "HARLINGEN, TX  78552-4616",
                    "addressNumber": "201",
                    "stateName": "TX",
                    "countyName": "CAMERON",
                    "cityName": "HARLINGEN",
                    "postalCode": "78552",
                    "postalCodeExt": "4616",
                    "placeName": "HARLINGEN",
                    "street": "ALTAS PALMAS",
                    "dataTypeName": "TOMTOM STREETS",
                    "genRC": "S",
                    "locationCode": "AS0",
                    "matchCode": "S900",
                    "numCandidates": "0",
                    "houseNumber": "201",
                    "preDirectional": "N",
                    "streetType": "DR"
                },
                "census": {
                    "block": "005",
                    "blockGroup": "2",
                    "cbsa": {
                        "name": "BROWNSVILLE-HARLINGEN, TX METROPOLITAN STATISTICAL AREA",
                        "code": "15180",
                        "metroFlag": "Y"
                    },
},
                    "matchLevel": "Street",
                    "matchCode": "S",
                    "tract": "012004",
                    "mcd": {
                        "name": "HARLINGEN-SAN BENITO",
                        "code": "91720",
                        "pointStatus": "P",
                        "distanceToBorder": "29405"
                    },
                      "cbsad": {},
                      "csa": {
                      "name": "BROWNSVILLE-HARLINGEN-RAYMONDVILLE, TX COMBINED STATISTICAL AREA",
                      "code": "154"
                    }
                },
            "latLongFields": {
                "matchCode": "R",
                "matchLevel": "Rooftop",
                "geometry": {
                    "latLongAltFmt": "DecimalSign",
                    "latLongAltFmtValue": "26.185603-097.771983",
                    "type": "Point",
                    "coordinates": [
                        26.185603,
                        -97.771983
                    ]
                }
            },
            "numTaxDistrictsFound": 0,
            "numPTCsFound": 0,
            "numUserBoundariesFound": 0
                  }
            ]
     }
Below is a sample geotax by Batch Address API response:
{
  "responses": [
    {
      "status": "OK",
      "result": {
        "addressId": "1",
        "gnisCode": "002412146",
        "confidence": 100,
        "jurisdiction": {
          "state": {
            "code": "53",
            "name": "WA"
          },
          "county": {
            "code": "011",
            "name": "CLARK"
          },
          "place": {
            "name": "VANCOUVER",
            "code": "74060",
            "gnisCode": "002412146",
            "classCode": "C1",
            "incorporatedFlag": "Inc",
            "lastAnnexedDate": "12/2023",
            "lastUpdatedDate": "10/2024",
            "lastVerifiedDate": "09/2024",
            "pointStatus": "P",
            "distanceToBorder": "2984"
          },
          "geoTaxKeyMatchCode": " "
        },
        "matchedAddress": {
          "formattedAddress": "2520 COLUMBIA HOUSE BLVD STE 108 VANCOUVER, WA  98661-7762",
          "formattedStreetAddress": "2520 COLUMBIA HOUSE BLVD STE 108",
          "formattedLocationAddress": "VANCOUVER, WA  98661-7762",
          "addressNumber": "2520",
          "stateName": "WA",
          "countyName": "CLARK",
          "cityName": "VANCOUVER",
          "postalCode": "98661",
          "postalCodeExt": "7762",
          "placeName": "VANCOUVER",
          "unit": "108",
          "unitType": "STE",
          "street": "COLUMBIA HOUSE",
          "dataTypeName": "TOMTOM STREETS",
          "genRC": "S",
          "locationCode": "AS0",
          "matchCode": "S802",
          "numCandidates": "0",
          "houseNumber": "2520",
          "streetType": "BLVD"
        },
        "census": {
          "block": "005",
          "blockGroup": "1",
          "cbsa": {
            "name": "PORTLAND-VANCOUVER-HILLSBORO, OR-WA METROPOLITAN STATISTICAL AREA",
            "code": "38900",
            "metroFlag": "Y"
          },
          "matchLevel": "Street",
          "matchCode": "S",
          "tract": "042601",
          "mcd": {
            "name": "VANCOUVER",
            "code": "93600",
            "pointStatus": "P",
            "distanceToBorder": "2984"
          },
          "cbsad": {},
          "csa": {
            "name": "PORTLAND-VANCOUVER-SALEM, OR-WA COMBINED STATISTICAL AREA",
            "code": "440"
          }
        },
        "latLongFields": {
          "matchCode": "R",
          "matchLevel": "Rooftop",
          "geometry": {
            "latLongAltFmt": "DecimalSign",
            "latLongAltFmtValue": "45.618991-122.645234",
            "type": "Point",
            "coordinates": [
              45.618991,
              -122.645234
            ]
          }
        },
        "numTaxDistrictsFound": 0
      }
    },
    {
      "status": "OK",
      "result": {
        "addressId": "1",
        "gnisCode": "001267480",
        "confidence": 100,
        "jurisdiction": {
          "state": {
            "code": "46",
            "name": "SD"
          },
          "county": {
            "code": "035",
            "name": "DAVISON"
          },
          "place": {
            "name": "MITCHELL",
            "code": "43100",
            "gnisCode": "001267480",
            "classCode": "C5",
            "incorporatedFlag": "Inc",
            "lastAnnexedDate": "01/2020",
            "lastUpdatedDate": "10/2024",
            "lastVerifiedDate": "09/2023",
            "pointStatus": "P",
            "distanceToBorder": "1776"
          },
          "geoTaxKeyMatchCode": " "
        },
        "matchedAddress": {
          "formattedAddress": "2001 N MAIN ST MITCHELL, SD  57301",
          "formattedStreetAddress": "2001 N MAIN ST",
          "formattedLocationAddress": "MITCHELL, SD  57301",
          "addressNumber": "2001",
          "stateName": "SD",
          "countyName": "DAVISON",
          "cityName": "MITCHELL",
          "postalCode": "57301",
          "placeName": "MITCHELL",
          "street": "MAIN",
          "dataTypeName": "TOMTOM STREETS",
          "genRC": "S",
          "locationCode": "AS0",
          "matchCode": "TB21",
          "numCandidates": "0",
          "houseNumber": "2001",
          "preDirectional": "N",
          "streetType": "ST"
        },
        "census": {
          "block": "050",
          "blockGroup": "5",
          "cbsa": {
            "name": "MITCHELL, SD MICROPOLITAN STATISTICAL AREA",
            "code": "33580",
            "metroFlag": "N"
          },
          "matchLevel": "Street",
          "matchCode": "S",
          "tract": "962700",
          "mcd": {
            "name": "MITCHELL CITY",
            "code": "43100",
            "pointStatus": "P",
            "distanceToBorder": "1776"
          },
          "cbsad": {},
          "csa": {
            "code": "null"
          }
        },
        "latLongFields": {
          "matchCode": "R",
          "matchLevel": "Rooftop",
          "geometry": {
            "latLongAltFmt": "DecimalSign",
            "latLongAltFmtValue": "43.731783-098.025936",
            "type": "Point",
            "coordinates": [
              43.731783,
              -98.025936
            ]
          }
        },
        "numTaxDistrictsFound": 0
      }
    }
  ]
}
Below is a sample geotax by Location API response:
{
  "response": {
    "status": "OK",
    "result": {
      "objectId": "1",
      "gnisCode": "002411638",
      "confidence": 100,
      "jurisdiction": {
        "state": {
          "code": "40",
          "name": "OK"
        },
        "county": {
          "code": "031",
          "name": "Comanche"
        },
        "place": {
          "name": "Lawton",
          "code": "41850",
          "gnisCode": "002411638",
          "classCode": "C1",
          "incorporatedFlag": "Inc",
          "lastAnnexedDate": "08/2023",
          "lastUpdatedDate": "04/2024",
          "lastVerifiedDate": "03/2024",
          "pointStatus": "P",
          "distanceToBorder": "2494"
        },
        "geoTaxKeyMatchCode": " ",
        "spds": [
          {
            "districtName": "FORT SILL",
            "districtCode": "MIL",
            "districtNumber": "00001",
            "versionDate": "122019",
            "effectiveDate": "012020",
            "compiledDate": "122019",
            "updateDate": "012024",
            "boundaryBuffer": {
              "bufferRelation": {
                "value": "P"
              },
              "distanceToBorder": {
                "value": "6543"
              }
            }
          }
        ]
      },
      "matchedAddress": {
        "formattedAddress": "1216 Bob Pennell Rd Fort Sill, OK  73503-1024",
        "formattedStreetAddress": "1216 Bob Pennell Rd",
        "formattedLocationAddress": "Fort Sill, OK  73503-1024",
        "addressNumber": "1216",
        "stateName": "OK",
        "countyName": "Comanche",
        "cityName": "Fort Sill",
        "postalCode": "73503",
        "postalCodeExt": "1024",
        "placeName": "Lawton",
        "street": "Bob Pennell",
        "dataTypeName": "TOMTOM STREETS",
        "genRC": "O",
        "locationCode": "AS0",
        "matchCode": "NS0",
        "numCandidates": "0",
        "houseNumber": "1216",
        "streetType": "Rd"
      },
      "salesTax": {
        "totalTaxRate": 0.09,
        "stateTaxRate": 0.045,
        "countyTaxRate": 0.00375,
        "municipalTaxRate": 0.04125,
        "spdsTax": [
          {
            "districtNumber": "00001",
            "taxRate": 0
          }
        ]
      },
      "useTax": {
        "totalTaxRate": 0.09,
        "stateTaxRate": 0.045,
        "countyTaxRate": 0.00375,
        "municipalTaxRate": 0.04125,
        "spdsTax": [
          {
            "districtNumber": "00001",
            "taxRate": 0
          }
        ]
      },
      "census": {
        "block": "033",
        "blockGroup": "1",
        "cbsa": {
          "name": "Lawton, Ok Metropolitan Statistical Area",
          "code": "30020",
          "metroFlag": "Y"
        },
        "matchLevel": "LatLonInput",
        "matchCode": "O",
        "tract": "002405",
        "mcd": {
          "name": "Fort Sill",
          "code": "91136",
          "pointStatus": "P",
          "distanceToBorder": "6543"
        },
        "cbsad": {},
        "csa": {
          "name": "Lawton-Duncan, Ok Combined Statistical Area",
          "code": "334"
        }
      },
      "latLongFields": {
        "matchCode": "O",
        "matchLevel": "LatLonInput",
        "geometry": {
          "latLongAltFmt": "DecimalSign",
          "latLongAltFmtValue": "34.688752-098.401769",
          "type": "Point",
          "coordinates": [
            34.688752,
            -98.401769
          ]
        }
      },
      "numTaxDistrictsFound": 1
    }
  }
}
Below is a sample geotax by Batch Location API response:
{
  "responses": [
    {
      "status": "OK",
      "result": {
        "addressId": "1",
        "gnisCode": "002411638",
        "confidence": 100,
        "jurisdiction": {
          "state": {
            "code": "40",
            "name": "OK"
          },
          "county": {
            "code": "031",
            "name": "COMANCHE"
          },
          "place": {
            "name": "LAWTON",
            "code": "41850",
            "gnisCode": "002411638",
            "classCode": "C1",
            "incorporatedFlag": "Inc",
            "lastAnnexedDate": "08/2023",
            "lastUpdatedDate": "08/2024",
            "lastVerifiedDate": "07/2024",
            "pointStatus": "P",
            "distanceToBorder": "2511"
          },
          "geoTaxKeyMatchCode": " "
        },
        "matchedAddress": {
          "formattedAddress": "1259 BOB PENNELL RD FORT SILL, OK  73503-1026",
          "formattedStreetAddress": "1259 BOB PENNELL RD",
          "formattedLocationAddress": "FORT SILL, OK  73503-1026",
          "addressNumber": "1259",
          "stateName": "OK",
          "countyName": "COMANCHE",
          "cityName": "FORT SILL",
          "postalCode": "73503",
          "postalCodeExt": "1026",
          "placeName": "LAWTON",
          "street": "BOB PENNELL",
          "dataTypeName": "TOMTOM STREETS",
          "genRC": "O",
          "locationCode": "AS0",
          "matchCode": "NS0",
          "numCandidates": "0",
          "houseNumber": "1259",
          "streetType": "RD"
        },
        "census": {
          "block": "033",
          "blockGroup": "1",
          "cbsa": {
            "name": "LAWTON, OK METROPOLITAN STATISTICAL AREA",
            "code": "30020",
            "metroFlag": "Y"
          },
          "matchLevel": "LatLonInput",
          "matchCode": "O",
          "tract": "002405",
          "mcd": {
            "name": "FORT SILL",
            "code": "91136",
            "pointStatus": "P",
            "distanceToBorder": "6564"
          },
          "cbsad": {},
          "csa": {
            "name": "LAWTON-DUNCAN, OK COMBINED STATISTICAL AREA",
            "code": "334"
          }
        },
        "latLongFields": {
          "matchCode": "O",
          "matchLevel": "LatLonInput",
          "geometry": {
            "latLongAltFmt": "DecimalSign",
            "latLongAltFmtValue": "34.688706-098.401818",
            "type": "Point",
            "coordinates": [
              34.688706,
              -98.401818
            ]
          }
        },
        "numTaxDistrictsFound": 0
      }
    },
    {
      "status": "OK",
      "result": {
        "addressId": "1",
        "confidence": 100,
        "jurisdiction": {
          "state": {
            "code": "05"
          },
          "county": {
            "code": "125",
            "name": "SALINE"
          },
          "place": {
            "pointStatus": " "
          },
          "geoTaxKeyMatchCode": " "
        },
        "matchedAddress": {
          "formattedAddress": "null null",
          "countyName": "SALINE",
          "postalCode": "72122",
          "dataTypeName": "UNKNOWN",
          "genRC": "O",
          "locationCode": "Z",
          "matchCode": "Z",
          "numCandidates": "0"
        },
        "census": {
          "blockGroup": " ",
          "cbsa": {
            "metroFlag": " "
          },
          "matchLevel": "LatLonInput",
          "matchCode": "O",
          "mcd": {
            "name": "HOLLAND",
            "code": "91743",
            "pointStatus": "P",
            "distanceToBorder": "13928"
          },
          "cbsad": {},
          "csa": {
            "code": "null"
          }
        },
        "latLongFields": {
          "matchCode": "O",
          "matchLevel": "LatLonInput",
          "geometry": {
            "latLongAltFmt": "DecimalSign",
            "type": "Point",
            "coordinates": [
              -92.9036,
              34.8192
            ]
          }
        },
        "numTaxDistrictsFound": 0
      }
    }
  ]
}

Response Fields

Below table lists the response fields returned:

Feature Field Description
Address Match TaxCounty.code Extracted from the Census Block Code.
Address Match TaxCounty.name Name of the county.
Address Match TaxState.code Two-digit Federal Information Processing Standards (FIPS) state code extracted from the Census.BlockCode.
Address Match TaxState.name Two-character state abbreviation.
Address Match Result.confidence

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

Address Match Result.preciselyId 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.
Address Match MatchedAddress.genRC

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
Address Match MatchedAddress.formattedLocationAddress The complete matched last address line (city, state, and postal code).
Address Match MatchedAddress.locationCode 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.
Address Match MatchedAddress.matchCode 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.
Address Match MatchedAddress.numCandidates When there are multiple equally-scored matches, returns the number of multiple match candidates found.
Address Match MatchedAddress.dataTypeName

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
Address Match MatchedAddress.firmName The name of the business if the address is a business address.
Address Match MatchedAddress.urbanization Urbanization name. Used for addresses in Puerto Rico.
Address Match MatchedAddress.postalCode The matched address five-digit ZIP Code.
Address Match MatchedAddress.postalCodeExt The matched address four-digit ZIP Code extension.
Address Match MatchedAddress.street The name of the street, not including any directionals or suffixes. For example, the word "Main" in this address: 123 E Main St Apt 3
Address Match MatchedAddress.streetType The street type of the matched location. For example, AVE for Avenue.
Address Match MatchedAddress.houseNumber Building number for the address.
Address Match MatchedAddress.unitType The type of unit, such as apartment, suite, or lot.
Address Match MatchedAddress.unit Apartment number. For example, "APT 3" in this address, 123 E Main St APT 3
Address Match MatchedAddress.preDirectional Leading directional. For example, "E" in this address 123 E Main St Apt 3
Address Match MatchedAddress.postDirectional Street directional that follows the street name. For example, "N" in this address: 456 Washington N.
Input Address MatchedAddress.formattedStreetAddress Input address line 1.
Input Address MatchedAddress.formattedLocationAddress Input address line 2.
Input Address MatchedAddress.city Input address city.
Input Address MatchedAddress.stateName Input address state.
Input Address MatchedAddress.postalCode Input address postal code
Tax Jurisdiction geoTaxKey

The value in this field varies depending on the option you specified in the Sales tax cross-reference key option:

You can use this code in your application to find out the tax rate for the jurisdiction. The jurisdiction code formats are as follows:

  • 2-digit SUT state code, 5-digit ZIP Code, 2-digit SUT geocode
  • variable-length TWE geocode
Tax Jurisdiction geoTaxKeyMatchCode

Return code denoting the level of match obtained against the cross reference files.

  • E: Exact match using five fields: FIPS state code, FIPS county code, FIPS or GNIS place code, ZIP Code, and FIPS place name.
  • P : Partial match using four fields: FIPS state code, FIPS county code, FIPS or GNIS place code, and ZIP Code.
  • A: Alternate match using two fields: ZIP Code, FIPS place name.
  • N: Record is default coded based on valid state code.
  • null: No matching record found.
Tax Jurisdiction Confidence.SurfaceType

Indicates the confidence surface type. Setting a non-zero buffer width enables confidence generation. To determine a confidence level, a confidence surface is first generated. The confidence surface provides the smallest possible area wherein an address is likely to be located.

0: Undefined

1: The search failed - the address was not found.

2: Intersection confidence surface generated.

3: Interpolated street segment.

4: Point-level match.

5: State confidence surface generated.

6: County confidence surface generated.

7: City confidence surface generated.

8: Reserved

9: A ZIP Code confidence surface generated.

10: A ZIP+2 confidence surface generated.

11: A ZIP+4 confidence surface generated.

12: Reserved

13: A street centroid confidence surface generated.

Tax Jurisdiction Result.gnisCode Unique nine-digit Geographic Names Information System (GNIS) code.
Tax Jurisdiction TaxPlace.classCode Place class code. Place class codes are used to determine the proper taxing jurisdictions.
Tax Jurisdiction TaxPlace.code 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.
Tax Jurisdiction TaxPlace.incorporatedFlag

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.
Tax Jurisdiction TaxPlace.lastAnnexedDate 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.
Tax Jurisdiction TaxPlace.lastUpdatedDate 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.
Tax Jurisdiction TaxPlace.lastVerifiedDate Last verified date, in the format MM/YYYY, representing the month and year that TomTom verified municipality change information.
Tax Jurisdiction TaxPlace.name 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.
Tax Jurisdiction TaxPlace.pointStatus

Returns the result for a comparison between the matched address point to the polygon defined by the Place.txb file. 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.
Tax Jurisdiction TaxPlace.distanceToBorder Returns the distance between the matched address point to the polygon defined by the Place.txb file.
Tax Jurisdiction TaxPlace.confidence Provides the percentage overlap of the geocode to the Place polygon layer. The returned percentage value describes the probability that the point falls in the specified Place.
Census Census.block Census Block ID.
Census Census.BlockCode

15-digit census block ID/census FIPS code, using the syntax sscccttttttgbbb, where:

ss: 2-digit State FIPS Code

ccc: 3-digit County FIPS Code

tttttt: 6-digit Census Tract FIPS Code

g: Single-digit Block Group FIPS Code

bbb: Block FIPS Code

Census Census.blockGroup Census Block Group code.
Census Census.matchCode

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 Census.matchLevel

The level of match obtained against the databases.

Aborted: ExpiredData 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

Census Census.tract Six-digit tract number extracted from the Census Block Code.
Census Census.code Minor Civil Division/Census County Division (MCD/CCD) Code.
Census Census.name Minor Civil Division/Census County Division (MCD/CCD) name.
Census Census.pointStatus

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.

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.
Census Census.distanceToBorder Returns the distance in feet between the matched address point to the polygon defined by the Cousub.txb file.
Census Census.confidence Provides the percentage overlap of the geocode to the MCD polygon layer. The returned percentage value describes the probability that the point falls in the MCD.
Census Cbsa.code Core Based Statistical Area (CBSA) code.
Census Cbsa.name Core Based Statistical Area (CBSA) name.
Census Cbsa.metroFlag

Indicates if the CBSA is a "Metropolitan Statistical Area" or a "Micropolitan Statistical Area".

Y Metropolitan Statistical Area - A Core Based Statistical Area associated with at least one urbanized area that has a population of at least 50,000. The Metropolitan Statistical Area comprises the central county or counties containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

N Micropolitan Statistical Area - A Core Based Statistical Area associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The Micropolitan Statistical Area comprises the central county or counties containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

Census Cbsad.code Core Based Statistical Area Division (CBSAD) code.
Census Cbsad.name Core Based Statistical Area Division (CBSAD) name.
Census Csa.code Combined Statistical Area (CSA) code.
Census Csa.name Combined Statistical Area (CSA) name.
Latitude/Longitude LatLongFields.matchCode

Latitude/Longitude General Return Code. Denotes the level for which the geocode was determined.

2: ZIP + 2 centroid

4 : ZIP + 4 Code centroid

B: Block group centroid

C: City centroid

I: Intersection

L: Match using the Landmark Auxiliary file

O: Latitude/longitude was input

R: Address-level based on street address

S: State centroid

T: Census tract centroid

U: Address-level match using the GeoTAX Auxiliary file

Z: ZIP Code centroid based on a five-digit ZIP code

null: No latitude/longitude determined

If AddressMatch.GenRC is "P" (point match), then the following are possible values:

0: Latitude/Longitude coordinates from User Dictionary.

2: Latitude/Longitude coordinates from Parcel Centroid.

4: Latitude/Longitude coordinates from Address Point.

5: Latitude/Longitude coordinates from Structure Centroid.

7: Latitude/Longitude coordinates from manually-placed Point.

8: Latitude/Longitude coordinates from Front Door Point.

9: Latitude/Longitude coordinates from Driveway Offset Point.

A: Latitude/Longitude coordinates from Street Access Point.

B: Latitude/Longitude coordinates from Base Parcel Point.

C: Latitude/longitude coordinates from Backfill Address Point.

D: Latitude/longitude coordinates from Virtual Address Point.

E: Latitude/longitude coordinates from Interpolated Address Point.

Latitude/Longitude LatLongFields.matchLevel

A description of the value returned in the LatLong.MatchCode field.

  • ZIP+2: ZIP + 2 centroid
  • ZIP+4: ZIP + 4 centroid
  • Block: Block group centroid
  • CityCentroid: City centroid
  • Intersection: Intersection match
  • LandmarkAux: Match using the Landmark Auxiliary file
  • LatLonInput: Input Latitude/Longitude coordinates was used
  • Rooftop: Exact address match
  • StateCentroid: State centroid
  • Tract: Census tract centroid
  • Auxiliary: Address-level match using the GeoTAX Auxiliary file
  • ZIP: ZIP Code centroid
  • Point: Point-level match. One of the following:
    • User Dictionary
    • Parcel Centroid
    • Address Point
    • Structure Centroid
    • Manually-placed Point
    • Front Door Point
    • Driveway Offset Point
    • Street Access Point
    • Base Parcel Point
    • Backfill Address Point
    • Virtual Address Point
    • Interpolated Address Point
Latitude/Longitude Geometry.coordinates[0] Latitude: Seven-digit number in degrees and calculated to four decimal places (in the format specified).
Latitude/Longitude Geometrycoordinates[1] Longitude: Seven-digit number in degrees and calculated to four decimal places (in the format specified).
Latitude/Longitude Geometry.latLongAltFmtValue Returned latitude/longitude, in the format specified (up to 22 alphanumeric characters).
User-defined Boundary Result.numUserBoundariesFound The number of user-defined polygons found for the address.
User-defined Boundary UserBoundary.boundaryDescription A description of the polygon.
User-defined Boundary UserBoundary.boundaryID The ID of the polygon as specified in the user-defined boundary file.
User-defined Boundary UserBoundary.bufferRelation Indicates where in the polygon the address resides in relation to the edge of the area. Buffer width is specified by the option User-defined boundary . One of the following: P The address is inside the polygon at a distance from the edge that is greater than the specified buffer width. I The address is inside the polygon but is close to the edge. B The address is outside the polygon but is close to the edge. For more information on buffers, see Buffering.
User-defined Boundary UserBoundary.distanceToBorder Indicates the distance from the address to the border of the polygon. The distance is in the units specified by the option Distance Units.
User-defined Boundary UserBoundary.supplementalBoundaryID Indicates the distance from the address to the border of the polygon. The distance is in the units specified by the option Distance Units .
User-defined Boundary UserBoundary.boundaryConfidence Provides the percentage overlap of the geocode to the User-defined boundary polygon layer. The returned percentage value describes the probability that the point falls in the User-defined boundary area.
Insurance Premium Tax Districts Result.numTaxDistrictsFound The number of Insurance Premium Tax Districts found for the location.
Insurance Premium Tax Districts BufferRelation.value Indicates where in the district the location resides in relation to the edge of the district. Buffer width is specified by the option Tax district boundary . One of the following: P The location is inside the district at a distance from the edge that is greater than the specified buffer width. I The location is inside the district but is close to the edge. This indicates that the location is in the buffer area. B The location is outside the district but is close to the edge. This indicates that the location is in the buffer area. For more information on buffers, see Buffering.
Insurance Premium Tax Districts DistanceToBorder.value Indicates the distance in feet from the location to the border of the district.
Insurance Premium Tax Districts Ipd.districtID IPD District ID.
Insurance Premium Tax Districts Ipd.districtName IPD District name.
Insurance Premium Tax Districts Ipd.districtType.value IPD district type.
Insurance Premium Tax Districts Ipd.updateDate IPD update date (MMYYYY).
Insurance Premium Tax Districts Ipd.versionDate IPD version date (MMYYYY).
Insurance Premium Tax Districts Ipd.notes Tax code descriptions. For example: 01, 33, A, B.
Insurance Premium Tax Districts Ipd.changeDate IPD change date.
Insurance Premium Tax Districts Ipd.effectiveDate MMDDYY - Identifies when district becomes active - State supplied For example: 010108
Insurance Premium Tax Districts Ipd.expirationDate MMDDYY - Identifies when district becomes inactive - State supplied For example: 063009
Insurance Premium Tax Districts Rate.value Format is dependent on associated flag For example: .13, 15.00 or 3;7
Insurance Premium Tax Districts Rate.format P - Percentage; .1 = 10%, .0575 = 5.75% F - Flat Fee dollar amount M - Multiple Percentages has a semi colon as a delimiter. 3;7 = "3% or 7%"
Payroll Tax Districts Result.numTaxDistrictsFound Number of payroll tax districts found for the location.
Payroll Tax Districts BufferRelation.value Indicates where in the district the location resides in relation to the edge of the district. Buffer width is specified by the option Tax district boundary . One of the following: P The location is inside the district at a distance from the edge that is greater than the specified buffer width. I The location is inside the district but is close to the edge. This indicates that the location is in the buffer area. B The location is outside the district but is close to the edge. This indicates that the location is in the buffer area. For more information on buffers, see Buffering.
Payroll Tax Districts DistanceToBorder.value Indicates the distance in feet from the location to the border of the district.
Payroll Tax Districts PayrollTaxDistrict.districtId PAY district ID.
Payroll Tax Districts PayrollTaxDistrict.districtName PAY district name.
Payroll Tax Districts PayrollTaxDistrict.districtType PAY district type.
Payroll Tax Districts PayrollTaxDistrict.id PAY ID.
Payroll Tax Districts PayrollTaxDistrict.municipalEMSTax PAY municipality emergency municipal services tax. The values for Pennsylvania are: Y Levies the tax N Does not levy the tax All other states are null.
Payroll Tax Districts PayrollTaxDistrict.municipalIncomeTax PAY municipality income tax. The values for Pennsylvania are: R Resident N Non-resident B Both X None All other states are null.
Payroll Tax Districts PayrollTaxDistrict.schoolDistrictEMSTax

PAY school district income tax.

The values for Pennsylvania are:

R: Resident

N: Non-resident

B: Both

N: None

The values for Ohio are:

R: Resident

N: None

All other states are null.

Payroll Tax Districts PayrollTaxDistrict.schoolDistrictIncomeTax PAY school district income tax. The values for Pennsylvania are: R Resident N Non-resident B Both X N The values for Ohio are: R Resident X None All other states are null.
Special Purpose Tax Districts Result.numTaxDistrictsFound Number of Special Purpose Tax Districts found for the location.
Special Purpose Tax Districts BufferRelation.value Indicates where in the district the location resides in relation to the edge of the district. Buffer width is specified by the option Tax district boundary. One of the following: P The location is inside the district at a distance from the edge that is greater than the specified buffer width. I The location is inside the district but is close to the edge. This indicates that the location is in the buffer area. B The location is outside the district but is close to the edge. This indicates that the location is in the buffer area. For more information on buffers, see Buffering.
Special Purpose Tax Districts DistanceToBorder.value Indicates the distance in feet from the address to the border of the district.
Special Purpose Tax Districts SpecialPurposeDistrict.StateID Indicates the state supplied special district ID, if available.
Special Purpose Tax Districts SpecialPurposeDistrict.compiledDate SPD compiled date.
Special Purpose Tax Districts SpecialPurposeDistrict.districtCode 3-digit district type code.
Special Purpose Tax Districts SpecialPurposeDistrict.districtName SPD district name.
Special Purpose Tax Districts SpecialPurposeDistrict.districtNumber SPD district number.
Special Purpose Tax Districts SpecialPurposeDistrict.effectiveDate SPD effective date.
Special Purpose Tax Districts SpecialPurposeDistrict.updateDate SPD update date.
Special Purpose Tax Districts SpecialPurposeDistrict.versionDate SPD version date.
Payroll System Tax Code Result.numPTCsFound The number of payroll system tax codes found for this location.
Payroll System Tax Code Ptc.matchCode Indicates the level of match obtained for the location. In order from most specific match to least, the possible match codes are: P The address was matched to a specific Payroll District ID. This is the most specific match. G The address was matched to a GNIS Code. F The address was matched to a county's FIPS code. S The address was matched to a state's FIPS code. This is the least specific match.
Payroll System Tax Code Ptc.payrollCode A code that represents a taxing authority in a payroll application. This is a user-defined code. The specific codes are determined by the payroll application that utilizes the data returned by Reverse GeoTAX Info Lookup.
Payroll System Tax Code Ptc.payrollDescription A description of the purpose of this payroll code.
Payroll System Tax Code Ptc.payrollFlag A user-defined flag from the PTC database.
Sales and Use Tax Rates SalesTax.resultCode Tax Rate return code denoting the level of match obtained against the Precisely Sales and Use Tax Rate file: E Exact match, using all 5 fields P Partial match, using 4 fields A Alternate match, using 3 fields N Record is default-coded based on valid state code. Blank No matching Sales and Use Tax Rate record found.
Sales and Use Tax Rates SalesTax.municipalTaxRate Municipality sales tax rate for the selected tax rate type.
Sales and Use Tax Rates SalesTax.countyTaxRate County sales tax rate for the selected tax rate type.
Sales and Use Tax Rates SalesTax.stateTaxRate State sales tax rate for the selected tax rate type.
Sales and Use Tax Rates SalesTax.totalTaxRate The sum of the individual Municipal, County, State and SPD sales tax rates.
Sales and Use Tax Rates SpecialPurposeDistrictTax.taxRate Sales Tax rate for up to 10 Special Purpose Districts (SPD).
Sales and Use Tax Rates UseTax.municipalTaxRate Municipality use tax rate for the selected tax rate type.
Sales and Use Tax Rates UseTax.countyTaxRate County use tax rate for the selected tax rate type.
Sales and Use Tax Rates UseTax.stateTaxRate State use tax rate for the selected tax rate type.
Sales and Use Tax Rates UseTax.totalTaxRate The sum of the individual Municipal, County, State and SPD use tax rates.
Sales and Use Tax Rates SpecialPurposeDistrictTax.taxRate Use Tax rate for up to 10 Special Purpose Districts (SPD).

Status Codes

Each response to a request contains an HTTP status code. The GeoTAX Service will return one of the following status codes:

Response Status Code Description
OK 200 The request was valid and results were found.
ZERO_RESULTS 200 No results were found for the request.
UNKNOWN_ERROR 500 General exception occurred.
INVALID_REQUEST 400 Invalid values provided in the request.
SERVICE_UNAVAILABLE 503 Service is not available at the moment to serve the request.
INTERNAL_ERROR 500 Some issue with the internal services.
INVALID_CLIENT_INPUT 400 Request schema is not valid.
INVALID_TOKEN 401 JWT token is not valid.
BATCH_SIZE_EXCEEDED 413 Requested batch size in the request is more than the expected one.
FORBIDDEN 403 User is not authorised to access the API.

Error Codes

The GeoTAX Service will return one of the following error codes, in case of any error:

Error Code Description
DIS-1001 Invalid token
DIS-1002 Not Authorized to access this API
DIS-1003 Issue with internal services
DIS-1004 Workspace Id is missing from Bearer Token
DIS-TAX-1001 Request Body is not valid
DIS-TAX-1002 Request body is not specified in the request
DIS-TAX-1004 Batch size must not exceed 10