Skip to content

Batch screening

Use batches for onboarding backlogs, periodic re-screening and migrations. A batch holds up to 100,000 items and runs at lower priority than single screenings.

Send JSON items:

Terminal window
curl https://api.auto-compliance.com/v1/batches \
-H "Authorization: Bearer $AUTOCOMPLIANCE_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: batch-2026-11-20-001" \
-d '{
"items": [
{ "full_name": "Test Sanctioned Person", "external_id": "c1" },
{ "full_name": "Test Clear Person", "external_id": "c2" }
]
}'

Or upload a file:

Terminal window
curl https://api.auto-compliance.com/v1/batches \
-H "Authorization: Bearer $AUTOCOMPLIANCE_API_KEY" \
-H "Idempotency-Key: batch-2026-11-20-002" \

CSV (UTF-8, comma-separated, header row) or XLSX (first sheet). Maximum 100,000 rows and 50 MB.

full_name,date_of_birth,country,external_id
Test Sanctioned Person,1970-01-01,,c1
Test Clear Person,,DE,c2

Only full_name is required. Rows that fail validation do not stop the batch: they are reported with status: invalid and an error.

The response is 202 Accepted with a batch object. Either poll GET /v1/batches/{id} (every 10–30 seconds is plenty), or subscribe to the batch.completed webhook.

Batch status: queued → processing → completed | failed | cancelled.

Terminal window
curl "https://api.auto-compliance.com/v1/batches/bat_01JD.../results?has_matches=true&limit=500" \
-H "Authorization: Bearer $AUTOCOMPLIANCE_API_KEY"

Results are returned in input order, with cursor pagination. Each item contains its index, external_id and the full screening.

To download everything at once, call POST /v1/batches/{id}/export with format set to csv, xlsx or jsonl. The response contains a signed URL that expires.

POST /v1/batches/{id}/cancel stops processing. Items already screened stay available and billed.