> ## 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.
# Buyer Screening
> Identifies potential acquirers for a target company based on strategic fit criteria.
Returns a `request_id` for async polling.
## 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
JWT token obtained from the Authentication request
### Body Parameters
Permalink of the target company or its complete URL (e.g. `"acme-solar"` OR `"https://www.acmesolar.in/"`)
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.
A descriptive query to refine the buyer search scope and strategic criteria.
Type of buyer to target. Pass an empty array to include all buyer types.
Accepted values: `"strategic"`, `"financial"`
Type of company to include. Accepted values: `"private"`, `"public"`, `"all"`
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
Unique identifier for the request posted. Use this with the `/api/enterprise/request/status/` endpoint to check the status
```json 202 theme={"system"}
{
"request_id": "278412f8-87ca-47a9-9d1c-4a62a687eaf6",
"status": "PENDING"
}
```
## OpenAPI
````yaml POST /api/enterprise/buyer-screening/enrich/
openapi: 3.0.3
info:
title: Wokelo API
description: >
Wokelo provides four categories of APIs for company and market intelligence:
1. **Enrichment** – Company and Industry data using Wokelo database and
alternative data. Supports multi-company requests.
2. **Discovery** – Workflows for specific use-cases such as market map,
target screening, and buyer screening.
3. **Monitoring** – Real-time news monitoring for companies.
4. **Workflow Automation** – Wokelo and custom research workflows executed
within notebooks.
Enrichment and Discovery APIs are managed through async requests; use the
Supporting APIs to track status and export results in JSON.
Workflow APIs are executed within notebooks and support export to PDF, PPT,
DOC, or JSON.
**Authentication:** All endpoints (except `/auth/token/`) require a Bearer
JWT token in the `Authorization` header.
version: 1.0.0
contact:
url: https://docs.wokelo.ai/contact
servers:
- url: https://api.wokelo.ai
description: Production server
security: []
tags:
- name: Authentication
description: Obtain JWT tokens for API access
- name: Enrichment
description: Retrieve structured data for companies and industries
- name: Discovery
description: Identify companies via market maps, buyer and target screening
- name: Monitoring
description: Real-time company news monitoring
- name: Workflow Automation
description: Research notebooks for companies, industries, and custom workflows
- name: Supporting APIs
description: >-
Utility endpoints for search, file upload, request management, and report
retrieval
externalDocs:
description: Official Wokelo API Documentation
url: https://docs.wokelo.ai/overview
paths:
/api/enterprise/buyer-screening/enrich/:
post:
tags:
- Discovery
summary: Buyer Screening
description: >
Identifies potential acquirers for a target company based on strategic
fit criteria.
Returns a `request_id` for async polling.
operationId: buyerScreening
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- company
properties:
company:
type: string
description: Permalink or URL of the target company being sold/acquired.
example: acme-security
parameters:
type: object
description: >-
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.
default: {}
properties:
detailed_query:
type: string
description: >-
A descriptive query to refine the buyer search scope and
strategic criteria.
default: ''
example: Looking for strategic acquirers in enterprise software
buyer_type:
type: array
description: >-
Type of buyer to target. Pass an empty array to include
all buyer types.
uniqueItems: true
items:
type: string
enum:
- strategic
- financial
default: []
example:
- strategic
company_type:
type: string
description: Type of company to include.
enum:
- private
- public
- all
default: ''
example: public
geography:
type: array
description: >-
Geographic scope as ISO country codes (e.g. ["USA",
"GBR"]). Pass an empty array for all geographies.
items:
type: string
default: []
example:
- USA
example:
company: acme-security
parameters:
detailed_query: Looking for strategic acquirers in enterprise software
buyer_type:
- strategic
company_type: public
geography:
- USA
responses:
'202':
description: Request accepted
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncResponse'
security:
- bearerAuth: []
components:
schemas:
AsyncResponse:
type: object
properties:
request_id:
type: string
format: uuid
example: 931643e9-b6c7-45d4-9ba9-bd3b534221e7
status:
type: string
enum:
- PENDING
- PROCESSING
- COMPLETED
- FAILED
example: PENDING
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token obtained from the `/auth/token/` endpoint.
````