Skip to main content
POST
/
api
/
v1
/
buyers
curl --request POST \
  --url https://integrations.polinate.ai/api/v1/buyers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>' \
  --data '
{
  "buyer": {
    "name": "Acme Pty Ltd",
    "legalName": "Acme Pty Ltd"
  }
}
'
{
  "success": true,
  "phantomId": "phm_123",
  "partnershipId": "prt_123"
}

Headers

​
X-Business-Id
string
required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

​
X-API-Key
string
required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

​
Idempotency-Key
string

Idempotency key for POST operations

Example:

"{{idempotencyKey}}"

Body

application/json
​
buyer
object
required
​
partnershipStatus
enum<string>
Available options:
DECLINED,
PENDING,
REVIEW,
ACTIVE,
PAUSED,
SUSPENDED,
EXPIRED,
TERMINATED
​
phones
object[]
​
emails
object[]
​
locations
object[]

Response

Created

​
success
boolean
required
​
phantomId
string
required
​
partnershipId
string
required