AI agent instructions
AI agent instructions
POST /data/people/enrich takes whatever you know about a person and returns the matching profile. The more clues you send, the better the match.
Try it in the Console
Try this API in the playground, no code needed.
Quick start
match.status first:
candidate:scoreis the match confidence andpersonis the profile.personcan includename,email,avatar_url,bio,location,social_urls,website_urls,current_role,experience,education,skillsandlast_updated.not_found: no one matched.scoreandpersonarenull.
partial: true means the result is incomplete.
Parameters
Send at least one clue. All fields are optional.string[]
Social profile URLs for the person.
object
first and last.string
The person’s email address.
object
name and/or domain of their employer.object[]
Each item can have
institution (name and/or domain), degree, field_of_study and graduation_year.object
city, region and country.object
milliseconds and behavior: fail (default) returns an error on timeout, return-partial returns what was found.string
enabled or disabled (default). See common parameters.string[]
Free-form labels attached to the request.