Skip to main content
POST
/
v1
/
prospects
/
match
Match Prospects
curl --request POST \
  --url https://api.explorium.ai/v1/prospects/match \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "request_context": {},
  "prospects_to_match": [
    {
      "business_id": "b197ffdef2ddc3308584dce7afa3661b",
      "full_name": "hey Explorium",
      "company_name": "Explorium",
      "email": "example@explorium.com",
      "phone_number": "+17752401029",
      "linkedin": "https://www.linkedin.com/company/explorium-ai/"
    }
  ]
}'
{
  "response_context": {
    "correlation_id": "<string>",
    "request_status": "success",
    "time_took_in_seconds": 123
  },
  "total_results": 123,
  "total_matches": 1,
  "matched_prospects": []
}

Introduction

The Match Prospects endpoint allows users to accurately match individual prospects to unique Prospect IDs using multiple fetchers, such as email, phone number, LinkedIn profile, or name and company combination. This ensures accurate lead identification and enhances sales and marketing workflows. Key Benefits:
  • Match and validate lead data across multiple fetchers.
  • Enhance B2B prospecting by linking leads to business profiles.
  • Improve lead scoring and segmentation with high-quality matches.
  • Reduce data duplication and inconsistencies.

Endpoint: POST /v1/prospects/match

  1. Input: Provide a list of prospects with at least one fetcher (e.g., email, phone number, LinkedIn URL, or name & company).
  2. Processing: The system cross-references internal datasets and returns the best possible matches.
  3. Output: A structured response with matched Prospect IDs, maintaining the same order as the input list.

Request Schema

FieldTypeDescription
prospects_to_match:ArrayA list of prospect fetchers to match
emailStringThe prospect’s email address
phone_numberStringThe prospect’s phone number
full_nameStringThe prospect’s full name (must be accompanied by company_name)
company_nameStringThe prospect’s company name (must be accompanied by full_name)
linkedinStringLinkedIn profile URL
business_id (optional)StringFilters the match to a specific company
full_name must be accompanied with company_name
Bash
curl -X POST "https://api.explorium.ai/v1/prospects/match" \
  -H "API_KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "request_context": {
    "sample": "sample"
  },
  "prospects_to_match": [
    {
      "business_id": "19fbe842a2e51db95d4f92333f2cc63a",
      "linkedin": "https://www.linkedin.com/in/russell-lumpkin-07585b128"
    },
    {
      "full_name": "tim cook",
      "company_name": "Apple"
    },
    {
      "email": "satyan@microsoft.com"
    }
  ]
}
'
JSON
{
  "response_context": {
    "correlation_id": "a30a507872c64b428f067115aaf64cad",
    "request_status": "success",
    "time_took_in_seconds": 1.627
  },
  "total_results": 3,
  "total_matches": 3,
  "matched_prospects": [
    {
      "input": {
        "business_id": "19fbe842a2e51db95d4f92333f2cc63a",
        "full_name": null,
        "company_name": null,
        "email": null,
        "phone_number": null,
        "linkedin": "https://www.linkedin.com/in/russell-lumpkin-07585b128"
      },
      "prospect_id": "6ffd52c681452e2da8aac7ec3efb174f4604734c"
    },
    {
      "input": {
        "business_id": null,
        "full_name": "tim cook",
        "company_name": "Apple",
        "email": null,
        "phone_number": null,
        "linkedin": null
      },
      "prospect_id": "07352d784dc9e77b06b2517dec224b53e4f482dd"
    },
    {
      "input": {
        "business_id": null,
        "full_name": null,
        "company_name": null,
        "email": "satyan@microsoft.com",
        "phone_number": null,
        "linkedin": null
      },
      "prospect_id": "ee936e451b50c70e068e1b54e106cb89173198c4"
    }
  ]
}
  • Use multiple fetchers whenever possible to increase match accuracy.
  • Combine with business_id to refine matches to a specific company.
  • Ensure accurate and up-to-date data for improved results.
  • Handle null values in responses where no match is found.
  • Use the input field when sending multiple queries to match your queries with the results.
For more details on request formats and usage, refer to the API documentation.

Authorizations

api_key
string
header
required

Body

application/json
prospects_to_match
ProspectMatchInput · object[]
required
Required array length: 1 - 40 elements
request_context
object

Response

Successful Response

This is base response model for all responses in partner service.

response_context
object
required
total_results
integer
required

The total_results number matched prospects

Required range: x > 0
total_matches
integer
required

The total number of matches.

Required range: x >= 0
matched_prospects
Matched Prospects · array

A list of matched prospects ids represented by MD5 hashes. May contain None for unmatched items.

  • ProspectMatchOutputWithError
  • ProspectMatchOutput
I