Documentation | Policies

API Reference

Policies

policies

Methods

Create Policy ->

Policy

post/v1/policies

Create a new policy.

Delete Policy ->

Policy

delete/v1/policies/{policy_id}

Delete a policy by policy ID.

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 \
    -H "Authorization: Basic $PRIVY_APP_ID:$PRIVY_APP_SECRET"

200Example

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

Get Policy ->

Policy

get/v1/policies/{policy_id}

Get a policy by policy ID.

Update Policy ->

Policy

patch/v1/policies/{policy_id}

Update a policy by policy ID.

Domain types

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