v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB

Lookup V1

Get result of batch validation

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

"completed" - validation for that request finished.
"running" - 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/batches/{batch_id}

Query parameters

pagenumber

Page number

page_sizestring

Number of entries on page

Response

Batch result

status'completed' | 'running' | 'canceled' required

completion_percentageinteger required

requestedstring date-time required

Example response

{
  "completion_percentage": 100,
  "validations": [
    {
      "id": "077e50b3-c323-4082-8457-3a4fd003a230",
      "tin": "100070008",
      "country_iso": "cl",
      "company_name": "ACME",
      "requested": "2022-05-19T13:03:44.667Z",
      "last_checked_online": "2022-05-19T13:03:45.076Z",
      "error_code": 1,
      "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."
      }
    }
  ],
  "requested": "2021-03-25T09:37:41.649Z"
}