Sign in

v1

latestOpenAPI 3.0.32026-08-0670174396.8 KB
Batch enrichment

Create Batch Enrichment

Create a batch enrichment job by uploading a CSV.

How it works

  1. Upload a .csv file (one column: handle or email)
  2. Choose the enrichment mode (handle: raw/full, email: basic)
  3. Use the returned batch_id to check status and download results

Request

  • multipart/form-data
  • file: CSV (max 10MB)
  • Mode fields depend on whether you’re enriching by handle or email

Credits

  • Credits are deducted per successfully enriched record
  • The credit rate follows the corresponding single-enrichment pricing (handle raw/full, or email enrichment)
  • If no data is returned for a record, 0 credits are deducted for that record

Checking completion Poll GET /public/v1/enrichment/batch/{batch_id}/status/ every 30–60 seconds until the job finishes. Status values:

  • queued — waiting to start
  • processing — actively enriching records
  • finished — all records done; download results via GET /public/v1/enrichment/batch/{batch_id}/
  • failed — job failed
  • paused_insufficient_credits — top up credits and call the resume endpoint

This API is polling-based. There are no webhooks or push notifications.

<div class="ic-ai-prompt-root" data-endpoint="batch-create"></div>
post/public/v1/enrichment/batch/

Response

batch_idstring required

Unique identifier for the batch enrichment job

statusstring required

Current status of the batch job (processing, finished, failed, validating)

created_atstring date-time required

Timestamp when the batch was created

platformstring nullable

Platform used for enrichment (for handle-based enrichment)

metadataobject nullable

Metadata provided with the batch

og_input_numberinteger required

Total number of records in the input file

type_reportstring required

Type of enrichment: ENRICH_BY_HANDLE or ENRICH_BY_EMAIL

enrichment_modestring nullable

Enrichment mode: raw, full, basic

messagestring required

Human-readable message about the batch status