API documentation

Create and stop ongoing monitoring

Retain the subject for full rescreens and understand the evidence changes, daily backstop, and allowance consumed by monitoring.

Updated

Create
POST /monitors

Retains the subject for future checks.

Recheck
Daily + updates

Source changes can trigger extra rescreens.

Allowance
Each rescreen counts

Completed checks use the shared plan allowance.

Create a retained subject

POST /api/v1/monitors accepts name, subject, and either sources or package. It requires monitors:write. A monitor is organization-owned and environment-specific. It keeps the subject input because subsequent screening cannot happen after that input has been deleted.

GET /api/v1/monitors lists permitted monitors with their status and last screening reference. DELETE /api/v1/monitors/{id} stops monitoring and clears the stored monitoring request. Existing screening evidence follows its own retention period.

JSON request
{
  "name": "Fictional example watch",
  "subject": {
    "name": "Alex Morgan",
    "entityType": "person",
    "birthDate": "1984"
  },
  "package": "sandbox@1"
}

Review changes rather than only new names

Qualified source changes schedule full rescreens. Daily full rescreening is the safety backstop. A changed subject, relevant match evidence, engine, or policy can reopen a dismissed case. Review the latest result and keep the prior decision’s reasoning attached to its historical context.

Each completed rescreen consumes one subject allowance. A monitor-count allowance is not unlimited screening volume. When a plan or configured cap is exhausted, further screens cannot complete until allowance is available. Treat a delayed or failed rescreen as an operational state, not evidence that nothing changed.

KEEP BUILDING

Where to go next