API reference
Coming soon
What the API has today, and what is planned but not built yet.
What's available today
| Method | Path | Page |
|---|---|---|
GET | /healthz | Health |
GET, POST | /v1/entities | Entities |
GET | /v1/entities/{id} | Entities |
GET | /v1/entities/{id}/events | Entities |
GET | /v1/entities/{id}/links | Entities |
GET, POST | /v1/events | Events |
GET | /v1/events/{id} | Events |
GET | /v1/decisions/{id} | Decisions |
GET | /v1/alerts | Alerts |
GET | /v1/alerts/counts | Alerts |
GET | /v1/alerts/{id} | Alerts |
PATCH | /v1/alerts/{id} | Alerts |
GET, POST | /v1/alerts/{id}/notes | Alerts |
POST | /v1/alerts/{id}/closure | Alerts |
POST | /v1/alerts/{id}/closure/approve | Alerts |
POST | /v1/alerts/{id}/closure/reject | Alerts |
GET | /v1/alerts/{id}/flow | Alerts |
GET | /v1/overview | Overview |
GET, POST | /v1/rules | Rules |
POST | /v1/rules/{id}/activate | Rules |
POST | /v1/rules/{id}/backtest | Rules |
GET | /v1/screenings | Screening |
POST | /v1/screenings | Screening |
GET | /v1/screenings/{id} | Screening |
POST | /v1/screenings/{id}/resolutions | Screening |
POST | /v1/screenings/{id}/resolutions/{resolution_id}/approve | Screening |
POST | /v1/screenings/{id}/resolutions/{resolution_id}/reject | Screening |
GET | /v1/screening/lists | Screening |
GET, POST | /v1/keys | API keys |
DELETE | /v1/keys/{id} | API keys |
Not built yet
These are planned but not in the current API (api/openapi.yaml). Their schemas aren't published, so don't build against them.
| Area | What's missing |
|---|---|
| Async processing | POST /v1/events in async mode stores the event but nothing scores it later |
| Webhooks | Subscriptions and signed deliveries. See Webhooks. |
| Keys | Test keys, per-key scopes, rotation and "last used" |
| Users and roles | People, roles and SSO. Access is by API key, and four-eyes compares key IDs. |
| Cases | Grouping alerts into cases, with evidence and a narrative |
| Reporting | STR and CTR drafting, goAML export and filing, evidence packs |
| Screening | Ongoing re-screening when a list changes, and a retention setting for stored screenings |
| Entities | The Network graph screen, and phone, ID and ownership links |