GET
/
people
/
enrich
/
{type}
Enrich Profile
curl --request GET \
  --url https://api.village.do/v1/people/enrich/{type} \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": [
    {
      "profile": {
        "full_name": "John Doe",
        "linkedin_url": "https://linkedin.com/in/johndoe",
        "avatar": "https://village.sfo3.cdn.digitaloceanspaces.com/avatar.jpg",
        "location": "San Francisco, CA",
        "headline": "Software Engineer at TechCorp"
      },
      "current_work": {
        "position": "Senior Software Engineer",
        "start_date": "2023-01-01",
        "end_date": null,
        "company": {
          "id": "techcorp-123",
          "type": "company",
          "name": "TechCorp",
          "linkedin_url": "https://linkedin.com/company/techcorp",
          "website": "https://techcorp.com",
          "domain": "techcorp.com",
          "employee_size": 500
        }
      }
    }
  ]
}

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 user ID

linkedin_url
string

LinkedIn profile URL

email
string

Email address

Response

200
application/json

Successfully enriched person profile

The response is of type object.