GeoTAX by Address - 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

This section describes how to get taxrate for an address using the GeoTAX API service. You may want to try it out with a Free Trial Account .

This method will consume credits.

  • HTTP Request
    • URL Composition
      • Base URL: https://api.cloud.precisely.com
      • GeoTAX by address :/v1/geo-tax/address
    • Supported Methods: POST only
    • Rate Limit (Transactions per second): 200
    • Input Fields Each request to the API service requires a few parameters, all of which are listed below. All requests require a Bearer token, that can be generated using your account's key-secret. To produce a bearer token for an API request, the generated key-secret combinations are used . The generated token is valid for 3600sec (1 hour) and then it needs to be regenerated.

      The data should be encoded as a JSON array where each element in the array is a JSON object with field names identical to those in the input/output fields listed below.

      Table 1. Parameters
      Parameter Description Example Value
      preferences Options supported by the GeoTAX Service which include a variety of settings categorized into output, geocoding, matching, and custom. Some of the preferences under geocoding include, defaultBufferWidth, latLongOffset, and many more.

      defaultBufferWidth:

      Set a different default buffer width.

      Default= The default integer value is 0.
      address An address to be processed.

      addressLines:

      Requested address, based on the country's addressing standard.

      Single-line request:

      "201 N ALTAS PALMAS DR HARLINGEN, TX"

      Multi-line request:

      "201 N ALTAS PALMAS DR",

      "HARLINGEN, TX"

      Below is a sample request for GeoTAX by address end point.

      {
  "preferences":{ 
  "output": {
    "taxDistrict":"none",
    "salesTaxRateType":"none",
    "outputCasing": "upper"
     }
    },
  "address":{
      "addressLines":[
      " 01 N ALTAS PALMAS DR HARLINGEN, TX"],
      "country": "USA"
    }
}

Preferences

Below are the preferences for GeoTAX Service:

Default Preferences

Field Description
custom -
geocoding Set options when geocoding.
matching Set options when matching.
output Set options for the information returned in the output.

Geocoding Preferences

To set geocoding related options.

Field Description
defaultBufferWidth Set a different default buffer width. The default integer value is 0.
userBoundaryBufferDistance Specify the buffer distance for user-defined boundary files.
usePointData Set this option when working with Point data files.
  • Yes(Y)
  • No(N) (default)
latLongOffset Indicates the offset distance in feet from the latLong point.
  • None (default)
  • 20
  • 40
  • 60

Squeeze
Specifies if the street end points should be "squeezed" when determining the geocode of an address in street-level matching. When Squeeze is enabled, both street and end points are moved closer to the center of the segment by 50 feet.
  • Yes(Y)
  • No(N) (default)
latLongAltFormat Specify another format for the latLong coordinates.
  • DecimalDirectional (default)
  • DecimalSign
  • NoDecimalDirectional
  • NoDecimalSign

Matching Preferences

To set matching related options.

Field Description
useGeoTaxAuxiliaryFile Set a different default buffer width.

Default: The default integer value is 0.
useUserAuxiliaryFile Specify the buffer distance for user-defined boundary files.
matchMode Match modes determines the leniency used to make a match between your input and the reference database. Select a match mode based on the quality of your input and your desired output. For example, if you have an input database that is prone to errors, you may want to select the relaxed match mode.
Exact
Requires a very tight match. This restrictive mode generates the fewest match candidates, which decreases the processing time. When using this mode, ensure that your input is very clean; free of misspellings and incomplete addresses.
Close (default)
Requires a close match and generates a moderate number of match candidates.
Relaxed
Allows a loose match and generates the most match candidates, which increases the processing time and results in more multiple matches. Use this mode if you are not confident that your input is free of misspellings and incomplete addresses. This is the only mode that does not respect the street parity when making an address match.

Output Preferences

To set output related options.

Field Description
taxDistrict Indicates the type of tax district information returned.
  • None
  • Ipd : Insurance Premium Tax Districts
  • Pay : Payroll Tax Districts
  • Spd : Special Purpose Tax Districts
For a description of the fields in each output group, see Response Fields.
taxCrossReferenceKey Identify a third-party tax compliance software vendor. This controls the sales tax value returned in the GeoTAXKey output field.
  • None: Do not return jurisdiction codes (default).
  • Note: If you specify a taxCrossReferenceKey , specify Special Purpose Districts under taxDistrict to obtain the best Sales tax cross-reference key match possible.
salesTaxRateType

Indicates the sales and use tax rate type to return or none:

  • None: Do not return sales and use tax rates. (default)
  • General: Return the General sales and use tax rates.
  • Automotive: Return the Automotive sales and use tax rates.
  • Construction: Return the Construction sales and use tax rates.
  • Medical: Return the Medical sales and use tax rates.
usePTC Use a payroll tax correspondence (PTC) file to determine the payroll system tax codes for a given address.

userBoundary

Return data from user-defined boundary files.
outputCasing Specifies the casing of these output fields: TaxCounty.name, Census.name, TaxPlace.name, Ipd.districtName, PayrollTaxDistrict.districtName, SpecialPurposeDistrict.districtName, Ptc.payrollDescription
  • Mixed: Returns the output in mixed case (default). For example: Boulder.
  • Upper: Returns the output in upper case. For example: BOULDER.

Request Parameters

The below table lists the request parameters for GeoTAX Service:

Field Description
addressLines Requested address, based on the country's addressing standard.

Single-line request:

"201 N ALTAS PALMAS DR HARLINGEN, TX 78552"
Multi-line request: 
"201 N ALTAS PALMAS DR",
"HARLINGEN, TX 78552".
addressNumber House or building number.

Example: "10" or "630"

admin1 The largest geographic area, typically a state or province.

Example: "New York".

admin2 The secondary geographic area, typically a county or district.

Example: "Douglas County".
building A roofed and walled structure built for permanent use.
city Specifies a city or town name.

Example: "New York City"

country Name of a country in ISO 3166-1 format (Alpha-2, Alpha-3, or numerical), or a common name of the country.

Example: "United States of America" or "US" or "USA" or "840"

neighborhood A city subdivision or locality.

Example: "Highlands Ranch"

postalCode Main postal code.

Example: "80125"

postalCodeExt Secondary postal code, if one exists.

Example: "8012" (For example, in the US, a ZIP+4 is 80125-8012.)
street A street name.
unit The unit number.

Example: "3B"

unitType A group or suite of rooms within a building that are under common ownership or tenancy, typically having a common entrance. (APT, STE, FLAT, etc.)

Example: APT (Type: Apartment)