Skip to main content
POST
/
v2
/
companies
/
paths
/
check
Check Company Paths
curl --request POST \
  --url https://api.village.do/v2/companies/paths/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "acme.com"
}
'
{
  "data": {
    "has_paths": true,
    "score": 123,
    "score_label": "<string>",
    "count": 123,
    "avatars": [
      "<string>"
    ]
  },
  "metadata": {
    "request_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT token obtained from authentication endpoint

Body

application/json

Company identifier - provide one of: domain, linkedin_url, or url

domain
string
required

Company domain (normalized, without www prefix)

Minimum string length: 1
Example:

"acme.com"

Response

Company check completed successfully

data
object
required

Quick check for company connection paths

metadata
object
required