Developers › API reference › Compliance

POST /api/v1/compliance/rules

Draft a rule (structured definition).

• Scope compliance:rules:write
• Idempotency-Key
• operationId complianceDraft

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

Request

POST /api/v1/compliance/rules

Headers

Body: RuleIn

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 -X POST "https://vestoris.com/api/v1/compliance/rules" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11' \
  -H "Content-Type: application/json" \
  -d '{"name":"Growth: single issuer at most 5%","rule_type":"max_issuer_pct","params":{"limit_pct":"5","include_etfs":false},"scope":{"type":"package","ids":["3"]},"severity":"warn","run_points":["pretrade","intrade","posttrade"],"source_text":"No more than 5% of any Growth account in a single issuer, except ETFs."}'

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/compliance/rules",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    },
    json={
        "name": "Growth: single issuer at most 5%",
        "rule_type": "max_issuer_pct",
        "params": {
            "limit_pct": "5",
            "include_etfs": False
        },
        "scope": {
            "type": "package",
            "ids": [
                "3"
            ]
        },
        "severity": "warn",
        "run_points": [
            "pretrade",
            "intrade",
            "posttrade"
        ],
        "source_text": "No more than 5% of any Growth account in a single issuer, except ETFs."
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

const res = await fetch("https://vestoris.com/api/v1/compliance/rules", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "name": "Growth: single issuer at most 5%",
      "rule_type": "max_issuer_pct",
      "params": {
          "limit_pct": "5",
          "include_etfs": false
      },
      "scope": {
          "type": "package",
          "ids": [
              "3"
          ]
      },
      "severity": "warn",
      "run_points": [
          "pretrade",
          "intrade",
          "posttrade"
      ],
      "source_text": "No more than 5% of any Growth account in a single issuer, except ETFs."
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

201 Created, application/json: Rule. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Example response

HTTP/1.1 201 Created
Content-Type: application/json

{
    "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": ""
}

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.

{
    "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/rules"
}

On the screens

The same thing in the app is explained in:

• The compliance engine and rule types
• Writing a rule in plain English