# Exclia API

> Screen people and organizations against US healthcare exclusion lists (OIG LEIE, SAM.gov, state Medicaid lists). Results are `clear` or `potential_match` with evidence and provenance — never an automated "excluded" verdict. Base URL: https://api.exclia.com/v1. Auth: `Authorization: Bearer <API key>`.

The full contract is the OpenAPI document: https://exclia.com/docs/openapi.json

## Guides

- [Exclia API](https://exclia.com/docs): Screen people and organizations against healthcare exclusion lists from your own product.
- [Quickstart](https://exclia.com/docs/quickstart): Your first screening call in under five minutes, with curl, TypeScript and Python.
- [Authentication](https://exclia.com/docs/authentication): API keys, the bearer header, permissible-use certification, rotation and revocation.
- [Errors](https://exclia.com/docs/errors): Every status code and error code the API returns, and what to do about each one.
- [Rate limits](https://exclia.com/docs/rate-limits): Per-plan request ceilings and monthly allowances, and what happens past them.
- [Webhooks](https://exclia.com/docs/webhooks): Signed deliveries when a monitored status changes, and how to verify the signature.
- [Versioning](https://exclia.com/docs/versioning): What counts as a breaking change, and how changes to /v1 are announced.
- [Changelog](https://exclia.com/docs/changelog): Every change to the /v1 API, newest first, with what to do about breaking ones.

## API reference

- [Screen one person or organization](https://exclia.com/docs/reference/screen-entity): 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.
- [Submit a batch screen job](https://exclia.com/docs/reference/submit-batch-screen): 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.
- [Get batch job status and results](https://exclia.com/docs/reference/get-batch-job): 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.
- [Enroll an entity in continuous monitoring](https://exclia.com/docs/reference/enroll-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`.
- [Remove an entity from continuous monitoring](https://exclia.com/docs/reference/remove-monitor): 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.
- [Live coverage and list versions](https://exclia.com/docs/reference/get-coverage): 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.
- [Current billing-period consumption](https://exclia.com/docs/reference/get-usage): 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.

## Optional

- [Everything above in one file](https://exclia.com/llms-full.txt)