Match a list of businesses attributes to ids.
Returns a list of the same length and order as the input list, with the matched ids.

Endpoint: POST /businesses/match

Purpose:

Matches businesses based on a given list of names and domains, returning their unique business IDs if found

Request Schema:

{
  "businesses_to_match": [
    { "name": "Apple", "domain": "apple.com" },
    { "name": "Microsoft", "domain": "microsoft.com" },
    { "name": "not_existing_company", "domain": "none.com" }
  ]
}

Example Request (cURL):

curl -X POST \
  "https://api.explorium.ai/v1/businesses/match" \
  -H "API_KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "businesses_to_match": [
    {
      "name": "apple",
      "domain": "apple.com"
    },
    {
      "name": "non_existing_company",
      "domain": "none.com"
    },
    {
      "name": "microsoft",
      "domain": "microsoft.com"
    }
  ]
}'

Example Response:

{
  "response_context": {
    "correlation_id": "ce96c0dcc7e1461d8e3c49ede476bcd1",
    "request_status": "success",
    "time_took_in_seconds": 3.507
  },
  "total_results": 4,
  "total_matches": 3,
  "matched_businesses": [
    {
      "input": {
        "name": "apple",
        "domain": "apple.com"
      },
      "business_id": "8adce3ca1cef0c986b22310e369a0793"
    },
    {
      "input": {
        "name": "not_existing_company",
        "domain": "none.com"
      },
      "business_id": null
    },
    {
      "input": {
        "name": "microsoft",
        "domain": "microsoft.com"
      },
      "business_id": "a34bacf839b923770b2c360eefa26748"
    }
  ]
}

Schema Explanation:

FieldTypeDescription
businesses_to_matchArrayList of business name-domain pairs to match
business_idStringUnique identifier for the matched business (null if not found)
Language
Credentials
Click Try It! to start a request and see the response here!