Lookup V2

Get TIN search results

Changed on

This endpoint returns the results of a previously submitted TIN search request. The status field indicates whether processing is complete:

  • "running" — the search is still in progress; poll again later.
  • "completed" — results are available in the search.results array.
get/lookup/v2/single-searches/{id}

Request

  • Base URL
    https://api-demo.fonoa.com
  • URL
    https://api-demo.fonoa.com/lookup/v2/single-searches/{id}
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

idstring uuid required

The tin_search_id value returned by the POST /lookup/v2/single-searches response

Response

The TIN search request was found. Check status to determine whether results are ready.

status'running' | 'completed' required

Example response

{
  "search": {
    "id": "b470a195-8e83-4d89-b4a7-4d389ac358a4",
    "country_iso_code": "cl",
    "query": "Fonoa Technologies",
    "requested_at": "2024-01-15T10:30:00.000Z",
    "additional_parameters": {
      "address": "Barrow Street Dublin 4"
    },
    "results": [
      {
        "tin_search_result_id": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
        "name": "FONOA TECHNOLOGIES LIMITED",
        "tax_identification_number": "IE3717232WH",
        "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_similarity_score": 100,
        "address_fuzzy_matching_similarity_score": 62,
        "business_registration_number": "123456",
        "additional_data": {
          "france_siret": "73282932000074",
          "italy_codice_fiscale": "RSSMRA80A01H501U",
          "italy_pec_address": "example@pec.it",
          "brazil_fantasy_name": "FONOA BRAZIL",
          "colombia_check_digit": "7",
          "colombia_large_taxpayer": "GRAN CONTRIBUYENTE",
          "colombia_tin_without_check_digit": "900123456"
        }
      }
    ]
  }
}

