Skip to main content
POST
Define a policy

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Headers

Idempotency-Key
string
required

Client-supplied key that deduplicates retried requests. Reusing a key returns the original result instead of repeating the action.

Api-Signature
string
required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Pattern: ^[0-9A-Fa-f]{128,160}$
Api-Timestamp
integer<int64>
required

Current timestamp, represented as unix epoch seconds

Body

application/json
name
string
required

Human-readable policy name.

target
Policy Target · object
required

Which resources and action types this policy governs.

requiredActions
Required Action Node · object
required

What a matching change must satisfy — approvals, deny or allow today, with room for other requirement types alongside them later — as a boolean tree, plus optional settings governing the action opened when the tree isn't already satisfied. settings belongs on this root object only, not on nodes inside the tree.

A tree that resolves to deny refuses the change with 403 and opens no action, so settings has nothing to govern in that case. A tree of exactly {"allow": true} lets the change through with nothing further required, so settings has nothing to govern there either.

description
string

Optional human-readable explanation of what this policy is for.

conditions
Condition Node · object

When present, this policy only applies to changes matching this boolean tree. Omit for a policy that applies to every change matching target.

Only the transaction action types (WITHDRAWAL, DEPOSIT) may carry one. Every condition is about a change's asset and value, and the other action types have neither, so a condition on one of them could never match.

Response

Change accepted

data
Policy Change Accepted · object
required