---
title: "Match Businesses"
method: POST
path: "/v1/businesses/match"
tags: ["Businesses"]
---

# Match Businesses

`POST /v1/businesses/match`

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.

## Headers

- `tenant` string

## Request body

- BusinessesMatchRequest
  - `request_context` object, nullable
  - `businesses_to_match` BusinessMatchInput[], required
    - `name` string
    - `domain` string
    - `url` string
    - `linkedin_url` string

## Response `200`

Successful Response

- BusinessesMatchResponse — 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 businesses
  - `total_matches` integer, required — The total number of matches.
  - `matched_businesses` union[] — A list of all businesses. If they not matched `business_id` will None.
    - union
      - BusinessMatchOutputWithErrors
        - `input` BusinessMatchInput
          - `name` string
          - `domain` string
          - `url` string
          - `linkedin_url` string
        - `business_id` string
        - `error` string, required
        - `error_type` string, required
      - BusinessMatchOutput
        - `input` BusinessMatchInput
          - `name` string
          - `domain` string
          - `url` string
          - `linkedin_url` string
        - `business_id` string

## Other responses

- `422` — Validation Error

---

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