Skip to main content
POST
Submit a company

Authorizations

X-API-Key
string
header
required

Your brk_live_ API key.

Headers

Idempotency-Key
string | null

Body

application/json
input
string
required

A LinkedIn company URL (linkedin.com/company/<slug-or-id>) or a bare numeric company id. Bare name/domain is not accepted yet → 400 (a later resolver layer).

Example:

"linkedin.com/company/anthropic"

operation
string
default:target_people

Job type — v1 supports only target_people.

Example:

"target_people"

callback_url
string | null

Optional HTTPS webhook — POSTed with the result when the job is done. Loopback/private literal IP addresses and URLs with embedded credentials are rejected.

Example:

"https://your-server.com/hooks/firmintent"

persona
string | null

Required existing persona slug (from GET /v1/personas). Missing returns 400 persona_required; unknown returns 400 persona_not_found.

Example:

"owners-founders"

Response

Successful Response

job_id
string
required
Example:

"b24585c3-1f2a-4c0e-9a1b-2d3e4f5a6b7c"

status
string
default:processing
Allowed value: "processing"
Example:

"processing"