Skip to content

Company Enrichment

Request

Enriches company records with firmographics and website-verified data.

Overview

The Company Enrichment API enriches company records with comprehensive firmographics data including company details, location information, industry classification, size range, and geographic coordinates.

Request Body

  • record_id: Unique identifier for this enrichment request (required)
  • company_name: Company name (optional) - improves accuracy when provided
  • domain: Company domain (optional) - improves accuracy when provided
  • country: Country code or name (optional) - helps with geographic targeting
  • external_ids: External system IDs (optional) - for integration with CRM systems
  • effort: Enrichment effort level (optional, default: low)
  • max_credits: Maximum credits to spend on this request (optional, defaults to your account limit)

Request Constraints

  • record_id is required
  • company_name, domain are optional but improves accuracy when provided
  • external_ids should be a dictionary of key-value pairs (e.g., {"sf_account_id": "001xx000..."})
  • max_credits must be a positive integer if provided

Response Fields

  • success: Boolean indicating request success
  • record_id: Echo of the input record ID
  • company: Enriched company data object containing:
    • name: Company name
    • domain: Company domain
    • linkedin_url: LinkedIn company page URL
    • hq: Headquarters location (city, state, country, postal_code)
    • size_range: Employee size range (e.g., "500+")
    • industry: Industry classification
    • geo: Geographic coordinates and location details (lat, lon, county)
    • last_verified_at: ISO timestamp of last verification
  • confidence: Confidence score (0.0-1.0) or null if disabled/not found
  • credits_consumed: Number of credits used for this request
  • credits_remaining (int | null): Approximate remaining credit balance. Use GET /v1/credits/remaining for precise value.
  • processing_time_ms: Time taken to process the request in milliseconds
  • cached: Boolean indicating if this result was returned from cache

Credit Usage

Company enrichment consumes credits based on the data sources queried:

  • Cached Result: 0 credits (if same company queried recently)
  • Company Lookup: 5 credits
Security
BearerAuth
Bodyapplication/jsonrequired
record_idstring(Record Id)required

Unique identifier for this enrichment request

company_namestring or null(Company Name)
Any of:

Company name

string
domainstring or null(Domain)
Any of:

Company domain

string
countrystring or null(Country)
Any of:

Country code or name

string
external_idsobject or null(External Ids)
Any of:

External system IDs (e.g., Salesforce account ID)

effortstring(EnrichmentEffortType)

Enrichment effort type

Default:"low"
Enum:"low""medium""high"
max_creditsinteger, [ 1 .. 100 ](Max Credits)

Maximum credits to spend on this request

Default:1
curl -i -X POST \
  https://api-gateway.agenthq.withlantern.com/v1/enrich/company \
  -H 'Authorization: Bearer <YOUR_ApiToken_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "record_id": "string",
    "company_name": "string",
    "domain": "string",
    "country": "string",
    "external_ids": {
      "property1": "string",
      "property2": "string"
    },
    "effort": "low",
    "max_credits": 1
  }'

Responses

Success Response

Bodyapplication/json
successboolean(Success)required

Boolean indicating request success

record_idstring(Record Id)required

Unique identifier for this enrichment request

companyCompanyEnrichmentData (object) or null
Any of:

Company enrichment data response.

confidencenumber or null(Confidence)
Any of:

Confidence score (0.0-1.0) or null if disabled/not found

[ 0 .. 1 ]
number
credits_consumedinteger(Credits Consumed)required

Number of credits used for this request

credits_remaininginteger or null(Credits Remaining)
Any of:

Approximate remaining credit balance. Use GET /v1/credits/remaining for precise balance.

integer
processing_time_msinteger(Processing Time Ms)required

Time taken to process the request in milliseconds

cachedboolean(Cached)required

Boolean indicating if this result was returned from cache

Response
{ "success": true, "record_id": "company_001", "company": { "name": "Databricks", "domain": "databricks.com", "linkedin_url": "https://www.linkedin.com/company/databricks", "hq": {}, "size_range": "500+", "industry": "Technology", "geo": {}, "last_verified_at": "2025-09-12T18:22:01Z" }, "confidence": 0.9, "credits_consumed": 1, "credits_remaining": 950, "processing_time_ms": 1200, "cached": true }