Developers › API reference › Workflow

POST /api/v1/workflow/rules/{id}/sign-off

Sign off as Admin or Compliance (a person; X-Vestoris-Confirm).

• Scope workflow:rules:approve
• Idempotency-Key
• Confirmation
• A person
• Four eyes
• operationId workflowSignOff

The token needs the scope workflow:rules:approve, 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/workflow/rules/{id}/sign-off

Path parameters

Headers

Body: WorkflowSignOff

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/workflow/rules/41/sign-off" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11' \
  -H 'X-Vestoris-Confirm: vcf_77be…' \
  -H "Content-Type: application/json" \
  -d '{"as":"admin","note":"Replay reviewed","effective":"now"}'

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/workflow/rules/41/sign-off",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
        "X-Vestoris-Confirm": "vcf_77be…",
    },
    json={
        "as": "admin",
        "note": "Replay reviewed",
        "effective": "now"
    },
    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/workflow/rules/41/sign-off", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    "X-Vestoris-Confirm": "vcf_77be…",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "as": "admin",
      "note": "Replay reviewed",
      "effective": "now"
  }),
});
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: WorkflowRule. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Example response

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

{
    "id": "1042",
    "lineage_id": "41",
    "version": 1,
    "name": "Large Growth orders",
    "item_type": "order",
    "priority": 2,
    "status": "active",
    "state": "in force",
    "is_default": false,
    "conditions": {
        "all": [
            {
                "field": "notional",
                "op": ">",
                "value": 1000000
            }
        ],
        "any": []
    },
    "actions": [
        {
            "type": "require_approval",
            "roles": [
                "portfolio_manager",
                "compliance_officer"
            ],
            "count": 2
        }
    ],
    "restatement": "Block any order that would make one issuer more than 5.00% of a Growth account (ETFs excepted).",
    "source_text": "",
    "drafted_by_ai": false,
    "pending_action": "",
    "weakens": false,
    "weakens_why": "",
    "signoffs": {
        "admin": null,
        "compliance": []
    },
    "test_bench": null,
    "effective_from": null,
    "effective_to": null,
    "created_by": "7",
    "created_at": "2026-10-27T14:30:00Z",
    "done": false,
    "still_needed": [
        "compliance"
    ]
}

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/workflow/rules/41/sign-off"
}

On the screens

The same thing in the app is explained in:

• Workflow rules