Skip to main content
POST
/
api
/
enterprise
/
buyer-screening
/
enrich
Buyer Screening
curl --request POST \
  --url https://api.wokelo.ai/api/enterprise/buyer-screening/enrich/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company": "acme-security",
  "parameters": {
    "detailed_query": "Looking for strategic acquirers in enterprise software",
    "buyer_type": [
      "strategic"
    ],
    "company_type": "public",
    "geography": [
      "USA"
    ]
  }
}
'
{
    "request_id": "278412f8-87ca-47a9-9d1c-4a62a687eaf6",
    "status": "PENDING"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wokelo.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Authorization
string
required
JWT token obtained from the Authentication request

Body Parameters

company
string
required
Permalink of the target company or its complete URL (e.g. "acme-solar" OR "https://www.acmesolar.in/")
parameters
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.
detailed_query
string
A descriptive query to refine the buyer search scope and strategic criteria.
buyer_type
string[]
Type of buyer to target. Pass an empty array to include all buyer types.Accepted values: "strategic", "financial"
company_type
string
Type of company to include. Accepted values: "private", "public", "all"
geography
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

request_id
string
Unique identifier for the request posted. Use this with the /api/enterprise/request/status/ endpoint to check the status
{
    "request_id": "278412f8-87ca-47a9-9d1c-4a62a687eaf6",
    "status": "PENDING"
}

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"