Skip to main content
POST
Buyer Screening

Overview

The Buyer Screening API generates a long list of potential buyers for a given target company, enriched with structured data. Optionally, you can refine the output by specifying buyer type, company type, geography, and a detailed query to narrow the strategic criteria. Returns a request_id as a response.

Endpoint Details

  • Method: POST
  • Endpoint: /api/enterprise/buyer-screening/enrich/

Authentication Requirements

  • Include a valid JWT token in your request header
  • If you don’t have a token yet, you can get one from the /auth/token/ endpoint first.

Request

Header Parameters

string
required
JWT token obtained from the Authentication request

Body Parameters

string
required
Permalink of the target company or its complete URL (e.g. "acme-solar" OR "https://www.acmesolar.in/")
object
Filter parameters object. All fields inside are optional, but must always be included in the request body — send empty values ("", []) for any fields you do not want to filter on.
string
A descriptive query to refine the buyer search scope and strategic criteria.
string[]
Type of buyer to target. Pass an empty array to include all buyer types.Accepted values: "strategic", "financial"
string
Type of company to include. Accepted values: "private", "public", "all"
string[]
Geographic scope as ISO country codes. (e.g. ["USA", "GBR"])

Response

A successful response returns a request_id that can be used to track the status of the request.

Successful Response Fields

string
Unique identifier for the request posted. Use this with the /api/enterprise/request/status/ endpoint to check the status

Authorizations

Authorization
string
header
required

JWT token obtained from the /auth/token/ endpoint.

Body

application/json
company
string
required

Permalink or URL of the target company being sold/acquired.

Example:

"acme-security"

parameters
object

Optional filter parameters. All fields must always be included in the request body — send empty values for any fields you do not want to filter on.

Response

202 - application/json

Request accepted

request_id
string<uuid>
Example:

"931643e9-b6c7-45d4-9ba9-bd3b534221e7"

status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
Example:

"PENDING"