Skip to main content
POST
people.profile.details-extended

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
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
email
string

Work or personal email address used as an identity hint.

Required string length: 1 - 320
profileUrl
string

Public social profile URL used as an identity hint.

companyName
string

Current or past employer name.

Required string length: 1 - 256
middleName
string

Middle name.

Required string length: 1 - 128
phone
string

Private phone number with explicit international country code.

Required string length: 1 - 64
Pattern: ^\+[1-9][0-9 ()-]{5,62}$
emailHash
string

MD5 or SHA-256 hash of an email address.

Required string length: 1 - 64
Pattern: ^(?:[a-f0-9]{32}|[a-f0-9]{64})$
socialProfileId
string

Numeric identifier of a public professional social profile.

Required string length: 1 - 32
Pattern: ^[0-9]+$
school
string

School name, website or public profile.

Required string length: 1 - 256
location
string

Residential place used as an identity hint.

Required string length: 1 - 256
streetAddress
string

Residential street address used as an identity hint.

Required string length: 1 - 256
city
string

Residential city.

Required string length: 1 - 128
region
string

Residential region.

Required string length: 1 - 128
country
string

Residential country name.

Required string length: 1 - 128
postalCode
string

Residential postal code; send country too.

Required string length: 1 - 32
birthDate
string

Birth year or birth date YYYY-MM-DD used as an identity hint.

Required string length: 1 - 10
Pattern: ^\d{4}(?:-\d{2}-\d{2})?$
groups
enum<string>[]

Explicit field groups. Default professional. Private contact, address, demographic and compensation groups are opt-in. Histories and arrays are capped at 50 entries.

Required array length: 1 - 12 elements

One field group.

Available options:
professional,
employmentHistory,
education,
skills,
languages,
socialProfiles,
workEmail,
personalEmails,
phones,
residentialAddresses,
demographics,
compensation

Response

The result

person
object
required

Matched person and requested groups.