POST/v2/live/company/enrich

Enrich

Accepts a company enrichment request and returns enriched company data

Version
v2Open on v3
Rate limit
Tier 3 · 10–200 rps by plan
Billing
Company Enrichment · Enrich

Request body

  • companyIdinteger (int64)Optional
    Company ID
  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
  • socialProfilestringOptional
    Social profile URL (the company LinkedIn URL, using either the vanity name or the numeric LinkedIn company ID). This value will be normalized server-side.
  • socialProfileIdstringOptional
    Social profile ID (the numeric LinkedIn company ID)
  • websitestringOptional
    Company website
Headers
x-api-key Required · API key for authentication

Response

  • asyncOperationsobject
    If hasAsyncOperations is true, this field will describe which async operations are in progress.
    • isUpdatingCompetitorsboolean
      Whether the company's competitors are being updated asynchronously.
    • isUpdatingDescriptionboolean
      Whether the company description is being updated asynchronously.
    • isUpdatingProductsboolean
      Whether the company's products are being updated asynchronously.
  • dataobject
    Complete company details including competitors and ultimate parent.
  • 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.
  • hasAsyncOperationsboolean
    Whether the request triggered asynchronous data updates. If true, check asyncOperations for which async operations are in progress.
  • 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