Lookup by Jurisdiction Code

Learn about tax area lookups by jurisdiction code.

Lookup tax area by jurisdiction code

EndpointMethodKey valueRequired field
/v2/external-jurisdiction-lookupPOSTexternalJurisdictionCodeexternalJurisdictionCode, country

This request retrieves tax area information by using a jurisdiction-defined code. Looks up by using an identifier from a government authority.

Sample request - Lookup by jurisdiction code

{
  "externalJurisdictionCode": "string",
  "country": "string",
  "asOfDate": "2024-03-07"
}

Sample response - Lookup by jurisdiction code

{
  "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-07T19:44:37Z",
    "timeElapsedDetails": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}