v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB

Lookup V1

Get result of validation

This endpoint provides Tax Identification Number validation results. To access it you need to use an ID returned from the “Request a validation” endpoint. It consists of a validation results and status which can hold 3 states:

"completed" - validation for that request finished.
"pending" - validation process for that request is still in progress, you should check its results again.
"canceled" - validation process for that request has been canceled by user when validation is part of canceled batch validation.

get/lookup/v1/validations/{id}

Path parameters

idstring required

An "id" value from the validation request response body

Response

The validation request completed. Check the contents to get its result.

status'completed' | 'pending' | 'canceled' required

Example response

{
  "validation": {
    "id": "b470a195-8e83-4d89-b4a7-4d389ac358a4",
    "tin": "123123",
    "country_iso": "cl",
    "error_code": 1,
    "company_name": "ACME",
    "taxpayer": {
      "registration_date": "2017-07-20",
      "deregistration_date": "2017-07-20",
      "address": "Tower A DLF Tower, 4th Floor, DLF INFINTY TOWER, Sector 25A, Gurugram, Haryana, 122002"
    },
    "fuzzy_matching": {
      "taxpayer": {
        "name": {
          "expected": "company name",
          "actual": "company name",
          "similarity_percentage": 100
        },
        "address": {
          "expected": "company name",
          "actual": "company name",
          "similarity_percentage": 100
        }
      }
    },
    "extra_fields": {
      "brazil_fantasy_name": "BAR E LANCHES 111",
      "canada_federal_state": "Federal",
      "colombia_check_digit": "9",
      "colombia_large_taxpayer": "yes",
      "colombia_tin_without_check_digit": "123456789",
      "egypt_uin_expiry_date": "2010-10-10",
      "germany_federal_state": "Berlin",
      "hungary_full_tax_identification_number": "13353298-2-44",
      "india_pan_aadhaar_linked": "not_applicable",
      "india_pan_specified_person": "no",
      "india_trade_name": "ACME TRADE",
      "japan_qualified_invoice_issuer": "yes",
      "mexico_zip_code_used_for_validation": "12345",
      "usa_irs_response": "TIN and Name combination does not match IRS records."
    }
  }
}