Creating a policy

To create a new policy, make a POST request to:

https://api.privy.io/v1/policies

Body

In the request body, include the following:

Field	Type	Description
version	'1.0'	Version of the policy. Currently, 1.0 is the only version.
name	string	Name to assign to policy.
chain_type	'ethereum'	Chain type for wallets that the policy will be applied to.
rules	Rule	A list of Rule objects describing what rules to apply to each RPC method (e.g. 'eth_sendTransaction') that the wallet can take. Learn more about Rules.
owner_id	string	(Optional) The key quorum that must sign in order to update the policy. Cannot be used with the owner input.
owner	{ public_key: string }	(Optional) The P-256 signing that must sign in order to update the policy. Accepts a PEM-encoded P-256 public key under the public_key key of an object. Cannot be used with the owner_id input.

Once you have successfully created a policy, you can assign that policy to server wallets at creation.

INFO

Currently, the policy engine supports the eth_signTransaction and eth_sendTransaction RPC methods and the ethereum_transaction field source. We are actively expanding support here.

Response

If the policy is created successfully, the response will include the request body as well as an additional unique id field for the policy.

Field	Type	Description
id	string	Unique ID for the policy.
version	'1.0'	Version of the policy. Currently, 1.0 is the only version.
name	string	Name to assign to policy.
chain_type	'ethereum'	Chain type for wallets that the policy will be applied to.
rules	Rule	A list of Rule objects describing what rules to apply to each RPC method (e.g. 'eth_sendTransaction') that the wallet can take. Learn more about Rules.
owner_id	string	Unique ID for the key quorum that owns this policy.

Example

As an example, a sample request to create a new eth_sendTransaction policy might look like the following:

$ curl --request POST https://api.privy.io/v1/policies \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>" \
-H "privy-authorization-signature: <authorization-signature-for-request>" \
-H 'Content-Type: application/json' \
-d '{
    "version": "1.0",
    "name": "Allow list certain smart contracts",
    "chain_type": "ethereum",
    "rules": [{
      "name": "Allow list USDC",
      "method": "eth_sendTransaction",
      "conditions": [
          {
              "field_source": "ethereum_transaction",
              "field": "to",
              "operator": "eq",
              "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
          }
      ],
      "action": "ALLOW"
    }],
    "owner": {
      "public_key": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEx4aoeD72yykviK+f/ckqE2CItVIG\n1rCnvC3/XZ1HgpOcMEMialRmTrqIK4oZlYd1RfxU3za/C9yjhboIuoPD3g==\n-----END PUBLIC KEY-----"
    }
}'

A successful response will look like the following:

{
  "id": "fmfdj6yqly31huorjqzq38zc",
  "name": "Allow list certain smart contracts",
  "version": "1.0",
  "chain_type": "ethereum",
  "rules": [
    {
      "name": "Allow list USDC",
      "method": "eth_sendTransaction",
      "conditions": [
        {
          "field_source": "ethereum_transaction",
          "field": "to",
          "operator": "eq",
          "value": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
        }
      ],
      "action": "ALLOW"
    }
  ],
  "owner_id": "rkiz0ivz254drv1xw982v3jq"
}