Request
Response
Your request returns a Job. When a single-person Job reachessucceeded, its result holds the researched fields. For a batch, or to read the same record as an item, use GET /v1/jobs/{job_id}/items.
Item response
Parameters
Send exactly one ofperson, people or input_file_id.
Known information about a person. Accepts any attributes, including
name, company, email, linkedin_url and location.Fields to return. See Field descriptions.
Research depth. See Tiers.
If true, scores each researched field from 0 to 100 and includes a justification and source URLs in
enrichment_field_confidence. If false or omitted, does not enable additional field scoring. The xhigh tier can return field confidence from its research when available, regardless of this option. See Confidence Scoring.HTTPS callback URL. See Outgoing Webhooks.
custom_id on each record to match the result to your own records.
Tiers
Field descriptions
Specify each output field underfields. Use a description string or an object with description and type.
"The person's primary work email" instead of "email".
Set a type when your code depends on the shape of the value:
See Fields & Type Casting for every type, nested objects and missing values.
Image fields
Onhigh and xhigh, request a headshot with {"headshot": "A recent photo of the person"} in fields.
The item’s result.headshot is a link to the image.
Media links work while Sixtyfour retains your data. They need no API key unless your organization uses customer-managed encryption. See Legacy media options for access details and PDF captures.
The xhigh tier
xhigh uses the Atlas investigation engine for extended research. Allow more time than for other tiers. Its result adds two fields:
See Atlas for budgets, continuing research and reports.
Try it
Open the People Intelligence API Reference playground.
Related
For older requests and options, see Legacy People Intelligence.