GET
/
companies
/
enrich
/
{type}
Enrich Company
curl --request GET \
  --url https://api.village.do/v1/companies/enrich/{type} \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": [
    {
      "company": {
        "village_id": "company-123",
        "name": "TechCorp Inc",
        "linkedin_url": "https://linkedin.com/company/techcorp",
        "website": "https://techcorp.com",
        "domain": "techcorp.com",
        "employee_size": 500,
        "industry": [
          "Technology",
          "Software"
        ],
        "crunchbase_url": "https://crunchbase.com/organization/techcorp",
        "founded": 2015,
        "description": "Leading technology company specializing in enterprise software solutions."
      }
    }
  ]
}

Authorizations

x-access-token
string
header
required

JWT token obtained from /users/authorization endpoint

Headers

user-identifier
string
required

Specify the user making the request. This identifier should match the one you used when integrating the user with Village. Not needed when using user token authentication.

Path Parameters

type
enum<string>
required

Enrichment level - currently only 'basic' is available

Available options:
basic

Query Parameters

village_id
string

Village internal company ID

linkedin_url
string

LinkedIn company page URL

domain
string

Company domain name

Response

Successfully enriched company profile

success
boolean

Whether the request was successful

data
object[]