Enrich a person
Use a work email as the identity clue. See the Quickstart for authentication and SDK setup.Choose identity clues
Clues are additive: supply reliable additional context to improve matching.
Enrich by work email
Send a work email and any reliable company context toPOST /people/enrich.
Enrich by profile URL
Provide one or more person-profile URLs insocial_urls. Additional company or location clues can help resolve ambiguous profiles.
profiles list as social_urls.
Enrich by name
Names alone are ambiguous. Send both first and last name with at least one company, education, or location clue.institution (name or domain), degree, field_of_study, or graduation_year; valid years range from 1900 to 2200.
For attendee lists, send only the context supplied by the source. Do not invent a company or location to satisfy validation. Check the match score and retain an unresolved state for ambiguous people.
Request options
These fields apply to every enrichment, whichever identity clues you send.
Timeouts explains how the API deadline relates to your client timeout.
Read the result
match.status: "candidate" includes a score and person. Weak candidates can be returned, so choose a score threshold for your workflow and preserve uncertain matches for review. match.status: "not_found" has score: null and person: null. When partial is true, the deadline ended processing and the response holds the usable data completed so far; unfinished fields are omitted.
person.current_role_status is present, none, or unknown. When it is unknown, a missing role is unverified, not evidence that the person has no job.
Dates are objects with a
year and, when known, a month (1–12) and day (1–31). social_urls, website_urls, current_role_status, experience, education, and skills are always present; the lists can be empty. The other fields are optional.
Availability and errors
Insufficient clues return 400; free or disposable email inputs return 422. Handle 408 and transient server errors separately fromnot_found.
ZDR omits hosted avatar URLs; see zero data retention. The reference describes all fields, and the lead enrichment recipe shows how to use the profile.