Developers › API reference › Compliance

GET /api/v1/compliance/violations

Violations.

  • Scope compliance:read
  • operationId complianceViolations

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

Paginated. Cursor pagination: limit (1 to 200, default 50); pass next_cursor as cursor until has_more is false. fields= returns only the named fields.

Request

GET /api/v1/compliance/violations

Query parameters

NameRequiredDescription
limitnoPage size, 1 to 200 (default 50)
cursornoThe next_cursor of the previous page
sortno"-id" (newest first, default) or "id"
fieldsnoSparse fieldset: comma-separated field names
statusnoopen, acknowledged, resolved, waived, escalated
accountnoAccount id
severitynoblock or warn

Headers

HeaderRequiredValue
AuthorizationyesBearer <token>: an OAuth access token (vat_…) or a personal access token (vpt_…). Get a token

Examples

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

curl

curl "https://vestoris.com/api/v1/compliance/violations?status=open&severity=block&limit=50" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/compliance/violations",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    params={
        "status": "open",
        "severity": "block",
        "limit": "50"
    },
    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/compliance/violations?status=open&severity=block&limit=50", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
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: a page of Violation. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields
FieldTypeDescription
datalist of ViolationThe records of this page.
data[].idid (string)The record's id (a string of digits).
data[].kindstring"active" (a trade caused it) or "passive" (the market moved).
data[].statusstringopen, acknowledged, resolved, waived or escalated.
data[].severitystringHow serious: for rules "block", "warn" or "info"; for alerts and issues "high", "medium" or "low".
data[].rule_idid (string)The rule version's id.
data[].rule_namestringThe rule's name.
data[].rule_typestringThe rule type (max_issuer_pct, max_sector_pct, restricted_list, wash_sale, udf_condition…).
data[].account_idid (string)The account's id.
data[].account_namestringThe account's name.
data[].order_idid (string) or nullThe order's id.
data[].security_idid (string) or nullThe security's id.
data[].symbolstring or nullTicker symbol.
data[].measureddecimal string or nullThe measured value that broke the limit.
data[].limitdecimal string or nullThe rule's limit.
data[].messagestringWhat is breached.
data[].owner_idid (string) or nullThe owner (null: in a queue).
data[].due_atdate-time or nullWhen it is due.
data[].review_notestringThe reviewer's note.
data[].created_atdate-time or nullWhen it was created.
data[].reviewed_atdate-time or nullWhen it was reviewed.
data[].resolved_atdate-time or nullWhen it was resolved.
data[].historylistEvery state change, oldest first.
next_cursorstring or nullPass as ?cursor= for the next page; null on the last page.
has_morebooleanTrue when another page follows.

Example response

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

{
    "data": [
        {
            "id": "1042",
            "kind": "passive",
            "status": "open",
            "severity": "warn",
            "rule_id": "41",
            "rule_name": "Issuer limit 5% (Growth)",
            "rule_type": "max_issuer_pct",
            "account_id": "12",
            "account_name": "Growth Fund A",
            "order_id": "5301",
            "security_id": "3",
            "symbol": "AAPL",
            "measured": "6.20",
            "limit": "5.00",
            "message": "AAPL is 6.20% of Growth Fund A (limit 5.00%)",
            "owner_id": "7",
            "due_at": null,
            "review_note": "",
            "created_at": "2026-10-27T14:30:00Z",
            "reviewed_at": null,
            "resolved_at": null,
            "history": []
        }
    ],
    "next_cursor": "eyJpZCI6NTI5OX0",
    "has_more": true
}

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.

StatusWhenProblem codes
200Success
400The request is malformedinvalid_request
401No token, or it is invalid or expiredinvalid_token
403The token lacks the scope, or the person or service account behind it lacks the privilege or account permissioninsufficient_scope forbidden ip_not_allowed
429Rate limited: wait for Retry-After secondsrate_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/compliance/violations"
}

On the screens

The same thing in the app is explained in: