getGet policy rule

Required capabilitypolicies.read

Authentication: Send Authorization: Bearer <access_token>.

Reads a visible policy rule. Use its ETag response header or etag body field as If-Match when updating, activating or retiring the rule.

Parameters

Name Location Type Required Description and constraints
rule_id path string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Request

Request URL

GET
GET /policy-rules/{rule_id}

Responses

Response

application/json
{
  "name": "Large crypto withdrawal approval",
  "description": "Require compliance review for large crypto withdrawals",
  "activated_at": "2026-05-01T10:00:00Z",
  "conditions": [
    {
      "amount_basis": "usd_equivalent",
      "kind": "amount_threshold",
      "operator": "gte",
      "threshold": {
        "currency": "USD",
        "value": "10000.00"
      }
    },
    {
      "asset_class": "crypto",
      "asset_role": "principal",
      "kind": "asset_class"
    }
  ],
  "created_at": "2026-05-01T10:00:00Z",
  "decision": {
    "approver_role_ref": "roles/44444444-4444-4444-8444-444444444444",
    "initiator_cannot_approve": true,
    "kind": "require_approval",
    "reason": "large_crypto_withdrawal",
    "threshold": 2
  },
  "etag": "policy-rule-v2-0001",
  "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "operation_type": "withdrawal",
  "resource": "policy_rule",
  "retired_at": null,
  "scope_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "status": "active",
  "updated_at": "2026-05-01T10:00:00Z",
  "version": 1
}

Operation succeeded.

Response 200 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
name string Yes minLength: 1
description string or null Yes
activated_at string or string or null Yes
conditions object or object or object or object or object or object[] Yes
created_at string or string Yes
decision object or object or object Yes
etag string Yes minLength: 1
id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
operation_type "withdrawal" / "conversion" / "external_settlement_conversion" / "internal_transfer" / "on_ramp" / "off_ramp" / "loan_origination" / "loan_repayment" / "loan_liquidation" / "loan_closing" / "loan_extension" Yes
resource "policy_rule" Yes
retired_at string or string or null Yes
scope_ref string or string Yes
status "draft" / "active" / "retired" Yes
updated_at string or string Yes
version integer Yes maximum: 9007199254740991; exclusiveMinimum: 0

Additional fields are not accepted.

application/json body.description

At least one alternative must match.

application/json body.description: alternative 1

Type: string. minLength: 1

application/json body.description: alternative 2

Type: null.

application/json body.activated_at

At least one alternative must match.

application/json body.activated_at: alternative 1

At least one alternative must match.

application/json body.activated_at: alternative 1: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.activated_at: alternative 1: alternative 2

Type: string. format: date-time

application/json body.activated_at: alternative 2

Type: null.

application/json body.conditions

Type: object or object or object or object or object or object[].

application/json body.conditions item

Exactly one alternative must match.

application/json body.conditions item: alternative 1
Field Type Required Description and constraints
amount_basis "native_amount" / "usd_equivalent" Yes
kind "amount_threshold" Yes
operator "gt" / "gte" / "lt" / "lte" Yes
threshold object Yes No additional fields

Additional fields are not accepted.

application/json body.conditions item: alternative 1.threshold
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.conditions item: alternative 2
Field Type Required Description and constraints
asset_class "fiat" / "crypto" Yes
asset_role "principal" / "source" / "target" Yes
kind "asset_class" Yes

Additional fields are not accepted.

application/json body.conditions item: alternative 3
Field Type Required Description and constraints
asset_code string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
asset_role "principal" / "source" / "target" Yes
kind "asset" Yes

Additional fields are not accepted.

application/json body.conditions item: alternative 4
Field Type Required Description and constraints
direction "master_to_client" / "client_to_master" / "client_to_client" Yes
kind "direction" Yes

Additional fields are not accepted.

application/json body.conditions item: alternative 5
Field Type Required Description and constraints
initiator_ref string Yes pattern: ^(users|service-accounts|platform-principals)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
kind "initiator" Yes

Additional fields are not accepted.

application/json body.conditions item: alternative 6
Field Type Required Description and constraints
kind "conversion_asset_class_pair" Yes
source_asset_class "fiat" / "crypto" Yes
target_asset_class "fiat" / "crypto" Yes

Additional fields are not accepted.

application/json body.created_at

At least one alternative must match.

application/json body.created_at: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.created_at: alternative 2

Type: string. format: date-time

application/json body.decision

Exactly one alternative must match.

application/json body.decision: alternative 1
Field Type Required Description and constraints
kind "allow" Yes
reason string or null No

Additional fields are not accepted.

application/json body.decision: alternative 1.reason

At least one alternative must match.

application/json body.decision: alternative 1.reason: alternative 1

Type: string. minLength: 1

application/json body.decision: alternative 1.reason: alternative 2

Type: null.

application/json body.decision: alternative 2
Field Type Required Description and constraints
kind "deny" Yes
reason string Yes minLength: 1

Additional fields are not accepted.

application/json body.decision: alternative 3
Field Type Required Description and constraints
approver_role_ref string or null No
initiator_cannot_approve boolean Yes
kind "require_approval" Yes
reason string Yes minLength: 1
threshold integer Yes maximum: 9007199254740991; exclusiveMinimum: 0

Additional fields are not accepted.

application/json body.decision: alternative 3.approver_role_ref

At least one alternative must match.

application/json body.decision: alternative 3.approver_role_ref: alternative 1

Type: string. pattern: ^(roles)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.decision: alternative 3.approver_role_ref: alternative 2

Type: null.

application/json body.retired_at

At least one alternative must match.

application/json body.retired_at: alternative 1

At least one alternative must match.

application/json body.retired_at: alternative 1: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.retired_at: alternative 1: alternative 2

Type: string. format: date-time

application/json body.retired_at: alternative 2

Type: null.

application/json body.scope_ref

At least one alternative must match.

application/json body.scope_ref: alternative 1

Type: string. pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.scope_ref: alternative 2

Type: string. pattern: ^(master-accounts|client-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.updated_at

At least one alternative must match.

application/json body.updated_at: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.updated_at: alternative 2

Type: string. format: date-time

Response 400 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 401 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object or null No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer or null No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 403 schema

Content type: application/json.

See response 401 schema.

Response 404 schema

Content type: application/json.

See response 401 schema.

Response 500 schema

Content type: application/json.

See response 401 schema.

Response 502 schema

Content type: application/json.

See response 400 schema.

Response 503 schema

Content type: application/json.

See response 400 schema.