Performs batch enrichment for up to 500 entities to find emails, phone numbers, or LinkedIn data.
| Type | Required Input | Description |
|---|---|---|
find_email | linkedinUrl OR (firstName + lastName + companyName + companyDomain) | Find and verify email addresses |
find_phone | linkedinUrl | Find phone numbers |
verify | email | Verify email deliverability |
linkedin_enrichment | linkedinUrl OR email OR (firstName + lastName + (companyName OR companyDomain)) | Enrich with LinkedIn profile data |
metadata field can be a string or an object. This data will be returned in both the API response and webhook notifications, allowing you to track and correlate enrichment requests.
webhookUrl query parameter to receive notifications when enrichments complete| Error Code | Description |
|---|---|
WRONG_INPUT_FORMAT | The input must be an object containing at least one valid field |
WRONG_METADATA_FORMAT | The metadata field must be a string or an object |
NO_WORKFLOW_REQUESTED | At least one enrichment type must be specified |
WRONG_ENRICHMENT_REQUEST_FORMAT | The enrichmentRequests field must be an array |
UNAUTHORIZED_WORKFLOW_REQUESTED | Invalid enrichment type specified |
TOO_MANY_ENRICHMENTS_REQUESTED | Maximum 500 enrichments per request |
NO_ENRICHMENTS_REQUESTED | The body must contain at least one enrichment |
WRONG_BODY_FORMAT | The body must be a valid JSON array |
MISSING_INPUTS | Required input fields are missing for the requested enrichment type |
MISSING_EMAIL | Email is required for verify enrichment |
MISSING_LINKEDIN_URL | LinkedIn URL is required for this enrichment type |
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Webhook URL for enrichment events
500Array of enrichment types to perform. Must contain at least one of: find_email, find_phone, verify, linkedin_enrichment
find_email, find_phone, verify, linkedin_enrichment ["find_email", "verify"]
Input data for enrichment. Required fields depend on enrichmentRequests.
Custom data to be returned in the response and webhook. Can be a string or an object
{ "id": "some_id" }