Sign in

v1

latestOpenAPI 3.0.32026-07-222085264.6 KB
Batch APIs

Submit a batch person enrichment job

Enrich up to 10,000 people in a single asynchronous job. Provide exactly one identifier type — professional_network_profile_urls or business_emails — and optionally the fields to include in each record.

<Note> An account may have at most 5 active (`pending` or `processing`) batch jobs at a time; submitting a sixth returns `429`. </Note>

The job responds immediately with a batch_id. Poll GET /batch/{batch_id} (or provide a webhook_url) and download the gzipped JSONL results file when the job completes. Each record is wrapped in an {original_identifier, internal_id, data} envelope, where data holds the person record in the same shape as the non-batch /person/enrich response. Identifiers that cannot be resolved are silently dropped from the results file (compare entities_requested with entities_fulfilled).

post/batch/person/enrich

Headers

x-api-version'2025-11-01' required
Example:2025-11-01

API version to use. This endpoint currently requires 2025-11-01.

Request body

webhook_urlstring uri

Optional URL that receives a POST notification when the job finishes, so you do not have to poll.

chunk_sizeinteger

Optional internal processing chunk size (number of identifiers per processing unit). Values outside 10-1000 return 400.

Example request

{
  "professional_network_profile_urls": [
    "https://www.linkedin.com/in/dvdhsu/"
  ],
  "fields": [
    "basic_profile.name",
    "basic_profile.headline",
    "basic_profile.current_title"
  ]
}

Response

Batch job accepted for processing

batch_idstring uuid required

Unique ID of the batch job. Use it to poll GET /batch/{batch_id}.

status'pending' required

Initial job status. Always pending at submit time.

entity'company' | 'person' | 'social_post' required

Entity type the job operates on.

action'enrich' | 'enrich_live' | 'contact_enrich' | 'search' | 'search_live' required

Internal action name for the job. Live endpoints report enrich_live / search_live; the person contact enrichment endpoint reports contact_enrich.

identifier_countinteger required

Number of identifiers submitted. Search jobs always report 1 (the query).

entities_requestedinteger required

Number of entities the job was asked to produce. For enrich jobs this equals identifier_count; for search jobs it is 1 until results are known.

status_urlstring required

Relative URL to poll for the job status (GET /batch/{batch_id}).

Example response

{
  "batch_id": "53ab686b-c054-496b-8baf-baff5ecc85cf",
  "status": "pending",
  "entity": "company",
  "action": "enrich",
  "identifier_count": 2,
  "entities_requested": 2,
  "status_url": "/batch/53ab686b-c054-496b-8baf-baff5ecc85cf"
}