Developers › API reference › Compliance
GET /api/v1/compliance/violations/{id}
One violation.
- Scope
compliance:read - operationId
complianceViolation
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.
Request
GET /api/v1/compliance/violations/{id}
Path parameters
| Name | Description | Example |
|---|---|---|
id | The id of the violation. | 17 |
Headers
| Header | Required | Value |
|---|---|---|
Authorization | yes | Bearer <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/17" \
-H "Authorization: Bearer $VESTORIS_TOKEN"
Python (requests)
import os, requests
r = requests.get(
"https://vestoris.com/api/v1/compliance/violations/17",
headers={
"Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
},
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/17", {
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: Violation. 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 | "active" (a trade caused it) or "passive" (the market moved). |
status | string | open, acknowledged, resolved, waived or escalated. |
severity | string | How serious: for rules "block", "warn" or "info"; for alerts and issues "high", "medium" or "low". |
rule_id | id (string) | The rule version's id. |
rule_name | string | The rule's name. |
rule_type | string | The rule type (max_issuer_pct, max_sector_pct, restricted_list, wash_sale, udf_condition…). |
account_id | id (string) | The account's id. |
account_name | string | The account's name. |
order_id | id (string) or null | The order's id. |
security_id | id (string) or null | The security's id. |
symbol | string or null | Ticker symbol. |
measured | decimal string or null | The measured value that broke the limit. |
limit | decimal string or null | The rule's limit. |
message | string | What is breached. |
owner_id | id (string) or null | The owner (null: in a queue). |
due_at | date-time or null | When it is due. |
review_note | string | The reviewer's note. |
created_at | date-time or null | When it was created. |
reviewed_at | date-time or null | When it was reviewed. |
resolved_at | date-time or null | When it was resolved. |
history | list | Every state change, oldest first. |
Example response
HTTP/1.1 200 OK
Content-Type: application/json
{
"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": []
}
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 | |
| 400 | The request is malformed | invalid_request |
| 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 |
| 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/compliance/violations/17"
}
On the screens
The same thing in the app is explained in: