Skip to main content
POST
people.contacts.enrich

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
email
string

The person's work email address.

Required string length: 1 - 320
linkedinUrl
string

The person's LinkedIn profile URL.

domain
string

Domain of the company the person works at, e.g. figma.com.

fullName
string

The person's full name.

Required string length: 1 - 256
firstName
string

First name; use with lastName when fullName is not known.

Required string length: 1 - 128
lastName
string

Last name; use with firstName.

Required string length: 1 - 128
companyName
string

The person's employer's name.

Required string length: 1 - 256
includePhones
boolean

Also look for mobile numbers. This is the dearer choice, billed on top of the addresses. Default false.

acceptWork
boolean

Look for professional addresses. Default true.

acceptPersonal
boolean

Look for personal, non-work addresses. Default false.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.