How to use the endpoint
The bulk enrichment API is ideal for:- Processing large lists of prospects efficiently
- Enriching CRM data in batches
- Finding and verifying multiple contacts simultaneously
- Automating data enrichment workflows at scale
Enrichment Types
| 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
Themetadata 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.
Response
The API returns an array where each element corresponds to a request in the input array. Successful requests return an enrichment ID, while failed requests return an error code.Getting Results
Check Enrich Data for details on the enrichment result structure.
- Polling: Use the Get Enrichment Result endpoint with the returned enrichment ID
- Webhooks: Provide a
webhookUrlquery parameter to receive notifications when enrichments complete
Error Codes
| 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 |
Limits
- Maximum requests per call: 500 enrichments
- Rate limits: Standard API rate limits apply (20 requests per 2 seconds)
- Credits: Each enrichment type consumes credits from your team’s balance
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
Webhook URL for enrichment events
Body
application/json · object[]
Array of enrichment types to perform. Must contain at least one of: find_email, find_phone, verify, linkedin_enrichment
Example:
["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
Example:
{ "id": "some_id" }