Developers › API reference › Surveillance

POST `/api/v1/surveillance/alerts/{id}/review`

Review an alert (reviewed, dismissed, escalated) with a note.

Scope surveillance:write
Idempotency-Key
operationId complianceReviewAlert

The token needs the scope surveillance:write, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Idempotency-Key. Send a unique Idempotency-Key (up to 255 characters, e.g. a UUID) with every POST. Retrying with the same key and body replays the first answer for 24 hours, so a timeout never creates a second order; the same key with a different body is refused (idempotency_key_reused).

Request

POST /api/v1/surveillance/alerts/{id}/review

Path parameters

Name	Description	Example
`id`	The id of the alert.	`9`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token
`Idempotency-Key`	yes	A unique string up to 255 characters (a UUID). Idempotency
`Content-Type`	yes	`application/json`

Body: `AlertReview`

Field	Type	Required	Description
`status`	string	yes	reviewed, dismissed or escalated.
`note`	string	no	Your note.

Decimals (money, prices, quantities, percentages) are sent as strings, ids as strings, times as ISO 8601 UTC.

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl -X POST "https://vestoris.com/api/v1/surveillance/alerts/9/review" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11' \
  -H "Content-Type: application/json" \
  -d '{"status":"reviewed","note":"Different owners; not a wash trade."}'

Python (requests)

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/surveillance/alerts/9/review",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    },
    json={
        "status": "reviewed",
        "note": "Different owners; not a wash trade."
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/surveillance/alerts/9/review", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "status": "reviewed",
      "note": "Different owners; not a wash trade."
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: Alert. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`kind`	string	surveillance, cross_component, access or orders.
`severity`	string	How serious: for rules "block", "warn" or "info"; for alerts and issues "high", "medium" or "low".
`status`	string	open, reviewed, dismissed or escalated.
`summary`	string	What was detected.
`details`	object	Structured details.
`suggested_fix`	string	A suggested fix (applied only by a person).
`narrative`	string or null	A narrative written from the facts (by the AI when it is on).
`narrative_by_ai`	boolean	True when the AI wrote the narrative.
`user_id`	id (string) or null	The user.
`account_id`	id (string) or null	The account's id.
`order_id`	id (string) or null	The order's id.
`security_id`	id (string) or null	The security's id.
`review_note`	string	The reviewer's note.
`reviewer_id`	id (string) or null	Who reviewed it.
`created_at`	date-time or null	When it was created.
`reviewed_at`	date-time or null	When it was reviewed.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "1042",
    "kind": "surveillance",
    "severity": "warn",
    "status": "open",
    "summary": "Possible wash trade: MSFT bought and sold within 3 days across GRW-A and GRW-B",
    "details": [],
    "suggested_fix": "",
    "narrative": null,
    "narrative_by_ai": false,
    "user_id": "7",
    "account_id": "12",
    "order_id": "5301",
    "security_id": "3",
    "review_note": "",
    "reviewer_id": null,
    "created_at": "2026-10-27T14:30:00Z",
    "reviewed_at": null
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
200	Success
200 / 201	The same Idempotency-Key again: the first answer is replayed (24 hours)
400	The request is malformed	`invalid_request` `invalid_json`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
409	Not possible in the current state	`invalid_transition` `conflict` `idempotency_in_progress`
422	Validation failed (the detail says which field), or blocked	`validation_failed` `idempotency_key_reused`
428	A required header is missing	`idempotency_key_required`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/surveillance/alerts/9/review"
}

On the screens

The same thing in the app is explained in:

POST /api/v1/surveillance/alerts/{id}/review