- 1
I write code
Make a test key and send your first check.
- 2
I do not
Paste links or upload a CSV in the console.
- 3
I publish
Press releases by API are not open yet. Read how they will work.
Test mode
Sample answers that cost nothing. The rules are a table.
Reading results
Verdicts, unknowns and what a check cannot tell you.
Webhooks
Events sent to your address, signed.
Credits
The meter, holds and what is charged.
Errors
One shape and every code.
API reference
Every endpoint, with examples in three languages.
Start here
- POSTCreate a check/checks
- GETRetrieve a check/checks/{id}
- POSTCreate a proof report/reports
- GETRetrieve a report/reports/{id}
- GETRetrieve the balance/balance
Everything else
API
- GETDescribe the API/
- GETGet the OpenAPI document/openapi.json
- GETGet the price card/prices
Checks
- GETList checks/checks
- GETDownload a check as CSV/checks/{id}/csv
- POSTCancel a check/checks/{id}/cancel
Monitors
- POSTCreate a monitor/monitors
- GETList monitors/monitors
- GETRetrieve a monitor/monitors/{id}
- DELETEEnd a monitor/monitors/{id}
- POSTPause a monitor/monitors/{id}/pause
- POSTResume a monitor/monitors/{id}/resume
- POSTRun a test monitor now/monitors/{id}/run
- GETList a monitor's changes/monitors/{id}/changes
Reports
- GETList reports/reports
- POSTRevoke a report's share link/reports/{id}/revoke
- GETDownload a report as PDF/reports/{id}/pdf
Balance and usage
- GETRetrieve usage/usage
- GETList ledger entries/ledger
Events
- GETList events/events
- GETRetrieve an event/events/{id}