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 (0.2 credits per lead beyond FUP allowance)
phoneEnrichment - Multi-provider phone enrichment (20 credits per lead with built-in provider)
segGateway - Secure Email Gateway detection (free)
espDetection - Email Service Provider detection via MX records (free) — detects Gmail, Outlook, Yahoo, Apple, Zoho, etc.

Provider handling:

The built-in enrich provider 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.

Already-enriched leads can optionally be skipped so credits are not spent twice: leads with an existing email verification result are excluded from email jobs, and leads that already have a phone number are excluded from phoneEnrichment jobs. The behavior is controlled by the skipAlreadyEnriched request flag (default false); set it to true to skip already-enriched leads. By default every matched lead is re-enriched and charged. The applied value is echoed back as data.skipAlreadyEnriched, and skip counts are returned in data.alreadyEnriched. If skipping is on and every matched lead is already enriched for all requested types, the request fails with ALREADY_ENRICHED. segGateway and espDetection are free and always re-run.

curl -X POST "https://api.sendkit.ai/v1/enrichment/enrich" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
  "leadIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ],
  "enrichmentTypes": [
    "email",
    "phoneEnrichment",
    "segGateway",
    "espDetection"
  ]
}'

import requests
import json

url = "https://api.sendkit.ai/v1/enrichment/enrich"
headers = {
  "Content-Type": "application/json",
  "X-Api-Key": "YOUR_API_KEY"
}
data = {
  "leadIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ],
  "enrichmentTypes": [
    "email",
    "phoneEnrichment",
    "segGateway",
    "espDetection"
  ]
}

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"
},
  body: JSON.stringify({
  "leadIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ],
  "enrichmentTypes": [
    "email",
    "phoneEnrichment",
    "segGateway",
    "espDetection"
  ]
})
});

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",
    "espDetection"
  ]
}`)

    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")

    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.body = '{
  "leadIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ],
  "enrichmentTypes": [
    "email",
    "phoneEnrichment",
    "segGateway",
    "espDetection"
  ]
}'

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": 3,
    "totalCreditsCharged": 2,
    "skipAlreadyEnriched": true,
    "alreadyEnriched": {
      "email": 1
    }
  }
}

{
  "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"
  }
}

{
  "success": false,
  "error": {
    "code": "ALREADY_ENRICHED",
    "message": "All matched leads are already enriched for the requested enrichment types",
    "details": {
      "totalLeads": 2,
      "alreadyEnriched": {
        "email": 2
      }
    }
  }
}