Changes

    • warning

      added the new AUTHENTICATION_ERROR enum value to the // response property for the response status

    • warning

      added the new AUTHENTICATION_ERROR enum value to the // response property for the response status

    • warning

      added the new AUTHENTICATION_ERROR enum value to the // response property for the response status

    • warning

      added the new Aquis. Intracom. por Opção enum value to the /// response property for the response status

    • warning

      added the new BATCH_REQUEST_CANNOT_BE_EMPTY enum value to the // response property for the response status

    • warning

      added the new BATCH_REQUEST_CANNOT_BE_EMPTY enum value to the // response property for the response status

    • warning

      added the new BATCH_REQUEST_CANNOT_BE_EMPTY enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_RESULTS enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_RESULTS enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_RESULTS enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_SEARCHES enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_SEARCHES enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_SEARCHES enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_TINS enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_TINS enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_MORE_THAN_X_TINS enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_ZERO_ENTRIES enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_ZERO_ENTRIES enum value to the // response property for the response status

    • warning

      added the new CANNOT_HAVE_ZERO_ENTRIES enum value to the // response property for the response status

    • warning

      added the new CANNOT_REQUEST_MORE_THAN_X_RESULTS enum value to the // response property for the response status

    • warning

      added the new CANNOT_REQUEST_MORE_THAN_X_RESULTS enum value to the // response property for the response status

    • warning

      added the new CANNOT_REQUEST_MORE_THAN_X_RESULTS enum value to the // response property for the response status

    • warning

      added the new COUNTRIES_NOT_ALLOWED enum value to the // response property for the response status

    • warning

      added the new COUNTRIES_NOT_ALLOWED enum value to the // response property for the response status

    • warning

      added the new COUNTRIES_NOT_ALLOWED enum value to the // response property for the response status

    • warning

      added the new COUNTRY_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new COUNTRY_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new COUNTRY_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new CSV_COLUMN_MISMATCH_ERROR enum value to the // response property for the response status

    • warning

      added the new CSV_COLUMN_MISMATCH_ERROR enum value to the // response property for the response status

    • warning

      added the new CSV_COLUMN_MISMATCH_ERROR enum value to the // response property for the response status

    • warning

      added the new CSV_COUNTRY_CODE_FORMAT_ERROR enum value to the // response property for the response status

    • warning

      added the new CSV_COUNTRY_CODE_FORMAT_ERROR enum value to the // response property for the response status

    • warning

      added the new CSV_COUNTRY_CODE_FORMAT_ERROR enum value to the // response property for the response status

    • warning

      added the new CSV_FILE_NOT_PROVIDED enum value to the // response property for the response status

    • warning

      added the new CSV_FILE_NOT_PROVIDED enum value to the // response property for the response status

    • warning

      added the new CSV_FILE_NOT_PROVIDED enum value to the // response property for the response status

    • warning

      added the new CSV_GENERIC_PARSING_ERROR enum value to the // response property for the response status

    • warning

      added the new CSV_GENERIC_PARSING_ERROR enum value to the // response property for the response status

    • warning

      added the new CSV_GENERIC_PARSING_ERROR enum value to the // response property for the response status

    • warning

      added the new CURSOR_PARSING_ERROR enum value to the // response property for the response status

    • warning

      added the new CURSOR_PARSING_ERROR enum value to the // response property for the response status

    • warning

      added the new CURSOR_PARSING_ERROR enum value to the // response property for the response status

    • warning

      added the new DIRECT_TAX_ID_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new DIRECT_TAX_ID_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new DIRECT_TAX_ID_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new INTERNAL_ERROR enum value to the // response property for the response status

    • warning

      added the new INTERNAL_ERROR enum value to the // response property for the response status

    • warning

      added the new INTERNAL_ERROR enum value to the // response property for the response status

    • warning

      added the new INVALID_FIELD_FORMAT enum value to the // response property for the response status

    • warning

      added the new INVALID_FIELD_FORMAT enum value to the // response property for the response status

    • warning

      added the new INVALID_FIELD_FORMAT enum value to the // response property for the response status

    • warning

      added the new INVALID_ID_ERROR enum value to the // response property for the response status

    • warning

      added the new INVALID_ID_ERROR enum value to the // response property for the response status

    • warning

      added the new INVALID_ID_ERROR enum value to the // response property for the response status

    • warning

      added the new INVALID_MIME_ONLY_FORM_DATA_IS_VALID enum value to the // response property for the response status

    • warning

      added the new INVALID_MIME_ONLY_FORM_DATA_IS_VALID enum value to the // response property for the response status

    • warning

      added the new INVALID_MIME_ONLY_FORM_DATA_IS_VALID enum value to the // response property for the response status

    • warning

      added the new INVALID_MIME_ONLY_JSON_IS_VALID enum value to the // response property for the response status

    • warning

      added the new INVALID_MIME_ONLY_JSON_IS_VALID enum value to the // response property for the response status

    • warning

      added the new INVALID_MIME_ONLY_JSON_IS_VALID enum value to the // response property for the response status

    • warning

      added the new INVALID_REQUEST enum value to the // response property for the response status

    • warning

      added the new INVALID_REQUEST enum value to the // response property for the response status

    • warning

      added the new INVALID_REQUEST enum value to the // response property for the response status

    • warning

      added the new INVALID_VALIDATION_DATABASE_SOURCE enum value to the // response property for the response status

    • warning

      added the new INVALID_VALIDATION_DATABASE_SOURCE enum value to the // response property for the response status

    • warning

      added the new INVALID_VALIDATION_DATABASE_SOURCE enum value to the // response property for the response status

    • warning

      added the new MISSING_QUERY_OR_COUNTRY_ISO_CODE enum value to the // response property for the response status

    • warning

      added the new MISSING_QUERY_OR_COUNTRY_ISO_CODE enum value to the // response property for the response status

    • warning

      added the new MISSING_QUERY_OR_COUNTRY_ISO_CODE enum value to the // response property for the response status

    • warning

      added the new MISSING_TAX_IDENTIFICATION_NUMBER_OR_COUNTRY_ISO_CODE enum value to the // response property for the response status

    • warning

      added the new MISSING_TAX_IDENTIFICATION_NUMBER_OR_COUNTRY_ISO_CODE enum value to the // response property for the response status

    • warning

      added the new MISSING_TAX_IDENTIFICATION_NUMBER_OR_COUNTRY_ISO_CODE enum value to the // response property for the response status

    • warning

      added the new NO_BATCH_FOUND enum value to the // response property for the response status

    • warning

      added the new NO_BATCH_FOUND enum value to the // response property for the response status

    • warning

      added the new NO_BATCH_FOUND enum value to the // response property for the response status

    • warning

      added the new NO_VALIDATION_FOUND enum value to the // response property for the response status

    • warning

      added the new NO_VALIDATION_FOUND enum value to the // response property for the response status

    • warning

      added the new NO_VALIDATION_FOUND enum value to the // response property for the response status

    • warning

      added the new TAX_IDENTIFICATION_NUMBER_TYPE_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new TAX_IDENTIFICATION_NUMBER_TYPE_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new TAX_IDENTIFICATION_NUMBER_TYPE_NOT_SUPPORTED enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_NOT_FOUND enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_NOT_FOUND enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_NOT_FOUND enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_NOT_SUPPORTED_FOR_SUBSCRIPTION enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_NOT_SUPPORTED_FOR_SUBSCRIPTION enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_NOT_SUPPORTED_FOR_SUBSCRIPTION enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_QUERY_LENGTH_INVALID enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_QUERY_LENGTH_INVALID enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_QUERY_LENGTH_INVALID enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_WORD_COUNT_INVALID enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_WORD_COUNT_INVALID enum value to the // response property for the response status

    • warning

      added the new TIN_SEARCH_WORD_COUNT_INVALID enum value to the // response property for the response status

    • warning

      added the new UNSUPPORTED_CSV_COLUMNS enum value to the // response property for the response status

    • warning

      added the new UNSUPPORTED_CSV_COLUMNS enum value to the // response property for the response status

    • warning

      added the new UNSUPPORTED_CSV_COLUMNS enum value to the // response property for the response status

    • warning

      added the new UNSUPPORTED_PARAMETER_ERROR enum value to the // response property for the response status

    • warning

      added the new UNSUPPORTED_PARAMETER_ERROR enum value to the // response property for the response status

    • warning

      added the new UNSUPPORTED_PARAMETER_ERROR enum value to the // response property for the response status

    • warning

      added the new US_BOTH_FIRST_LAST_NAME_REQUIRED enum value to the // response property for the response status

    • warning

      added the new US_BOTH_FIRST_LAST_NAME_REQUIRED enum value to the // response property for the response status

    • warning

      added the new US_BOTH_FIRST_LAST_NAME_REQUIRED enum value to the // response property for the response status

    • warning

      added the new US_UNSUPPORTED_PARAMETER_FOR_BUSINESS enum value to the // response property for the response status

    • warning

      added the new US_UNSUPPORTED_PARAMETER_FOR_BUSINESS enum value to the // response property for the response status

    • warning

      added the new US_UNSUPPORTED_PARAMETER_FOR_BUSINESS enum value to the // response property for the response status

    • warning

      added the new US_UNSUPPORTED_PARAMETER_FOR_INDIVIDUAL enum value to the // response property for the response status

    • warning

      added the new US_UNSUPPORTED_PARAMETER_FOR_INDIVIDUAL enum value to the // response property for the response status

    • warning

      added the new US_UNSUPPORTED_PARAMETER_FOR_INDIVIDUAL enum value to the // response property for the response status

    • warning

      added the new VALIDATIONS_AMOUNT_EXCEEDED enum value to the // response property for the response status

    • warning

      added the new VALIDATIONS_AMOUNT_EXCEEDED enum value to the // response property for the response status

    • warning

      added the new VALIDATIONS_AMOUNT_EXCEEDED enum value to the // response property for the response status

    • warning

      added the new VALIDATION_SOURCE_NOT_SUPPORTED_FOR_COUNTRY enum value to the // response property for the response status

    • warning

      added the new VALIDATION_SOURCE_NOT_SUPPORTED_FOR_COUNTRY enum value to the // response property for the response status

    • warning

      added the new VALIDATION_SOURCE_NOT_SUPPORTED_FOR_COUNTRY enum value to the // response property for the response status

    • info

      added the media type application/json for the response with the status