{"openapi":"3.0.1","info":{"title":"GeoTAX API","description":"GeoTAX service will provide geographical-based determinations, to determine in which tax jurisdiction a given address is located, and which current tax codes apply.\nGeoTAX uses the most precise geographic data available to assign state, county, township, municipal, school, and other appropriate tax type information to an address.\n<details>\n    <summary>Error Codes</summary>\n\nAPIs will return the following error codes in case of any error:\n\n\n| Error Code                 | Description\n|----------------------------|-------------------------------------------------------\n| DIS-1001                   | Unauthorized, Invalid token\n| DIS-1002                   | Not Authorized to access this API\n| DIS-1003                   | Issue with internal services\n| DIS-1004                   | Workspace Id is missing from Bearer Token\n| DIS-1005                   | Rate limit exceeded\n| DIS-1006                   | Unauthorized, Invalid key/secret\n| DIS-1007                   | API quota has been permanently exhausted. No further requests are allowed for trial user\n| DIS-1008                   | Invalid request ID, maximum allowed length is 38 characters\n| DIS-1009                   | Access blocked due to too many failed attempts. Please try again after sometime\n| DIS-1010                   | Workspace has been expired\n| DIS-TAX-1001               | Request Body is not valid\n| DIS-TAX-1002               | Request body is not specified in the request\n| DIS-TAX-1005               | Request timed out\n</details>\n","version":"1.0"},"servers":[{"url":"https://api.cloud.precisely.com"}],"tags":[{"name":"GeoTAX","description":"Operations related to GeoTAX"}],"paths":{"/v1/geo-tax/address":{"post":{"tags":["GeoTAX"],"summary":"Determines tax jurisdiction and tax codes of given address","description":"This endpoint takes a single input address and determines which tax jurisdiction a given address is located in, and which current tax codes apply.\n","operationId":"lookupByAddress","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"ce3567cb-72e0-428f-89ed-d1e0db7ba430"}],"requestBody":{"description":"Request Body for Geotax","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateRequest"},"examples":{"example":{"value":{"preferences":{"output":{"taxDistrict":"NONE","salesTaxRateType":"NONE","outputCasing":"UPPER","taxCrossReferenceKey":"NONE","usePTC":"NO","userBoundary":"NO"},"geocoding":{"defaultBufferWidth":0,"latLongOffset":"NONE","squeeze":"NO","latLongAltFormat":"DecimalSign","usePointData":"NO"},"matching":{"matchMode":"CLOSE","useGeoTaxAuxiliaryFile":"NO","useUserAuxiliaryFile":"NO"}},"address":{"addressLines":["2001 Main St, Eagle Butte, SD 57625"],"admin1":"","admin2":"","city":"","postalCode":"","postalCodeExt":""}}}}}},"required":true},"responses":{"200":{"description":"Tax Details Retrieved Successfully for GeoTAX by address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateResponse"},"examples":{"example":{"value":{"response":{"status":"OK","result":{"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/2022","lastVerifiedDate":"04/2022","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}}}}}}}},"400":{"description":"Invalid request for GeoTAX by address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7fa91023255810fbe5ef9bc50649106f","errors":[{"code":"DIS-TAX-1003","detail":"Request is not valid"}]}}}}}},"401":{"description":"Unauthorized: Invalid token for GeoTAX by address API ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"ad45c1aded938181a05f256e5a1b594d","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden for GeoTAX by address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9c260ad088c2d64a9f2dd17b2cebb7d1","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"429":{"description":"Too many requests for GeoTAX by address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"754b7151562ce0f01b6bc4521990fe4a","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"408":{"description":"Request timed out for GeoTAX by address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"b1f4d2c37a6e4e11ab90c2f3e8d5a7c9","errors":[{"code":"DIS-TAX-1005","detail":"Request timed out"}]}}}}}},"500":{"description":"Internal server error for GeoTAX by address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"557348c51c55b3bc21f13410885bb41e","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Service unavailable for GeoTAX by address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"857248v51c55b3bc21f13410885cb41d","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/geo-tax/address/batch":{"post":{"tags":["GeoTAX"],"summary":"Determines tax jurisdiction and tax codes of list of addresses","description":"This endpoint takes a list of input addresses and determines which tax jurisdiction they are located in, and which current tax codes apply.\n","operationId":"lookupByAddresses","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"ce3567cb-72e0-428f-89ed-d1e0db7ba430"}],"requestBody":{"description":"Request Body for Geotax Batch Addresses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateBatchRequest"},"examples":{"example":{"value":{"preferences":{"output":{"taxDistrict":"NONE","salesTaxRateType":"NONE","outputCasing":"UPPER","taxCrossReferenceKey":"NONE","usePTC":"NO","userBoundary":"NO"},"geocoding":{"defaultBufferWidth":0,"latLongOffset":"NONE","squeeze":"NO","latLongAltFormat":"DecimalSign","usePointData":"NO"},"matching":{"matchMode":"CLOSE","useGeoTaxAuxiliaryFile":"NO","useUserAuxiliaryFile":"NO"}},"addresses":[{"addressLines":["2001 Main St, Eagle Butte, SD 57625"]},{"addressLines":["2520 Columbia House Blvd #108, Vancouver, WA 98661"]}]}}}}},"required":true},"responses":{"200":{"description":"Tax Details Retrieved Successfully for batch addresses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateBatchResponse"},"examples":{"example":{"value":{"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}}]}}}}}},"400":{"description":"Invalid request for GeoTAX by batch address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7fa91023255810fbe5ef9bc50649106f","errors":[{"code":"DIS-TAX-1003","detail":"Request is not valid"}]}}}}}},"401":{"description":"Unauthorized: Invalid token for GeoTAX by batch address API ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"ad45c1aded938181a05f256e5a1b594d","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden for GeoTAX by batch address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9c260ad088c2d64a9f2dd17b2cebb7d1","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"429":{"description":"Too many requests for GeoTAX by batch address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"754b7151562ce0f01b6bc4521990fe4a","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"408":{"description":"Request timed out for GeoTAX by batch address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"b1f4d2c37a6e4e11ab90c2f3e8d5a7c9","errors":[{"code":"DIS-TAX-1005","detail":"Request timed out"}]}}}}}},"500":{"description":"Internal server error for GeoTAX by batch address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"557348c51c55b3bc21f13410885bb41e","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Service unavailable for GeoTAX by batch address API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"857248v51c55b3bc21f13410885cb41d","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/geo-tax/location":{"post":{"tags":["GeoTAX"],"summary":"Determines tax jurisdiction and tax codes of given coordinates","description":"This endpoint takes a latitude and longitude as input and determines which tax jurisdiction a given address is located in, and which current tax codes apply.\n","operationId":"lookupByLocation","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"045f7e9b-4aad-4013-be77-8384e07741de"}],"requestBody":{"description":"Request Body for Geotax","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateRequestByLocation"},"examples":{"example":{"value":{"preferences":{"output":{"taxDistrict":"SPD","salesTaxRateType":"GENERAL","outputCasing":"MIXED","taxCrossReferenceKey":"NONE","usePTC":"NO","userBoundary":"NO"},"geocoding":{"defaultBufferWidth":0,"latLongOffset":"NONE","squeeze":"NO","latLongAltFormat":"DecimalSign","usePointData":"NO"},"matching":{"matchMode":"CLOSE","useGeoTaxAuxiliaryFile":"NO","useUserAuxiliaryFile":"NO"}},"location":{"longitude":-98.401796,"latitude":34.688726}}}}}},"required":true},"responses":{"200":{"description":"Tax Details Retrieved Successfully for GeoTAX by location API ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateResponse"},"examples":{"example":{"value":{"response":{"status":"OK","result":{"addressId":"1","gnisCode":"002411638","confidence":100.0,"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.0}]},"useTax":{"totalTaxRate":0.09,"stateTaxRate":0.045,"countyTaxRate":0.00375,"municipalTaxRate":0.04125,"spdsTax":[{"districtNumber":"00001","taxRate":0.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}}}}}}}},"400":{"description":"Invalid request for GeoTAX by location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7fa91023255810fbe5ef9bc50649106f","errors":[{"code":"DIS-TAX-1003","detail":"Request is not valid"}]}}}}}},"401":{"description":"Unauthorized: Invalid token for GeoTAX by location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"ad45c1aded938181a05f256e5a1b594d","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden for GeoTAX by location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9c260ad088c2d64a9f2dd17b2cebb7d1","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"429":{"description":"Too many requests for GeoTAX by location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"754b7151562ce0f01b6bc4521990fe4a","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"408":{"description":"Request timed out for GeoTAX by location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"b1f4d2c37a6e4e11ab90c2f3e8d5a7c9","errors":[{"code":"DIS-TAX-1005","detail":"Request timed out"}]}}}}}},"500":{"description":"Internal server error for GeoTAX by location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"557348c51c55b3bc21f13410885bb41e","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Service unavailable for GeoTAX by location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"857248v51c55b3bc21f13410885cb41d","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}},"/v1/geo-tax/location/batch":{"post":{"tags":["GeoTAX"],"summary":"Determines tax jurisdiction and tax codes of given batch coordinates","description":"This endpoint takes list of latitudes and longitudes as input and determines which tax jurisdiction given coordinates are located in, and which current tax codes apply.\n","operationId":"lookupByLocations","parameters":[{"name":"X-Request-Id","in":"header","description":"The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.","schema":{"type":"string"},"example":"045f7e9b-4aad-4013-be77-8384e07741de"}],"requestBody":{"description":"Request Body for Geotax Batch Locations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateBatchRequestByLocation"},"examples":{"example":{"value":{"preferences":{"output":{"taxDistrict":"NONE","salesTaxRateType":"NONE","outputCasing":"UPPER","taxCrossReferenceKey":"NONE","usePTC":"NO","userBoundary":"NO"},"geocoding":{"defaultBufferWidth":0,"latLongOffset":"NONE","squeeze":"NO","latLongAltFormat":"DecimalSign","usePointData":"NO"},"matching":{"matchMode":"CLOSE","useGeoTaxAuxiliaryFile":"NO","useUserAuxiliaryFile":"NO"}},"locations":[{"longitude":-98.401796,"latitude":34.688726},{"longitude":-92.9036,"latitude":34.8192}]}}}}},"required":true},"responses":{"200":{"description":"Tax Details Retrieved Successfully for batch locations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateBatchResponse"},"examples":{"example":{"value":{"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}}]}}}}}},"400":{"description":"Invalid request for GeoTAX by Batch location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"7fa91023255810fbe5ef9bc50649106f","errors":[{"code":"DIS-TAX-1003","detail":"Request is not valid"}]}}}}}},"401":{"description":"Unauthorized: Invalid token for GeoTAX by Batch  location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"ad45c1aded938181a05f256e5a1b594d","errors":[{"code":"DIS-1001","detail":"Unauthorized"}]}}}}}},"403":{"description":"Forbidden for GeoTAX by Batch location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"9c260ad088c2d64a9f2dd17b2cebb7d1","errors":[{"code":"DIS-1002","detail":"You do not have permission to access this API"}]}}}}}},"429":{"description":"Too many requests for GeoTAX by Batch location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"754b7151562ce0f01b6bc4521990fe4a","errors":[{"code":"DIS-1005","detail":"Rate limit exceeded"}]}}}}}},"408":{"description":"Request timed out for GeoTAX by Batch location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"b1f4d2c37a6e4e11ab90c2f3e8d5a7c9","errors":[{"code":"DIS-TAX-1005","detail":"Request timed out"}]}}}}}},"500":{"description":"Internal server error for GeoTAX by Batch location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"557348c51c55b3bc21f13410885bb41e","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}},"503":{"description":"Service unavailable for GeoTAX by Batch location API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"example":{"value":{"id":"857248v51c55b3bc21f13410885cb41d","errors":[{"code":"DIS-1003","detail":"Issue with internal services. Please try again after sometime"}]}}}}}}},"security":[{"bearerAuth":[]},{"ApiKeyAuth":[]}]}}},"components":{"schemas":{"BoundaryBuffer":{"type":"object","properties":{"bufferRelation":{"description":"Buffer Relation","allOf":[{"$ref":"#/components/schemas/BufferRelation"}]},"distanceToBorder":{"description":"Distance to Border","allOf":[{"$ref":"#/components/schemas/DistanceToBorder"}]}},"description":"Boundary Buffer"},"BufferRelation":{"type":"object","properties":{"description":{"type":"string","description":"Buffer Relation Description","example":" "},"value":{"type":"string","description":"Indicates where in the district the location resides in relation to the edge of the district.","example":"P"}},"description":"Buffer Relation"},"Cbsa":{"type":"object","properties":{"name":{"type":"string","description":"Name.","example":"MITCHELL, SD MICROPOLITAN STATISTICAL AREA"},"code":{"type":"string","description":"Code.","example":"33580"},"metroFlag":{"type":"string","description":"Indicates if the CBSA is a Metropolitan Statistical Area or a Micropolitan Statistical Area.","example":"N"}},"description":"Core Based Statistical Area"},"Cbsad":{"type":"object","properties":{"name":{"type":"string","description":"Name","example":"MICROPOLITAN STATISTICAL AREA"},"code":{"type":"string","description":"Code","example":"459012"}},"description":"Core Based Statistical Area Division "},"Census":{"type":"object","properties":{"block":{"type":"string","description":"Census Block ID.","example":"050"},"blockCode":{"type":"string","description":"A 15-digit census block ID/census FIPS code.","example":"170898531002008"},"blockGroup":{"type":"string","description":"Census Block Group code.","example":"5"},"cbsa":{"description":"CBSA","allOf":[{"$ref":"#/components/schemas/Cbsa"}]},"matchLevel":{"type":"string","description":"The level of match obtained against the databases.","example":"Street"},"matchCode":{"type":"string","description":"The code assigned to a specific level of match obtained against the databases.","example":"5"},"tract":{"type":"string","description":"Six-digit tract number extracted from the Census.BlockCode.","example":"962700"},"mcd":{"description":"MCD","allOf":[{"$ref":"#/components/schemas/Mcd"}]},"cbsad":{"description":"CBSAD","allOf":[{"$ref":"#/components/schemas/Cbsad"}]},"csa":{"description":"CSA","allOf":[{"$ref":"#/components/schemas/Csa"}]}},"description":"Census"},"Csa":{"type":"object","properties":{"name":{"type":"string","description":"Csa Name","example":"DENVER-AURORA-GREELEY, CO COMBINED STATISTICAL AREA"},"code":{"type":"string","description":"Csa Code","example":"216"}},"description":"Combined Statistical Area"},"DistanceToBorder":{"type":"object","properties":{"unit":{"type":"string","description":"Unit","example":"feet"},"value":{"type":"string","description":"Indicates the distance in feet from the address to the border of the district.","example":"7887"}},"description":"Indicates the distance from the address to the border of the district."},"DistrictType":{"type":"object","properties":{"description":{"type":"string","description":"description of District Type","example":"LAKELAND"},"value":{"type":"string","description":"value of District Type","example":"546"}},"description":"District Type"},"ErrorDetail":{"required":["detail"],"type":"object","properties":{"code":{"type":"string","description":"A unique code representing the specific error.","example":"DIS-1001"},"detail":{"type":"string","description":"A detailed message describing the error.","example":"Unauthorized"}},"description":"Error details."},"ErrorResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the error.","example":"ad45c1aded938181a05f256e5a1b594d"},"errors":{"type":"array","description":"List of errors ","items":{"$ref":"#/components/schemas/ErrorDetail"}}},"description":"Error response."},"GeocodingPreference":{"required":["latLongAltFormat","latLongOffset","squeeze","usePointData"],"type":"object","properties":{"defaultBufferWidth":{"minimum":0,"type":"number","description":"Set an alternative default buffer width. It must be positive integer/double value.","format":"double","example":0,"default":0},"userBoundaryBufferDistance":{"minimum":0,"type":"number","description":"Set user boundary file buffer distance as integer value. It must be positive integer/double value.","format":"double","example":0,"default":0},"latLongOffset":{"$ref":"#/components/schemas/LatLongOffsetType"},"squeeze":{"$ref":"#/components/schemas/SqueezeType"},"latLongAltFormat":{"$ref":"#/components/schemas/LatLongAltFormatType"},"usePointData":{"$ref":"#/components/schemas/UsePointDataType"}},"description":"Geocoding Preferences"},"Geometry":{"type":"object","properties":{"latLongAltFmt":{"type":"string","description":"Latitude Longitude Alt Format","example":"DecimalSign"},"latLongAltFmtValue":{"type":"string","description":"Returned latitude/longitude, in the format specified (up to 22 alphanumeric characters).","example":"43.731783-098.025936"},"type":{"type":"string","description":"type","example":"Point"},"coordinates":{"type":"array","description":"Seven-digit numbers in degrees and calculated to four decimal places (in the format specified).","example":[43.731783,-98.025936],"items":{"type":"number","format":"double"}}},"description":"Geometry"},"Ipd":{"type":"object","properties":{"districtID":{"type":"string","description":"IPD ID.","example":"546"},"districtName":{"type":"string","description":"IPD name.","example":"LAKELAND"},"districtType":{"description":"District Type for IPD","allOf":[{"$ref":"#/components/schemas/DistrictType"}]},"taxCodeDescription":{"type":"string","description":"Tax Code Description","example":"Minimum"},"notes":{"type":"string","description":"Tax code descriptions. For example: 01, 33, A, B.","example":"33"},"effectiveDate":{"type":"string","description":"MMDDYY - Identifies when district becomes active - State supplied For example: 010108","example":"010108"},"expirationDate":{"type":"string","description":"MMDDYY - Identifies when district becomes inactive - State supplied For example: 063009","example":"063009"},"versionDate":{"type":"string","description":"IPD compiled date (MMYYYY).","example":"032023"},"updateDate":{"type":"string","description":"IPD update date (MMYYYY).","example":"072024"},"changeDate":{"type":"string","description":"IPD change date.","example":"062024"},"boundaryBuffer":{"description":"Boundary Buffer for IPD","allOf":[{"$ref":"#/components/schemas/BoundaryBuffer"}]},"rates":{"type":"array","description":"List of Rates","items":{"$ref":"#/components/schemas/Rate"}}},"description":"Insurance Premium Tax Districts"},"LatLongAltFormatType":{"type":"string","description":"Specifies another format for the latLong coordinates.","example":"DecimalDirectional","enum":["DecimalDirectional","DecimalSign","NoDecimalDirectional","NoDecimalSign"],"default":"DecimalSign","x-enum-varnames":["DECIMAL_DIRECTIONAL","DECIMAL_SIGN","NO_DECIMAL_DIRECTIONAL","NO_DECIMAL_SIGN"]},"LatLongFields":{"type":"object","properties":{"matchCode":{"type":"string","description":"Latitude/Longitude General Return Code. Denotes the level for which the geocode was determined.","example":"R"},"matchLevel":{"type":"string","description":"A description of the value returned in the LatLong.MatchCode field.","example":"Rooftop"},"geometry":{"description":"Geometry of the lat long","allOf":[{"$ref":"#/components/schemas/Geometry"}]}},"description":"Returned latitude/longitude, in the format you specified (up to 22 alphanumeric characters)."},"LatLongOffsetType":{"type":"string","description":"Specifies the offset distance in feet from the latLong point.","example":"NONE","enum":["20","40","60","NONE"],"default":"NONE","x-enum-varnames":["TWENTY","FORTY","SIXTY","NONE"]},"LocationDetail":{"required":["latitude","longitude"],"type":"object","properties":{"addressId":{"type":"string","description":"Address Id for the request","example":"1"},"longitude":{"type":"number","description":"longitude (x)","format":"double","example":-98.401796},"latitude":{"type":"number","description":"latitude (y)","format":"double","example":34.688726}},"description":"List of object contains coordinates"},"MatchModeType":{"type":"string","description":"Match modes determines the leniency used to make a match between your input and the reference database.","example":"EXACT","enum":["CLOSE","EXACT","RELAXED"],"default":"CLOSE"},"MatchedAddress":{"type":"object","properties":{"formattedAddress":{"type":"string","description":"All components of the address, formatted to the country's standard, on one line.","example":"2001 N MAIN ST MITCHELL, SD  57301"},"formattedStreetAddress":{"type":"string","description":"Street portion of the address, including the directional and street suffix, formatted to the country's standard.","example":"2001 N MAIN ST"},"formattedLocationAddress":{"type":"string","description":"The complete matched last address line (city, state, and postal code).","example":"MITCHELL, SD  57301"},"addressNumber":{"type":"string","description":"House or building number.","example":"2001"},"stateName":{"type":"string","description":"Street name.","example":"SD"},"countyName":{"type":"string","description":"County name.","example":"DAVISON"},"cityName":{"type":"string","description":"Specifies a city or town name.","example":"MITCHELL"},"postalCode":{"type":"string","description":"The matched address five-digit ZIP Code.","example":"57301"},"postalCodeExt":{"type":"string","description":"The matched address four-digit ZIP Code extension.","example":"2890"},"placeName":{"type":"string","description":"If applicable, indicates the name of the candidate's place or building.","example":"MITCHELL"},"unit":{"type":"string","description":"Apartment number. For example, 123 E Main St APT 3.","example":"123 E Main St APT 3"},"unitType":{"type":"string","description":"The type of unit, such as apartment, suite, or lot.","example":"APT"},"street":{"type":"string","description":"The name of the street, not including any directionals or suffixes.","example":"MAIN"},"firmName":{"type":"string","description":"The name of the business if the address is a business address.","example":"Mayfire Corporation"},"dataTypeName":{"type":"string","description":"Indicates the file from which the match was obtained.","example":"TOMTOM STREETS"},"genRC":{"type":"string","description":"General Return Code indicating the type of match.","example":"S"},"locationCode":{"type":"string","description":"The Location Code indicates the methodology used to complete the geocode and may also provide some information about the quality of the geocode.","example":"AS0"},"matchCode":{"type":"string","description":"The Match Code indicates the portions of the address that matched or did not match to the reference file.","example":"TB21"},"numCandidates":{"type":"string","description":"When there are multiple equally-scored matches, returns the number of multiple match candidates found.","example":"0"},"urbanization":{"type":"string","description":"Urbanization name. Used for addresses in Puerto Rico.","example":"URB COUNTRY CLUB"},"houseNumber":{"type":"string","description":"Building number for the address.","example":"2001"},"preDirectional":{"type":"string","description":"Leading directional. For example, 123 E Main St Apt 3.","example":"N"},"streetType":{"type":"string","description":"The street type of the matched location. For example, AVE for Avenue.","example":"ST"},"postDirectional":{"type":"string","description":"Street directional that follows the street name. For example, the \"N\" in this address: 456 Washington N.","example":"N"},"country":{"type":"string","description":"Country of the address","example":"USA"},"city":{"type":"string","description":"City of the address","example":"New York"}},"description":"Matched Address details for a request"},"MatchingPreference":{"required":["matchMode","useGeoTaxAuxiliaryFile","useUserAuxiliaryFile"],"type":"object","properties":{"matchMode":{"$ref":"#/components/schemas/MatchModeType"},"useGeoTaxAuxiliaryFile":{"$ref":"#/components/schemas/UseGeoTaxAuxiliaryFileType"},"useUserAuxiliaryFile":{"$ref":"#/components/schemas/UseUserAuxiliaryFileType"}},"description":"Matching Preferences"},"Mcd":{"type":"object","properties":{"name":{"type":"string","description":"Minor Civil Division/Census County Division (MCD/CCD) name.","example":"MITCHELL CITY"},"code":{"type":"string","description":"Minor Civil Division/Census County Division (MCD/CCD) Code.","example":"43100"},"pointStatus":{"type":"string","description":"The result for a comparison between the matched address point to the polygon defined by the Cousub.txb file.","example":"p"},"distanceToBorder":{"type":"string","description":"Returns the distance in feet between the matched address point to the polygon defined by the Cousub.txb file.","example":"1776"},"confidence":{"type":"string","description":"Provides the percentage overlap of the geocode to the MCD polygon layer.","example":"98"}},"description":"Minor Civil Division"},"OutputCasingType":{"type":"string","description":"Specifies the casing of these output fields.","example":"UPPER","enum":["UPPER","MIXED"],"default":"UPPER"},"OutputPreference":{"required":["outputCasing","salesTaxRateType","taxCrossReferenceKey","taxDistrict","usePTC","userBoundary"],"type":"object","properties":{"taxDistrict":{"$ref":"#/components/schemas/TaxDistrictType"},"salesTaxRateType":{"$ref":"#/components/schemas/SalesTaxRateType"},"outputCasing":{"$ref":"#/components/schemas/OutputCasingType"},"taxCrossReferenceKey":{"$ref":"#/components/schemas/TaxCrossReferenceKeyType"},"usePTC":{"$ref":"#/components/schemas/UsePTCType"},"userBoundary":{"$ref":"#/components/schemas/UserBoundaryType"}},"description":"Output Preference"},"PayrollTaxCorrespondence":{"type":"object","properties":{"matchCode":{"type":"string","description":"Indicates the level of match obtained for the address.","example":"TB21"},"ptcs":{"type":"array","description":"List of Payroll Tax Correspondence","items":{"$ref":"#/components/schemas/Ptc"}}},"description":"PayrollTaxCorrespondence"},"PayrollTaxDistrict":{"type":"object","properties":{"id":{"type":"string","description":"PAY ID.","example":"18990"},"districtId":{"type":"string","description":"PAY district ID.","example":"A2654"},"districtName":{"type":"string","description":"PAY district name.","example":"PHILADELPHIA CITY - PHILADELPHIA CITY S D"},"districtType":{"type":"string","description":"PAY district type.","example":"UNI"},"updateDate":{"type":"string","description":"PAY update date.","example":"082015"},"municipalEMSTax":{"type":"string","description":"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.","example":"Y"},"municipalIncomeTax":{"type":"string","description":"PAY municipality income tax. The values for Pennsylvania are: R Resident N Non-resident B Both X None All other states are null.","example":"B"},"schoolDistrictEMSTax":{"type":"string","description":"PAY school district emergency municipal services tax. The Values for Pennsylvania are: Y Levies the tax N Does not levy the tax All other states are null.","example":"N"},"schoolDistrictIncomeTax":{"type":"string","description":"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.","example":"R"},"boundaryBuffer":{"description":"Boundary Buffer","allOf":[{"$ref":"#/components/schemas/BoundaryBuffer"}]}},"description":"Specified the tax district of Payroll"},"Preferences":{"type":"object","properties":{"geocoding":{"description":"Geocoding Preferences","allOf":[{"$ref":"#/components/schemas/GeocodingPreference"}]},"matching":{"description":"Matching Preference","allOf":[{"$ref":"#/components/schemas/MatchingPreference"}]},"output":{"description":"Output Preference","allOf":[{"$ref":"#/components/schemas/OutputPreference"}]}},"description":"Preferences"},"Ptc":{"type":"object","properties":{"payrollCode":{"type":"string","description":"A code that represents a taxing authority in a payroll application.","example":"48000"},"payrollDescription":{"type":"string","description":"A description of the purpose of this payroll code.","example":"LOUISVILLE METRO"},"payrollFlag":{"type":"string","description":"A user-defined flag from the PTC database.","example":"X"}},"description":"Payroll Tax Correspondence"},"Rate":{"type":"object","properties":{"name":{"type":"string","description":"Rate Name","example":"Other"},"format":{"type":"string","description":"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%\"","example":"0.575"},"formatDescription":{"type":"string","description":"Format Description","example":"P"},"value":{"type":"string","description":"Format is dependent on associated flag For example: .13, 15.00 or 3;7","example":".13"}},"description":"Rate"},"Result":{"type":"object","properties":{"addressId":{"type":"string","description":"Address Id for the response","example":"1"},"gnisCode":{"type":"string","description":"Unique nine-digit Geographic Names Information System (GNIS) code.","example":"001267480"},"preciselyId":{"type":"string","description":"A unique address identifier that is returned when an address match is made using the Master Location Database.","example":"PBS003PYQJX9"},"confidence":{"type":"number","description":"Indicates the confidence in the output provided; from 0 to 100. The higher the score, the higher the confidence in the match.","format":"double","example":100},"jurisdiction":{"description":"Tax Jurisdiction","allOf":[{"$ref":"#/components/schemas/TaxJurisdiction"}]},"matchedAddress":{"description":"Matched Address","allOf":[{"$ref":"#/components/schemas/MatchedAddress"}]},"salesTax":{"description":"Sales Tax","allOf":[{"$ref":"#/components/schemas/SalesTax"}]},"useTax":{"description":"Use Tax","allOf":[{"$ref":"#/components/schemas/UseTax"}]},"census":{"description":"Census","allOf":[{"$ref":"#/components/schemas/Census"}]},"latLongFields":{"description":"Lat Long fields","allOf":[{"$ref":"#/components/schemas/LatLongFields"}]},"numTaxDistrictsFound":{"type":"integer","description":"The number of Insurance Premium Tax Districts found for the location.","format":"int32","example":0},"ipds":{"type":"array","description":"List of IPDs","items":{"$ref":"#/components/schemas/Ipd"}},"ptds":{"type":"array","description":"Tax districts of a Payroll","items":{"$ref":"#/components/schemas/PayrollTaxDistrict"}},"ptc":{"description":"Payroll Tax Correspondence","allOf":[{"$ref":"#/components/schemas/PayrollTaxCorrespondence"}]},"userBoundaries":{"type":"array","description":"List of User Boundaries","items":{"$ref":"#/components/schemas/UserBoundary"}}},"description":"Processed Result"},"SalesTax":{"type":"object","properties":{"totalTaxRate":{"type":"number","description":"The sum of the individual Municipal, County, State and SPD sales tax rates.","format":"double","example":0.876},"stateTaxRate":{"type":"number","description":"State sales tax rate for the selected tax rate type.","format":"double","example":0.715},"countyTaxRate":{"type":"number","description":"County sales tax rate for the selected tax rate type.","format":"double","example":0},"municipalTaxRate":{"type":"number","description":"Municipality sales tax rate for the selected tax rate type.","format":"double","example":0.318},"resultCode":{"type":"string","description":"Tax Rate return code denoting the level of match obtained against the Precisely Sales and Use Tax Rate file.","example":"E"},"spdsTax":{"type":"array","description":"List of SPDs","items":{"$ref":"#/components/schemas/SpecialPurposeDistrictTax"}}},"description":"Sales Tax"},"SalesTaxRateType":{"type":"string","description":"Specifies the sales and use tax rate type to return or none.","example":"GENERAL","enum":["GENERAL","AUTOMOTIVE","CONSTRUCTION","MEDICAL","NONE"],"default":"NONE"},"SpecialPurposeDistrict":{"type":"object","properties":{"stateId":{"type":"string","description":"SPD district id.","example":"426"},"districtName":{"type":"string","description":"SPD name.","example":"PHILADELPHIA CITY - PHILADELPHIA CITY S D"},"districtCode":{"type":"string","description":"3-digit district type code.","example":"SCD"},"districtNumber":{"type":"string","description":"District number for SPD","example":"00004"},"versionDate":{"type":"string","description":"SPD version date.","example":"092006"},"effectiveDate":{"type":"string","description":"SPD effective date.","example":"012004"},"compiledDate":{"type":"string","description":"SPD compiled date.","example":"092006"},"updateDate":{"type":"string","description":"SPD update date.","example":"062024"},"boundaryBuffer":{"description":"Boundary Buffer","allOf":[{"$ref":"#/components/schemas/BoundaryBuffer"}]}},"description":"Special Purpose District(SPD)"},"SpecialPurposeDistrictTax":{"type":"object","properties":{"districtNumber":{"type":"string","description":"SPD district number.","example":"00004"},"taxRate":{"type":"number","description":"Tax rate for up to 10 Special Purpose Districts (SPD).","format":"double","example":0.8}},"description":"Special Purpose District Tax"},"SqueezeType":{"type":"string","description":"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.","example":"NO","enum":["YES","NO"],"default":"NO"},"Status":{"type":"string","description":"Represents the status of a response","example":"OK","enum":["OK","ZERO_RESULTS"]},"TaxCounty":{"type":"object","properties":{"code":{"type":"string","description":"Extracted from the Census.BlockCode.","example":"035"},"name":{"type":"string","description":"Name of the county.","example":"DAVISON"}},"description":"Tax County"},"TaxCrossReferenceKeyType":{"type":"string","description":"Specifies to use cross reference data.","example":"VERTEX","enum":["NONE","VERTEX","TR","SOVOS"],"default":"NONE"},"TaxDistrictType":{"type":"string","description":"Specifies the type of tax district information returned.","example":"SPD","enum":["SPD","IPD","PAY","NONE"],"default":"NONE"},"TaxJurisdiction":{"type":"object","properties":{"state":{"description":"Tax State","allOf":[{"$ref":"#/components/schemas/TaxState"}]},"county":{"description":"Tax County","allOf":[{"$ref":"#/components/schemas/TaxCounty"}]},"place":{"description":"Tax Place","allOf":[{"$ref":"#/components/schemas/TaxPlace"}]},"geoTaxKey":{"type":"string","description":"The value in this field varies depending on the option you specified in the Sales tax cross-reference key option.","example":"5282"},"geoTaxKeyMatchCode":{"type":"string","description":"Return code denoting the level of match obtained against the Vertex or Sovos cross reference files.","example":"E"},"spds":{"type":"array","description":"List of SPDs","items":{"$ref":"#/components/schemas/SpecialPurposeDistrict"}}},"description":"Tax Jurisdiction"},"TaxPlace":{"type":"object","properties":{"name":{"type":"string","description":"The name of the \"place\" where the address is located.","example":"MITCHELL"},"code":{"type":"string","description":"Five-digit Federal Information Processing Standards (FIPS) place code.","example":"43100"},"gnisCode":{"type":"string","description":"GNIS Code","example":"001267480"},"selfCollected":{"type":"boolean","description":"Self Collected","example":false},"classCode":{"type":"string","description":"Place class code. Place class codes are used to determine the proper taxing jurisdictions.","example":"C5"},"incorporatedFlag":{"type":"string","description":"Indicates whether the address is located in an incorporated or unincorporated place.","example":"Inc"},"lastAnnexedDate":{"type":"string","description":"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.","example":"01/2020"},"lastUpdatedDate":{"type":"string","description":"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.","example":"10/2022"},"lastVerifiedDate":{"type":"string","description":"Last verified date, in the format MM/YYYY, representing the month and year that TomTom verified municipality change information.","example":"04/2022"},"pointStatus":{"type":"string","description":"Returns the result for a comparison between the matched address point to the polygon defined by the Place.txb file.","example":"p"},"distanceToBorder":{"type":"string","description":"Returns the distance between the matched address point to the polygon defined by the Place.txb file.","example":"1776"},"confidence":{"type":"string","description":"Provides the percentage overlap of the geocode to the Place polygon layer.","example":"98"}},"description":"Tax Place"},"TaxRateAddress":{"type":"object","properties":{"addressId":{"type":"string","description":"Address Id for the request","example":"1"},"addressLines":{"type":"array","description":"Requested address, based on the country's addressing standard.","example":["2001 Main St, Eagle Butte, SD 57625"],"items":{"type":"string"}},"addressNumber":{"type":"string","description":"House or building number.","example":"2001"},"admin1":{"type":"string","description":"The largest geographic area, typically a state or province.","example":"Minnesota"},"admin2":{"type":"string","description":"The secondary geographic area, typically a county or district.","example":"Dakota County"},"city":{"type":"string","description":"Specifies a city or town name of address","example":"HASTINGS"},"neighborhood":{"type":"string","description":"Neighborhood name.","example":"Downtown"},"postalCode":{"type":"string","description":"Main postal code.","example":"55033"},"postalCodeExt":{"type":"string","description":"Secondary postal code, if one exists. For example, in the US, a ZIP+4 is 80125-8012.","example":"8012"},"street":{"type":"string","description":"The name of the street.","example":"Main St"},"building":{"type":"string","description":"Building name or identifier.","example":"Building A"},"unit":{"type":"string","description":"Apartment or unit number.","example":"5B"},"unitType":{"type":"string","description":"The type of unit, such as apartment, suite, or lot.","example":"APT"}},"description":"Address to be processed"},"TaxRateBatchRequest":{"required":["addresses"],"type":"object","properties":{"addresses":{"type":"array","description":"List of Addresses","items":{"$ref":"#/components/schemas/TaxRateAddress"}},"preferences":{"description":"Preferences for batch addresses","allOf":[{"$ref":"#/components/schemas/Preferences"}]}},"description":"Batch Request for Addresses"},"TaxRateBatchRequestByLocation":{"required":["locations"],"type":"object","properties":{"locations":{"type":"array","description":"List of locations","items":{"$ref":"#/components/schemas/LocationDetail"}},"preferences":{"description":"Preferences for batch locations","allOf":[{"$ref":"#/components/schemas/Preferences"}]}},"description":"Batch Request for Locations"},"TaxRateBatchResponse":{"type":"object","properties":{"responses":{"type":"array","description":"List of responses","items":{"$ref":"#/components/schemas/TaxResponse"}}},"description":"Batch Response"},"TaxRateRequest":{"required":["address"],"type":"object","properties":{"address":{"description":"Tax Rate Address","allOf":[{"$ref":"#/components/schemas/TaxRateAddress"}]},"preferences":{"description":"Preferences","allOf":[{"$ref":"#/components/schemas/Preferences"}]}},"description":"TaxRateRequest"},"TaxRateRequestByLocation":{"required":["location"],"type":"object","properties":{"location":{"description":"Tax Rate Location Details","allOf":[{"$ref":"#/components/schemas/LocationDetail"}]},"preferences":{"description":"Preferences","allOf":[{"$ref":"#/components/schemas/Preferences"}]}},"description":"TaxRateRequestByLocation"},"TaxRateResponse":{"type":"object","properties":{"response":{"description":"TaxResponse","allOf":[{"$ref":"#/components/schemas/TaxResponse"}]}},"description":"Response"},"TaxResponse":{"required":["status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/Status"},"errorMessage":{"type":"string","description":"Error message from the service.","example":"Request is not valid"},"result":{"description":"Tax Response","allOf":[{"$ref":"#/components/schemas/Result"}]}},"description":"Response for request"},"TaxState":{"type":"object","properties":{"code":{"type":"string","description":"Two-digit Federal Information Processing Standards (FIPS) state code extracted from the Census.BlockCode.","example":"46"},"name":{"type":"string","description":"Two-character state abbreviation.","example":"SD"}},"description":"Tax State"},"UseGeoTaxAuxiliaryFileType":{"type":"string","description":"Specifies to use the GeoTAX auxiliary dataset or not.","example":"YES","enum":["YES","NO"],"default":"NO"},"UsePTCType":{"type":"string","description":"Specifies o use the payroll tax correspondence dataset or not.","example":"NO","enum":["YES","NO"],"default":"NO"},"UsePointDataType":{"type":"string","description":"Specifies to use MLD data or not.","example":"YES","enum":["YES","NO"],"default":"NO"},"UseTax":{"type":"object","properties":{"totalTaxRate":{"type":"number","description":"The sum of the individual Municipal, County, State and SPD use tax rates.","format":"double","example":0.062},"stateTaxRate":{"type":"number","description":"State use tax rate for the selected tax rate type.","format":"double","example":0.042},"countyTaxRate":{"type":"number","description":"County use tax rate for the selected tax rate type.","format":"double","example":0.07},"municipalTaxRate":{"type":"number","description":"Municipality use tax rate for the selected tax rate type.","format":"double","example":0.065},"resultCode":{"type":"string","description":"Tax Rate return code denoting the level of match obtained against the Precisely Sales and Use Tax Rate file","example":"E"},"spdsTax":{"type":"array","description":"Special Puropse District Tax List","items":{"$ref":"#/components/schemas/SpecialPurposeDistrictTax"}}},"description":"Use Tax"},"UseUserAuxiliaryFileType":{"type":"string","description":"Specifies to use the user auxiliary dataset or not.","example":"NO","enum":["YES","NO"],"default":"NO"},"UserBoundary":{"type":"object","properties":{"boundaryID":{"type":"string","description":"The ID of the polygon as specified in the user-defined boundary file.","example":"21"},"boundaryDescription":{"type":"string","description":"A description of the polygon.","example":"Kentucky"},"supplementalBoundaryID":{"type":"string","description":"A supplemental ID as specified in the user-defined boundary file.","example":"KY"},"boundaryConfidence":{"type":"string","description":"Provides the percentage overlap of the geocode to the User-defined boundary polygon layer.","example":"22"},"bufferRelation":{"type":"string","description":"Indicates where in the polygon the address resides in relation to the edge of the area.","example":"P"},"distanceToBorder":{"type":"string","description":"Indicates the distance from the address to the border of the polygon. The distance is in the units specified by the option Distance Units .","example":"11533"}},"description":"User Defined Boundary"},"UserBoundaryType":{"type":"string","description":"Specifies to use the user boundary dataset or not.","example":"NO","enum":["YES","NO"],"default":"NO"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Pass the value in the following format: Apikey <base64(api_key:api_secret)>.","name":"Authorization","in":"header"},"bearerAuth":{"type":"http","description":"Pass the value as JWT Bearer Token.","scheme":"bearer"}}}}