Exclia
API docs

Screen one person or organization

POST
/screen

Screen a single person or organization synchronously against the current pinned list versions. Returns status clear or potential_match with per-field evidence and provenance — never an automated "excluded" verdict. Each successful call counts toward the org’s metered API usage. Pass an optional Idempotency-Key header so retries are not double-counted.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

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

Header Parameters

Idempotency-Key?string

Optional dedup key for metering. Retries with the same key are not double-counted; when omitted a unique key is generated server-side so the call still counts once.

Request Body

application/json
  1. body
type*"person"
Value in"person"
name*string
Length1 <= length <= 255
aliases?array<>
Itemsitems <= 50
dateOfBirth?string
Match^\d{4}-\d{2}-\d{2}$
npi?string
Length10 <= length <= 10
state?string
Length2 <= length <= 2
providerType?string
Lengthlength <= 255

Response Body

Screen result with status, evidence, and provenance.

application/json
  1. response
status*string
Value in"clear""potential_match"
matches*array<>
sources*array<>
checkedAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatdate-time
recallCapped*boolean
curl -X POST "https://example.com/screen" \  -H "Authorization: Bearer $EXCLIA_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "type": "person",    "name": "Jane Q. Example",    "dateOfBirth": "1980-04-12",    "npi": "1234567893",    "state": "NJ"  }'
{  "status": "clear",  "matches": [    {      "label": "string",      "fields": [        {          "field": "name",          "state": "matched",          "rosterValue": "string",          "listValue": "string",          "strong": true        }      ],      "provenance": {        "sourceList": "string",        "listVersionId": "string",        "retrievedAt": "2019-08-24T14:15:22Z"      },      "score": 0    }  ],  "sources": [    {      "source": "string",      "listVersionId": "string",      "retrievedAt": "2019-08-24T14:15:22Z"    }  ],  "checkedAt": "2019-08-24T14:15:22Z",  "recallCapped": true}

Remove an entity from continuous monitoring DELETE

Take an entity out of continuous monitoring by its monitored-record id. No further re-screens or webhooks are produced for it. An unknown id — or a second delete for an id already removed — returns 404.

Submit a batch screen job POST

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.