Lookup by Coordinates

Learn about tax area lookups by coordinates.

⚠️

Caution:

This lookup request is not currently available for O Series Cloud deployments.

Lookup tax area by coordinates

EndpointMethodKey valueRequired fields
/v2/coordinates-lookupPOSTcoordinatescoordinates, latitude, longitude

This request retrieves tax area information by using the latitude and the longitude as the criteria. The coordinates lookup process takes a latitude and a longitude and attempts to determine possible Vertex-defined tax areas and associated jurisdictions.

Sample request - Lookup by coordinates

{
  "asOfDate": "2024-03-07",
  "coordinates": {
    "latitude": 40.216818,
    "longitude": -75.489423
  }
}

Sample response - Lookup by coordinates

{
  "data": {
    "lookupResults": [
      {
        "addressCleansingResultMessages": [
          {
            "code": "string",
            "type": "string",
            "value": "string"
          }
        ],
        "asOfDate": "2024-03-07",
        "confidenceIndicator": "string",
        "jurisdictions": [
          {
            "effectiveDate": "2024-03-07",
            "expirationDate": "2024-03-07",
            "externalJurisdictionCode": "string",
            "jurisdictionId": "string",
            "jurisdictionType": "APO",
            "value": "string"
          }
        ],
        "postalAddresses": [
          {
            "city": "string",
            "country": "string",
            "mainDivision": "string",
            "postalCode": "string",
            "streetAddress1": "string",
            "streetAddress2": "string",
            "subDivision": "string"
          }
        ],
        "statuses": [
          {
            "lookupResult": "NORMAL",
            "value": "string"
          }
        ],
        "taxAreaId": "string"
      }
    ]
  },
  "meta": {
    "app": "string",
    "timeElapsed(ms)": 0,
    "timeReceived": "2024-03-07T14:59:09Z",
    "timeElapsedDetails": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}