Skip to main content
POST
/
v1
/
enrich
/
contact
Enrich Contact
curl --request POST \
  --url https://api.example.com/v1/enrich/contact \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "<string>",
  "fields": [
    {}
  ],
  "overwrite": true
}
'
{
  "data": {
    "contact": {},
    "fields_updated": [
      {}
    ],
    "source": "<string>",
    "confidence": 123,
    "credits_remaining": 123
  }
}
This endpoint consumes enrichment credits. Each successful enrichment costs 1 credit. If the workspace’s balance is zero, the API returns 402 insufficient_credits and the contact is not modified.

Request

Headers

Authorization: Bearer wbk_your_api_key_here
Content-Type: application/json
Idempotency-Key
string
Optional UUID to deduplicate retried enrichment requests within 24 hours. The credit is charged only on the first successful call.

Body Parameters

contact_id
string
required
UUID of the contact to enrich.
fields
array
Optional whitelist of fields to update. Defaults to every safe-to-fill field (job_title, company_name, linkedin_url, phone, location, seniority).
overwrite
boolean
default:"false"
When true, the enrichment can overwrite non-empty fields. By default only empty fields are populated.

Response

data
object
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.
curl -X POST \
  https://data.leadlex.com/functions/v1/api-gateway/v1/enrich/contact \
  -H "Authorization: Bearer wbk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "123e4567-e89b-12d3-a456-426614174000"
  }'

Example Response

{
  "data": {
    "contact": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "Jane Doe",
      "email": "jane@acme.com",
      "job_title": "General Counsel",
      "company_name": "Acme Corp",
      "linkedin_url": "https://linkedin.com/in/janedoe",
      "phone": "+1-555-0100",
      "location": "New York, NY, US"
    },
    "fields_updated": ["job_title", "company_name", "linkedin_url", "location"],
    "source": "vendor_a",
    "confidence": 0.91,
    "credits_remaining": 4871
  }
}

Errors

StatusCodeDescription
400validation_errorcontact_id missing or malformed
401invalid_keyInvalid or expired API key
402insufficient_creditsWorkspace credit balance is exhausted
403insufficient_permissionsMissing write:enrich permission
404not_foundContact not found in this workspace
409no_matchUpstream providers returned no data for the contact
429rate_limitedRate limit exceeded