Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer . Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.

Body

application/json
capability
string
required

The capability, as namespace:verb, for example erp:pay-invoice.

Pattern: ^[a-z][a-z0-9-]*:[a-z][a-z0-9-]*$
Example:

"erp:pay-invoice"

transactionId
string
required

The caller's id for this decision. Must not be blank.

Minimum string length: 1
target
string
required

The target of the action.

parameters
object

The action's parameters. Defaults to {}.

signals
object

Caller values, untrusted unless a registered source signed them. Defaults to {}.

approvals
object

Approval artifacts, checked by the server.

Response

The recorded decision.

outcome
enum<string>
required
Available options:
APPROVE,
REJECT,
REVIEW
reason
string
required
recordId
string
required

The evidence record. Replay it with GET /v2/evidence/{recordId}/replay.

released
enum<boolean>
required

Always false. A policy version 2 decision never releases an action by itself.

Available options:
false
tier
string
refusal
object
reviewId
string

Present for a REVIEW outcome. Read it with GET /v2/reviews/{id}.