POST/v3/live/company/enrich

Enrich

Accepts a list of company enrichment requests and returns a list of enriched company data

Request body

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

Response

  • dataobject
    Complete company details including competitors, ultimate parent, and subsidiaries.
    • Type of company
    • competitorsobject[]
    • descriptionstring
      Brief description of the company
    • Company display name
    • employeeCountActualinteger (int32)
      Actual number of employees
    • Bucketed number of employees
    • fundingRoundCountinteger (int32)
      Number of funding rounds the company has participated in
    • Total amount of funding raised and publicly disclosed, in USD
    • industryobject
    • isStructuredEntityboolean
      Whether this entity could be matched to a known company
    • Amount of latest funding round, if known
    • Latest funding date
    • Stage of the company's latest funding round
    • socialProfileIdinteger (int64)
      Company social profile ID. Absent when the company has no social profile on file.
    • socialProfilestring
      Normalized company social profile URL. Absent when the company has none on file.
    • namestring
      Normalized company name
    • Primary stock exchange
    • Primary stock ticker
    • ultimateParentobject
      A lightweight representation of an ultimate parent company.
    • websitestring
      Normalized company website
    • cleanedWebsitestring
      Company website without its scheme, leading www., query string or trailing slash. Keeps any subdomain and path.
    • cleanedDomainstring
      Host of the company website, without a leading www. or any path
    • rootDomainstring
      Registrable domain of the company website under the Public Suffix List, e.g. example.co.uk for shop.example.co.uk
    • aggkCompanyIdstring
      Company ID
    • descriptionMetaobject
    • employeeGrowthobject
    • hasMoreProductsboolean
    • hasMoreSubsidiariesboolean
    • locationobject
    • productsOfferedobject[]
    • revenueobject
    • servicesOfferedobject[]
    • subsidiariesobject[]
    • tagsstring[]
      Tags associated with the company
    • totalCompetitorsCountinteger (int32)
    • totalProductsCountinteger (int32)
    • totalSubsidiariesCountinteger (int32)
    • privateEquityInvestorsobject[]
      Private equity firms that hold or held the company, grouped by the organization that owns each firm. Requires the COMPANY_PRIVATE_EQUITY entitlement: without it this is null and withheldFields names it. Empty when the company has no private equity history. Ordered current holders first, then by most recent investment.
  • 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.
  • 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.
  • withheldFieldsstring[]
    Paths of response fields left null because the contract lacks the entitlement they need, e.g. data.privateEquityInvestors without COMPANY_PRIVATE_EQUITY. Empty when nothing was withheld.

Status codes