---
title: "Match Prospects"
method: POST
path: "/v2/prospects/match"
tags: ["V2Prospects"]
---

# Match Prospects

`POST /v2/prospects/match`

## Request body

- ProspectsMatchRequest
  - `request_context` object, nullable
  - `prospects_to_match` ProspectMatchInput[], required
    - `business_id` string, nullable — Explorium business id
    - `full_name` string, nullable — Full name of the person
    - `company_name` string, nullable — Company name
    - `email` string, nullable — Email address
    - `phone_number` string, nullable — Phone number
    - `linkedin` string, nullable — LinkedIn URL

## Response `200`

Successful Response

- ProspectsMatchResponse — This is base response model for all responses in partner service.
  - `response_context` ResponseContext, required
    - `correlation_id` string, required
    - `request_status` 'success' | 'miss' | 'failure', required — The `RequestStatus` class is an enumeration that defines the possible statuses of a request. This enum is used to indicate whether a request was successful, missed, or failed. It ensures consistent handling of request statuses across the application. Attributes: SUCCESS: Indicates that the request was successfully processed. MISS: Indicates that the request did not find any matching data. FAILURE: Indicates that the request encountered an error or failure.
    - `time_took_in_seconds` number, required
  - `total_results` integer, required — The total_results number matched prospects
  - `total_matches` integer, required — The total number of matches.
  - `matched_prospects` union[] — A list of matched prospects ids represented by MD5 hashes. May contain None for unmatched items.
    - union
      - ProspectMatchOutputWithError
        - `input` ProspectMatchInput, required
          - `business_id` string, nullable — Explorium business id
          - `full_name` string, nullable — Full name of the person
          - `company_name` string, nullable — Company name
          - `email` string, nullable — Email address
          - `phone_number` string, nullable — Phone number
          - `linkedin` string, nullable — LinkedIn URL
        - `prospect_id` string
        - `error` string, required
        - `error_type` string, required
      - ProspectMatchOutput
        - `input` ProspectMatchInput, required
          - `business_id` string, nullable — Explorium business id
          - `full_name` string, nullable — Full name of the person
          - `company_name` string, nullable — Company name
          - `email` string, nullable — Email address
          - `phone_number` string, nullable — Phone number
          - `linkedin` string, nullable — LinkedIn URL
        - `prospect_id` string

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/explorium-ai/apis/partner-service.md) · [All operations](https://skmtc.net/explorium-ai/apis/partner-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/explorium-ai/partner-service/revisions/36dd0c57cea7/schema)