Live coverage and list versions
Every source screened against with its current immutable list_version id, retrieval date, and update cadence, plus honestly-stated gaps. Reads the same coverage metadata as the in-app coverage page, so both agree at the same moment.
ApiKeyAuthAuthorizationBearer <token>Your API key, sent as Authorization: Bearer <key>.
Current coverage and freshness.
application/json- response
sources*array<>additionalSources?array<>registrySources?array<>gaps*array<>totals*asOf*string^(?:(?:\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))$date-timecurl -X GET "https://example.com/lists" \ -H "Authorization: Bearer $EXCLIA_API_KEY"{ "sources": [ { "key": "string", "name": "string", "listVersionId": "string", "retrievedAt": "2019-08-24T14:15:22Z", "cadence": "daily", "cadenceLabel": "string" } ], "additionalSources": [ { "key": "string", "name": "string", "listVersionId": "string", "retrievedAt": "2019-08-24T14:15:22Z", "cadence": "daily", "cadenceLabel": "string" } ], "registrySources": [ { "sourceKey": "NPPES", "scope": "organization_registry", "excludedFromMedicaidDenominator": true, "status": "live", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "retrievedAt": "2019-08-24T14:15:22Z", "artifactRetrievedAt": "2019-08-24T14:15:22Z", "sourceUrl": "http://example.com", "periodEnd": "2019-08-24", "organizationCount": 0, "artifactChecksum": "string", "type1PublicPagesEnabled": false } ], "gaps": [ { "key": "string", "name": "string", "reason": "string" } ], "totals": { "screened": 0, "total": 0 }, "asOf": "2019-08-24T14:15:22Z"}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.
Current billing-period consumption GET
This billing period’s metered consumption — /v1/screen calls and monitored record-months, priced — matching exactly what is metered for billing over the same period, so you can reconcile before the invoice arrives.