Skip to main content
POST
Person Enrichment - People Data Labs

Authorizations

Authorization
string
header
default:YOUR_ANYAPI_KEY
required

Your AnyAPI key as a Bearer token.

Headers

Idempotency-Key
string

Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict.

Required string length: 1 - 255

Query Parameters

fields
string

Optional. Comma-separated keys (dotted paths like author.name descend into nested objects) to keep on each result item. Keys are matched relative to each result item after the data/items envelope is unwrapped, not against the top-level response envelope, so use jq to reshape the whole envelope. Shrinks the response without changing cost.

max_items
integer

Optional. Cap the number of result rows returned; a _truncated note reports how many were withheld so you can page via the API's own limit. Does not change cost.

Required range: x >= 0
summary
boolean

Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost.

jq
string

Optional. A jq expression applied to the result envelope; its output replaces output (multiple outputs collect into an array). Reshape freely, e.g. jq=.data | {title, description, md: .markdown[:3500]}. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a jqError. Does not change cost.

max_cost_usd
string

Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price.

Body

application/json
profile
string
required

Social profile URL the person has used, e.g. a LinkedIn, Twitter, Facebook or GitHub profile. The strongest single identifier.

birthDate
string

Known birth date, to disambiguate a name match.

company
string

Company name, website or social URL where the person has worked.

country
string

Country to match on.

dataInclude
string

Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; it does not reduce what the call costs.

email
string<email>

Any email address the person has used.

emailHash
string

SHA-256 or MD5 hash of an email address, for privacy-preserving matching.

firstName
string

First name. Send with lastName plus company, school or location.

includeIfMatched
boolean

Report which of the sent identifiers actually matched.

lastName
string

Last name. Send with firstName plus company, school or location.

linkedinId
string

LinkedIn numeric member id (PDL calls this lid).

locality
string

City or locality to match on.

location
string

Free-form location string, e.g. brookline, massachusetts, united states.

middleName
string

Middle name.

minLikelihood
integer

Minimum People Data Labs likelihood score a match must reach to count as found. Omitted, this SKU sends 6; the People Data Labs default is 2.

Required range: 1 <= x <= 10
name
string

Full name, as an alternative to firstName plus lastName.

pdlId
string

People Data Labs persistent person id, as returned by this SKU's pdlId output.

phone
string

Phone number in international form, e.g. +16176695906.

postalCode
string

Postal or ZIP code to match on.

preferLatencyUnderMs
integer

Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted.

Required range: x >= 1
region
string

State or region to match on.

required
string

People Data Labs boolean expression over top-level fields that a match must satisfy, e.g. personal_emails or (emails and phone_numbers).

school
string

School the person attended, used to disambiguate a name match.

streetAddress
string

Street address to match on.

titlecase
boolean

Return text in title case instead of People Data Labs' lowercase default.

Response

Normalized result.

costUsd
number
required

USD charged on the original run. On a replay this value is echoed for parity; the replay itself is free.

items
integer
required

Number of result rows returned. For per-result SKUs the per-item cost is charged against this count; for input-priced SKUs the charge is per submitted input, independent of this count.

output
Person Enrichment - People Data Labs output · object | null
required

Normalized output, or null when the replay payload was not retained.

provider
string
required

Always "AnyAPI".

replayed
boolean
required

True when this response replays the durable result of an earlier run without billing or upstream execution.

hint
string

Optional one-line nudge, absent when there is nothing to say. large_result: suggests the fields/max_items/summary/jq controls for a big response. paging_unavailable: means this result came from a source that cannot return a nextCursor, so it may be INCOMPLETE and cannot be continued - re-run with requireCursor: true to be served only by a source that can page, which may cost more per request.

jqError
string

Present only when a jq expression failed; output then carries the full unshaped result and this explains why the reshape did not apply.

resultId
string

Opaque handle to the full unshaped result, cached ~15 min. Re-shape it for free (fields/max_items/summary/jq) via GET /v1/results/{id}, no re-billing. Absent when the result was too large to cache.