API docs

Submit a batch screen job

POST
/batch

Accept a JSON list of entities for asynchronous screening. Returns immediately with a job id; poll GET /batch/{jobId} for state (queued → processing → completed) and per-item results. Each completed item is metered like a single screen. Requires an Idempotency-Key so retries return the same job without duplicate work. One invalid item is reported individually and never fails the batch.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Your API key, sent as Authorization: Bearer <key>.

Header Parameters

Idempotency-Key*string

Required client-supplied dedup key. Resubmitting with the same key returns the same job id and performs no additional screening or metering.

Request Body

application/json
  1. body
items*array<|>
Items1 <= items <= 2000

Response Body

Batch accepted; process in the background.

application/json
  1. response
jobId*string
Length1 <= length
curl -X POST "https://example.com/batch" \  -H "Authorization: Bearer $EXCLIA_API_KEY" \  -H "Idempotency-Key: roster-import-2026-10-06" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "type": "person",        "name": "Jane Q. Example",        "dateOfBirth": "1980-04-12",        "npi": "1234567893",        "state": "NJ"      },      {        "type": "organization",        "legalName": "Example Home Health LLC",        "state": "NJ"      }    ]  }'
{  "jobId": "string"}