POST/v3/live/person/synchronous/match

Match

Accepts a person match request with required full name and optional multiple companies, domains, and emails. Returns possible matches limited to 250 results.

Version
v3Open on v2
Rate limit
Tier 3 · 10–200 rps by plan
Billing
Person Search · Match

Request body

  • companyDomainsstring[]Optional
    Current or former employer domains of the person.
    henryschein.comaggknowledge.ai
    Enter adds a value · Backspace on empty removes the last
  • companyNamesstring[]Optional
    Current or former employer names of the person; a person matches on any one of them. Each name is resolved to an AggKnowledge company, so typos, aliases and legal suffixes all match. Each name is also matched against the employer recorded on the work experience itself, which reaches employers we hold no company record for. At most 10 values.
    henry scheinaggknowledge
    Enter adds a value · Backspace on empty removes the last
  • emailAddressesstring[]Optional
    Current or former email addresses of the person.
    dan.entrup@example.comd.entrup@example.org
    Enter adds a value · Backspace on empty removes the last
  • fullNamestringOptional
    The person's full name. Either fullName or socialMediaUrl must be provided. A name too long to evaluate is rejected with a 400.
  • jobTitlesstring[]Optional
    Job titles held by the person; a person matches on any one of them. When combined with a company criterion, a single work experience must satisfy both. Bounded by the total number of words rather than by the number of titles, so one long title costs as much as several short ones; a list too large to evaluate is rejected with a 400.
    co-founderchief technology officer
    Enter adds a value · Backspace on empty removes the last
  • socialMediaUrlstringOptional
    Social Media URL of the person. Either fullName or socialMediaUrl must be provided.
  • locationCitystringOptional
    City where the person is located. A filter: only people recorded in exactly this city are returned.
  • locationCountrystringOptional
    Country where the person is located, as a name or an ISO code ("united states", "US", "USA"). A filter: only people recorded in this country are returned.
  • locationStateOrProvincestringOptional
    State or province where the person is located, spelled out in full ("california", not "CA"). A filter: only people recorded in exactly this state or province are returned.
  • aggkCompanyIdsstring[]Optional
    AggKnowledge company IDs of current or former employers of the person.
  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
Headers
x-api-key Required · API key for authentication

Response

  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • resultsobject[]
    People matched to the request

Status codes