Enrichment
Enrich leads
Triggers enrichment jobs for the specified leads. Creates one job per enrichment type and queues them for background processing by the enrichment worker.
Supported enrichment types:
email— Email verification (1 credit per lead with built-in provider)phoneEnrichment— Multi-provider phone enrichment (20 credits per lead with built-in provider)segGateway— Secure Email Gateway detection (free)
Provider handling:
- The built-in
enrichprovider is always available at no extra configuration. - External providers (leadmagic, icypeas, hunter, etc.) must be configured via
POST /v1/enrichment-settings/{provider}before use. External providers use your own API key credits — no Enrich credits are charged.
Credits are deducted upfront when using the built-in provider.
curl -X POST "https://api.sendkit.ai/v1/enrichment/enrich" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"leadIds": [
"507f1f77bcf86cd799439011",
"507f1f77bcf86cd799439012"
],
"enrichmentTypes": [
"email",
"phoneEnrichment",
"segGateway"
]
}'
import requests
import json
url = "https://api.sendkit.ai/v1/enrichment/enrich"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"leadIds": [
"507f1f77bcf86cd799439011",
"507f1f77bcf86cd799439012"
],
"enrichmentTypes": [
"email",
"phoneEnrichment",
"segGateway"
]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/enrichment/enrich", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"leadIds": [
"507f1f77bcf86cd799439011",
"507f1f77bcf86cd799439012"
],
"enrichmentTypes": [
"email",
"phoneEnrichment",
"segGateway"
]
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"leadIds": [
"507f1f77bcf86cd799439011",
"507f1f77bcf86cd799439012"
],
"enrichmentTypes": [
"email",
"phoneEnrichment",
"segGateway"
]
}`)
req, err := http.NewRequest("POST", "https://api.sendkit.ai/v1/enrichment/enrich", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/enrichment/enrich')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"leadIds": [
"507f1f77bcf86cd799439011",
"507f1f77bcf86cd799439012"
],
"enrichmentTypes": [
"email",
"phoneEnrichment",
"segGateway"
]
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"jobs": [
{
"jobId": "bulk_email_verification_1710000000000_abc1234",
"type": "email_verification",
"status": "pending",
"totalItems": 2,
"creditsUsed": 2
}
],
"totalLeads": 2,
"totalCreditsCharged": 2
}
}
{
"success": false,
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Insufficient credits",
"details": {
"required": 100,
"available": 10,
"leads": 5,
"enrichmentTypes": [
"email",
"phoneEnrichment"
]
}
}
}
{
"success": false,
"error": {
"code": "PROVIDER_NOT_CONFIGURED",
"message": "Phone provider "leadmagic" is not configured. Add your API key via PUT /v1/enrichment-settings/leadmagic"
}
}
POST
/v1/enrichment/enrich
POST
API Key (header: X-Api-Key)
X-Api-Keystring
RequiredPlatform API key (sk_user_...) or Workspace API key (sk_...)
Platform API key (sk_user_...) or Workspace API key (sk_...)
Content-Typestring
RequiredThe media type of the request body
Options: application/json
leadIdsarray
RequiredMongoDB ObjectIds of leads to enrich
enrichmentTypesarray
RequiredTypes of enrichment to perform
providerstring
Email verification provider (enrich, leadmagic, icypeas, hunter, etc.)
phoneProviderstring
Phone enrichment provider (enrich, leadmagic, aleads, fullenrich, bettercontact, enrow)
Request Preview
Response
Response will appear here after sending the request
Authentication
header
X-Api-Keystring
RequiredAPI Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
header
Authorizationstring
RequiredBearer token. API key as Bearer token
Body
application/json
leadIdsarray
RequiredMongoDB ObjectIds of leads to enrich
enrichmentTypesarray
RequiredTypes of enrichment to perform
providerstring
Email verification provider (enrich, leadmagic, icypeas, hunter, etc.)
phoneProviderstring
Phone enrichment provider (enrich, leadmagic, aleads, fullenrich, bettercontact, enrow)
Responses
Was this page helpful?
Last updated today
Built with Documentation.AI