Screening API and webhooks
Screen a person or organization, manage monitored records and receive signed webhooks from your own HR, credentialing or vendor system.
What you can do
Screen on request
`POST /v1/screen` returns the result in the same request, pinned to the list versions it used.
Manage monitoring
`PUT /v1/monitor` adds or updates a monitored record by your own ID; `DELETE` stops monitoring it. Records added by API sit beside the ones your team adds.
Signed webhooks
Get notified when a monitored record’s status changes. Each delivery is signed with a secret only you hold and retried if your endpoint is down.
Keys and usage
Separate test and live keys you can create, rotate and revoke, plus `GET /v1/lists` for coverage and `GET /v1/usage` for consumption.
How to use it
- Step 1
Create a key
Owners and admins open API keys, accept the API terms, and create a test key.
- Step 2
Screen your first subject
Call `POST /v1/screen` with a name and any identifiers you hold, using the key as a bearer token.
- Step 3
Sync your records
Call `PUT /v1/monitor` for each person or organization your system tracks, using your own ID so updates are idempotent.
- Step 4
Register a webhook
Add your endpoint, store the signing secret, and verify the signature on each delivery.
- Step 5
Go live
Swap the test key for a live key. Your API usage is shown on the Usage page.
Questions
API access depends on your plan. The pricing page lists what each plan includes and its rate limit.
Each delivery carries an HMAC signature made with your endpoint’s secret. Recompute it over the body and compare before trusting the payload.
Yes. The API is described by an OpenAPI document generated from the same schemas the API validates against, with a changelog for every change.
See it on your own list
Start a free trial and screen your first records today, or run a free check on one name first.