Retrieve all policies for your organization. Policies define rules that control transaction approvals, blocks, and notifications based on conditions like amount, sender, recipient, asset, and time.
Each policy in the response includes:
| Field | Type | Description |
|---|---|---|
id | string | Unique policy UUID (specific to this version) |
logicalId | string | Logical ID shared across all versions of this policy |
version | number | Policy version number (starts at 1, increments on each update) |
isLatest | boolean | Whether this is the latest version of the policy (only the latest version can be edited) |
name | string | Human-readable policy name (unique within organization) |
description | string | Optional description of policy purpose and behavior |
type | string | Action type: TRANSFER, CONTRACT_WRITE, CONTRACT_READ, CONTRACT_DEPLOY, MINT, BURN, RAW_SIGNING, or TYPED_MESSAGE |
status | string | DRAFT, PENDING_APPROVAL, ACTIVE, INACTIVE, or ARCHIVED |
enforcementMode | string | STRICT (enforced), ADVISORY (warn only), or LOG_ONLY (audit trail only) |
conditionLogic | string | ALL (AND logic) or ANY (OR logic) for multiple conditions |
priority | number | Evaluation order (0 = highest priority, first matching policy wins) |
organizationId | string | Organization UUID that owns this policy |
conditions | array | Array of condition objects (field, operator, value) |
actions | array | Array of action objects (ALLOW, BLOCK, REQUIRE_APPROVAL, NOTIFY) |
createdAt | string | ISO 8601 timestamp |
updatedAt | string | ISO 8601 timestamp |
createdBy | string | User UUID who created the policy |
updatedBy | string | User UUID who last updated the policy |
deletedAt | string | ISO 8601 timestamp when the policy was soft-deleted (nullable) |
deletedBy | string | User UUID who deleted the policy (nullable) |
policies:read
Retrieve all policies for your organization. Policies define rules that control transaction approvals, blocks, and notifications based on conditions like amount, sender, recipient, asset, and time.
Each policy in the response includes:
| Field | Type | Description |
|---|---|---|
id | string | Unique policy UUID (specific to this version) |
logicalId | string | Logical ID shared across all versions of this policy |
version | number | Policy version number (starts at 1, increments on each update) |
isLatest | boolean | Whether this is the latest version of the policy (only the latest version can be edited) |
name | string | Human-readable policy name (unique within organization) |
description | string | Optional description of policy purpose and behavior |
type | string | Action type: TRANSFER, CONTRACT_WRITE, CONTRACT_READ, CONTRACT_DEPLOY, MINT, BURN, RAW_SIGNING, or TYPED_MESSAGE |
status | string | DRAFT, PENDING_APPROVAL, ACTIVE, INACTIVE, or ARCHIVED |
enforcementMode | string | STRICT (enforced), ADVISORY (warn only), or LOG_ONLY (audit trail only) |
conditionLogic | string | ALL (AND logic) or ANY (OR logic) for multiple conditions |
priority | number | Evaluation order (0 = highest priority, first matching policy wins) |
organizationId | string | Organization UUID that owns this policy |
conditions | array | Array of condition objects (field, operator, value) |
actions | array | Array of action objects (ALLOW, BLOCK, REQUIRE_APPROVAL, NOTIFY) |
createdAt | string | ISO 8601 timestamp |
updatedAt | string | ISO 8601 timestamp |
createdBy | string | User UUID who created the policy |
updatedBy | string | User UUID who last updated the policy |
deletedAt | string | ISO 8601 timestamp when the policy was soft-deleted (nullable) |
deletedBy | string | User UUID who deleted the policy (nullable) |
policies:read