Documentation | Policies › Get Policy Rule

Policies

policies

Methods

Create Policy ->

Policy

post/v1/policies

Create a new policy.

Get Policy ->

Policy

get/v1/policies/{policy_id}

Get a policy by policy ID.

path Parameters

policy_id: string

(minLength: 24, maxLength: 24)

Response fields

Policy

Request example

curl https://api.privy.io/v1/policies/$POLICY_ID \
    -u "$PRIVY_APP_ID:PRIVY_APP_SECRET"

200Example

{
  "id": "tb54eps4z44ed0jepousxi4n",
  "chain_type": "ethereum",
  "created_at": 1741833088894,
  "name": "Allowlisted stablecoins",
  "owner_id": null,
  "rules": [
    {
      "id": "bdyfoa65pro1eez6iwtzanol",
      "action": "ALLOW",
      "conditions": [
        {
          "field": "to",
          "field_source": "ethereum_transaction",
          "operator": "eq",
          "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
        }
      ],
      "method": "eth_sendTransaction",
      "name": "Allowlist USDC contract on Base"
    }
  ],
  "version": "1.0"
}

Get Policy Rule -> { id, action, conditions, 2 more... }

get/v1/policies/{policy_id}/rules/{rule_id}

Get a rule by policy ID and rule ID.

path Parameters

policy_id: string

(minLength: 24, maxLength: 24)

rule_id: string

(minLength: 24, maxLength: 24)

Response fields

id: string

action: "ALLOW" | "DENY"

Action to take if the conditions are true.

conditions: Array<{ field, field_source, operator, 1 more... } | { abi, field, field_source, 2 more... } | { field, field_source, operator, 1 more... } | 9 more...>

method: "eth_sendTransaction" | "eth_signTransaction" | "eth_signUserOperation" | 7 more...

Method the rule applies to.

name: string

(minLength: 1, maxLength: 50)

Request example

curl https://api.privy.io/v1/policies/$POLICY_ID/rules/$RULE_ID \
    -u "$PRIVY_APP_ID:PRIVY_APP_SECRET"

200Example

{
  "id": "rule_123",
  "action": "ALLOW",
  "conditions": [
    {
      "field": "to",
      "field_source": "ethereum_transaction",
      "operator": "eq",
      "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
    }
  ],
  "method": "eth_sendTransaction",
  "name": "Allowlist USDC contract on Base"
}

Update Policy ->

Policy

patch/v1/policies/{policy_id}

Update a policy by policy ID.

Delete Policy -> { success }

delete/v1/policies/{policy_id}

Delete a policy by policy ID.

Create Policy Rule -> { id, action, conditions, 2 more... }

post/v1/policies/{policy_id}/rules

Create a new rule for a policy.

Update Policy Rule -> { id, action, conditions, 2 more... }

patch/v1/policies/{policy_id}/rules/{rule_id}

Update a rule by policy ID and rule ID.

Delete Policy Rule -> { success }

delete/v1/policies/{policy_id}/rules/{rule_id}

Delete a rule by policy ID and rule ID.

Domain types

Policy = { id, chain_type, created_at, 4 more... }

A policy for controlling wallet operations.

SuiTransactionCommandCondition = { field, field_source, operator, 1 more... }

SUI transaction command attributes, enables allowlisting specific command types. Allowed commands: 'TransferObjects', 'SplitCoins', 'MergeCoins'. Only 'eq' and 'in' operators are supported.

SuiTransactionCommandOperator = "eq" | "in"

Operator to use for SUI transaction command conditions. Only 'eq' and 'in' are supported for command names.

SuiTransferObjectsCommandCondition = { field, field_source, operator, 1 more... }

SUI TransferObjects command attributes, including recipient and amount fields.

SuiTransferObjectsCommandField = "recipient" | "amount"

Supported fields for SUI TransferObjects command conditions. Only 'recipient' and 'amount' are supported.

TronTransactionCondition = { field, field_source, operator, 1 more... }

TRON transaction fields for TransferContract and TriggerSmartContract transaction types.