Sign in

v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB
Lookup V2

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/v2/batch-validations/{batch_id}

Query parameters

limitnumber

Pagination limit

cursorstring

Pagination cursor

Response

Batch result

status'completed' | 'running' | 'canceled' required
batch_idstring required
batch_namestring
completion_percentageinteger required
requested_atstring date-time required

Example response

{
  "completion_percentage": 100,
  "requested_at": "2021-03-25T09:37:41.649Z",
  "validations": [
    {
      "validation_id": "077e50b3-c323-4082-8457-3a4fd003a230",
      "tax_identification_number": "100070008",
      "country_iso_code": "cl",
      "requested_at": "2022-05-19T13:03:44.667Z",
      "registration_date": "2017-07-20",
      "de_registration_date": "2017-07-20",
      "address": "Tower A DLF Tower, 4th Floor, DLF INFINTY TOWER, Sector 25A, Gurugram, Haryana, 122002",
      "fuzzy_matching": {
        "name": {
          "expected": "company name",
          "similarity_percentage": 100,
          "matched_field": "name"
        },
        "address": {
          "expected": "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.",
        "italy_codice_fiscale_status": "Codice Fiscale valid",
        "italy_vat_split_payment": "no",
        "brazil_status_detail": "Active",
        "brazil_cnae_code": "6201500",
        "brazil_cnae_description": "Desenvolvimento de programas de computador sob encomenda",
        "brazil_secondary_cnaes": [
          {
            "code": "6202300",
            "description": "Desenvolvimento e licenciamento de programas de computador customizaveis"
          }
        ],
        "brazil_municipality": "SAO PAULO",
        "brazil_federal_state": "SP",
        "brazil_neighborhood": "VILA OLIMPIA",
        "brazil_company_size": "Demais",
        "brazil_special_status": "Recuperacao Judicial",
        "brazil_special_status_date": "2023-01-15",
        "brazil_date_of_birth": "1985-03-20",
        "brazil_year_of_death": "2020",
        "brazil_suframa": {
          "number": "123456789",
          "status": "ACTIVE",
          "registration_date": "2020-01-15"
        },
        "brazil_state_registrations": [
          {
            "number": "123456789",
            "federal_state": "SP",
            "enabled": true,
            "registration_date": "2019-05-10",
            "status": "NO_RESTRICTION",
            "type": "IE_NORMAL"
          }
        ],
        "brazil_simples": {
          "optant": "yes"
        },
        "company_representative_name": "John Doe",
        "brazil_status_reason": "Sem motivo",
        "brazil_status_date": "2019-01-01",
        "brazil_address": {
          "street": "RUA EXEMPLO",
          "number": "123",
          "additional_info": "SALA 456",
          "neighborhood": "VILA OLIMPIA",
          "city": "SAO PAULO",
          "state": "SP",
          "postal_code": "04551065",
          "country": "BRASIL",
          "country_code": "076",
          "city_code": "7107"
        },
        "brazil_legal_nature_code": "206-2",
        "brazil_entity_social_capital": "100000000",
        "brazil_email": "contato@empresa.com.br",
        "business_activities": [
          {
            "activity": "ACTIVIDADES DE CONSULTORIA DE INFORMATICA Y DE GESTION DE INSTALACIONE",
            "code": "620200",
            "category": "Primera",
            "subject_to_vat": "yes",
            "registration_date": "05-10-2015"
          }
        ]
      },
      "additional_parameters": {
        "egypt_uin": "10000010066d9770abe966h4vk7H9oj0cd7c8a8",
        "malaysia_id_type": "brn",
        "malaysia_id_value": "X19510100011",
        "nigeria_brn": "1234567"
      },
      "tax_identification_number_name": "Système d’Identification du Répertoire des Entreprises (SIREN)"
    }
  ]
}