POST/v2/live/person/enrich

Enrich

Accepts a person enrichment request and returns enriched person data including work experience, location, skills, and full company details. Provide at least one of professionalSocialMediaUrl, pdlId, or personId.

Version
v2
Rate limit
Tier 1 · 10–100 rps by plan
Billing
Person Enrichment · Enrich

Request body

  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
  • pdlIdstringOptional
    The person's PDL ID.
  • personIdinteger (int64)Optional
    The AggKnowledge person ID.
  • professionalSocialMediaUrlstringOptional
    LinkedIn URL of the person. Protocol and subdomain are optional, this value will be normalized server-side. Sales Nav and Recruiter URLs are allowed.
  • freshnessenum PersonEnrichmentFreshnessOptional
    Controls whether to use cached data regardless of age. FRESH (default) re-scrapes stale profiles; CACHED returns stored data without a freshness check.
  • linkedinUrlstringOptional
    Legacy name for professionalSocialMediaUrl. Send one profile identifier per request
  • linkedinUsernamestringOptional
    Profile username, an alternative to professionalSocialMediaUrl. Send one profile identifier per request: which one wins when several are sent differs by endpoint
Headers
x-api-key Required · API key for authentication

Response

  • dataobject
    The enriched person data, if the request was successful.
    • biostring
      Person biography
    • dateLastUpdatedstring
      Date the person's data was last refreshed
    • firstNamestring
      Person first name
    • idinteger (int64)
      AggKnowledge Person ID
    • lastNamestring
      Person last name
    • linkedinUrlstring
      Normalized Linkedin URL
    • linkedinUsernamestring
      Normalized Linkedin username
    • locationCitystring
      Location city
    • locationCountrystring
      Location country
    • locationMetrostring
      Location metro area
    • locationPostalCodestring
      Location postal code
    • locationStateOrProvincestring
      Location state or province
    • middleNamestring
      Person middle name
    • primaryWorkExperienceIdinteger (int64)
      The person's primary work experience ID. If present, this ID will be in the work experience list. If not present, we were unable to determine which work experience should be considered primary.
    • tagsobject[]
      List of tags associated with the person
    • workExperienceobject[]
  • inputParametersobject
    Caller-supplied inputs echoed back in the response
  • isRetryableboolean
    When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
  • isSuccessboolean
    true when the request was answered with a result. false means no result was returned: check isRetryable, which is true when a data source failed or timed out and false when the input matched nothing.
  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • problemsobject
    If hasProblems is true, this field will describe which problems were encountered.
  • hasProblemsboolean
    Whether we hit a problem answering the request: the profile or company wasn't found, or a data source failed or timed out. Data may be missing or incomplete; problems, where the response has it, says which.

Status codes