GET `/api/v1/compliance/register`

The rule register (JSON, or ?format=pdf).

Scope compliance:reports:read
operationId complianceRegister

The token needs the scope compliance:reports: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/register

Query parameters

Name	Required	Description
`format`	no	json (default) or pdf

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/register" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/compliance/register",
    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/register", {
  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 (or application/pdf with ?format=pdf): Register. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`data`	list of RegisterEntry	The records of this page or list.
`data[].lineage_id`	id (string)	The id shared by every version of the rule.
`data[].current`	Rule	The version in force now.
`data[].current.id`	id (string)	The record's id (a string of digits).
`data[].current.lineage_id`	id (string)	The id shared by every version of the rule.
`data[].current.version`	integer	Version number.
`data[].current.name`	string	The rule's name.
`data[].current.rule_type`	string	The rule type (max_issuer_pct, max_sector_pct, restricted_list, wash_sale, udf_condition…).
`data[].current.severity`	string	"block", "warn" or "info".
`data[].current.status`	string	draft, pending_approval, active, retired or superseded.
`data[].current.display_status`	string	The status as the screens show it.
`data[].current.pending_action`	string	What is waiting for sign-off: "activate", "change" or "retire".
`data[].current.definition`	object	The structured rule the engine enforces.
`data[].current.definition.params`	object	Parameters.
`data[].current.definition.scope`	object	What the rule applies to.
`data[].current.definition.scope.type`	string	The type.
`data[].current.definition.scope.ids`	list of id (string)	Ids the scope covers.
`data[].current.definition.run_points`	list	When the rule runs: pretrade (each order), intrade (each executed slice), posttrade (end-of-day holdings).
`data[].current.definition_hash`	string	SHA-256 of the structured definition: the exact version that was signed off.
`data[].current.restatement`	string	What the engine will enforce, written by code from the structured definition.
`data[].current.source_text`	string	The words it was written from.
`data[].current.drafted_by_ai`	boolean	True when the AI drafted it (a person still checks and signs).
`data[].current.test_bench`	object or null	The latest test-bench result: what the rule would have blocked, warned on or logged.
`data[].current.effective_from`	date-time or null	When this version took (or takes) effect.
`data[].current.effective_to`	date-time or null	When this version stopped being in force (null: still in force).
`data[].current.created_by`	id (string) or null	The user who created it.
`data[].current.created_at`	date-time or null	When it was created.
`data[].current.decided_by`	id (string) or null	Who decided.
`data[].current.decided_at`	date-time or null	When the decision was made.
`data[].current.decision_note`	string	The note written with the decision.
`data[].violations`	integer	Violations of the rule.
`data[].open_violations`	integer	Open violations of the rule.
`data[].versions`	list of Rule	Every version, newest first.
`data[].versions[].id`	id (string)	The record's id (a string of digits).
`data[].versions[].lineage_id`	id (string)	The id shared by every version of the rule.
`data[].versions[].version`	integer	Version number.
`data[].versions[].name`	string	The rule's name.
`data[].versions[].rule_type`	string	The rule type (max_issuer_pct, max_sector_pct, restricted_list, wash_sale, udf_condition…).
`data[].versions[].severity`	string	"block", "warn" or "info".
`data[].versions[].status`	string	draft, pending_approval, active, retired or superseded.
`data[].versions[].display_status`	string	The status as the screens show it.
`data[].versions[].pending_action`	string	What is waiting for sign-off: "activate", "change" or "retire".
`data[].versions[].definition`	object	The structured rule the engine enforces.
`data[].versions[].definition.params`	object	Parameters.
`data[].versions[].definition.scope`	object	What the rule applies to.
`data[].versions[].definition.scope.type`	string	The type.
`data[].versions[].definition.scope.ids`	list of id (string)	Ids the scope covers.
`data[].versions[].definition.run_points`	list	When the rule runs: pretrade (each order), intrade (each executed slice), posttrade (end-of-day holdings).
`data[].versions[].definition_hash`	string	SHA-256 of the structured definition: the exact version that was signed off.
`data[].versions[].restatement`	string	What the engine will enforce, written by code from the structured definition.
`data[].versions[].source_text`	string	The words it was written from.
`data[].versions[].drafted_by_ai`	boolean	True when the AI drafted it (a person still checks and signs).
`data[].versions[].test_bench`	object or null	The latest test-bench result: what the rule would have blocked, warned on or logged.
`data[].versions[].effective_from`	date-time or null	When this version took (or takes) effect.
`data[].versions[].effective_to`	date-time or null	When this version stopped being in force (null: still in force).
`data[].versions[].created_by`	id (string) or null	The user who created it.
`data[].versions[].created_at`	date-time or null	When it was created.
`data[].versions[].decided_by`	id (string) or null	Who decided.
`data[].versions[].decided_at`	date-time or null	When the decision was made.
`data[].versions[].decision_note`	string	The note written with the decision.
`data[].approvals`	list	The sign-offs of each version.
`generated_at`	date-time	When it was generated.
`note`	string	A note in plain words.

Example response

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

{
    "data": [
        {
            "lineage_id": "41",
            "current": {
                "id": "1042",
                "lineage_id": "41",
                "version": 1,
                "name": "Issuer limit 5% (Growth)",
                "rule_type": "max_issuer_pct",
                "severity": "block",
                "status": "active",
                "display_status": "Active",
                "pending_action": "",
                "definition": {
                    "params": [],
                    "scope": {
                        "type": "text",
                        "ids": []
                    },
                    "run_points": [
                        "pretrade",
                        "posttrade"
                    ]
                },
                "definition_hash": "9f2c…",
                "restatement": "Block any order that would make one issuer more than 5.00% of a Growth account (ETFs excepted).",
                "source_text": "No more than 5% of any Growth account in a single issuer, except ETFs.",
                "drafted_by_ai": false,
                "test_bench": null,
                "effective_from": null,
                "effective_to": null,
                "created_by": "7",
                "created_at": "2026-10-27T14:30:00Z",
                "decided_by": null,
                "decided_at": null,
                "decision_note": ""
            },
            "violations": 0,
            "open_violations": 0,
            "versions": [
                {
                    "id": "1042",
                    "lineage_id": "41",
                    "version": 1,
                    "name": "Issuer limit 5% (Growth)",
                    "rule_type": "max_issuer_pct",
                    "severity": "block",
                    "status": "active",
                    "display_status": "Active",
                    "pending_action": "",
                    "definition": {
                        "params": [],
                        "scope": {
                            "type": "text",
                            "ids": []
                        },
                        "run_points": [
                            "pretrade",
                            "posttrade"
                        ]
                    },
                    "definition_hash": "9f2c…",
                    "restatement": "Block any order that would make one issuer more than 5.00% of a Growth account (ETFs excepted).",
                    "source_text": "No more than 5% of any Growth account in a single issuer, except ETFs.",
                    "drafted_by_ai": false,
                    "test_bench": null,
                    "effective_from": null,
                    "effective_to": null,
                    "created_by": "7",
                    "created_at": "2026-10-27T14:30:00Z",
                    "decided_by": null,
                    "decided_at": null,
                    "decision_note": ""
                }
            ],
            "approvals": []
        }
    ],
    "generated_at": "2026-10-27T14:30:00Z",
    "note": ""
}

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`
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/register"
}

On the screens

The same thing in the app is explained in:

The rule register