Exclia
API docs

Enroll an entity in continuous monitoring

PUT
/monitor

Enroll one person or organization in continuous monitoring. The entity is screened immediately and added to your organization’s monitoring (tagged source api); the response returns its monitored-record id and current status — clear or potential_match with per-field evidence and provenance, never an automated "excluded" verdict. From then on it is re-screened whenever a covered source publishes a new immutable list version, and a match-status-change webhook announces any change. Each entity under monitoring accrues one metered record-month per billing month, reported by GET /usage.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

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

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

Enrolled; monitored-record id plus current status, evidence, and provenance.

application/json
  1. response
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
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
curl -X PUT "https://example.com/monitor" \  -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"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "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"}

Changelog

Every change to the /v1 API, newest first, with what to do about breaking ones.

Get batch job status and results GET

Poll a batch job’s lifecycle state. When `state` is `completed`, the response includes per-item results: `clear` or `potential_match` with evidence and provenance, or an isolated item error. Never an automated excluded boolean.