POST/v3/live/person/synchronous/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 socialProfile, pdlId, or personId.

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

Request body

  • 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.
  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
  • personIdstringOptional
    The AggKnowledge person ID.
  • socialProfilestringOptional
    Social profile URL of the person. Protocol and subdomain are optional; we normalize the URL server-side. Sales Navigator lead URLs and Recruiter /talent/profile/ URLs are also accepted.
Headers
x-api-key Required · API key for authentication

Response

  • dataobject
    The enriched person data, if the request was successful.
    • aggkPersonIdstring
      AggKnowledge Person ID
    • biostring
      Person bio, self-reported by person
    • dateLastUpdatedstring
      Date the person's data was last refreshed
    • educationobject[]
    • estimatedProfileCreationYearinteger
      Year by which the person's social profile existed, estimated from the profile's identifier. 2016 means 2016 or earlier. Absent when the profile cannot be dated.
    • firstNamestring
      Person first name
    • lastNamestring
      Person last name
    • locationCitystring
      Location city
    • locationCountrystring
      Location country
    • locationMetrostring
      Location metro area
    • locationPostalCodestring
      Location postal code
    • locationStateOrProvincestring
      Location state or province
    • middleNamestring
      Person middle name
    • primaryWorkExperienceIdstring
      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.
    • socialProfilestring
      Normalized social profile URL. Absent when the person has no social profile on file.
    • socialProfileUsernamestring
      Normalized social profile username. Absent when the person has no social profile on file.
    • workExperienceobject[]
  • 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.
  • 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.

Status codes