Skip to main content
POST
/
policies
Create a new policy
curl --request POST \
  --url https://api.platform.dakota.xyz/policies \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "name": "High Value Transaction Policy",
  "description": "Requires approval for transactions above $10,000",
  "signer_group_id": "grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
  "rules": [
    {
      "rule_type": "amount_threshold",
      "action": "deny",
      "definition": {
        "amount": "10000",
        "currency": "USD"
      }
    }
  ]
}
'
{
  "id": "pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
  "client_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
  "version": 1,
  "name": "High Value Transaction Policy",
  "description": "Requires approval for transactions above $10,000",
  "rules": [
    {
      "id": "rule_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
      "policy_id": "pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT",
      "rule_type": "amount_threshold",
      "action": "deny",
      "definition": {
        "amount": "10000",
        "currency": "USD"
      },
      "created_at": 1640995200
    }
  ],
  "created_at": 1640995200,
  "updated_at": 1640995200
}

Documentation Index

Fetch the complete documentation index at: https://docs.dakota.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
x-api-key
string
header
required

Headers

ā€‹
x-idempotency-key
string<uuid>
required

Unique key to ensure request idempotency. If the same key is used within a certain time window, the original response will be returned instead of executing the request again.

Body

application/json
ā€‹
name
string
required

Human-readable name for the policy

Example:

"High Value Transaction Policy"

ā€‹
description
string | null

Optional description of the policy's purpose

Example:

"Requires approval for transactions above $10,000"

ā€‹
signer_group_id
string | null

ID of the signer group to associate with this policy

Example:

"grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT"

ā€‹
rules
object[]

Initial rules for this policy

Response

Policy created successfully

ā€‹
id
string
required

Unique identifier for the policy

Example:

"pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT"

ā€‹
version
integer<int32>
required

Version number of the policy (incremented on rule changes)

Example:

1

ā€‹
name
string
required

Human-readable name for the policy

Example:

"High Value Transaction Policy"

ā€‹
created_at
integer
required

Unix timestamp when the policy was created

Example:

1640995200

ā€‹
updated_at
integer
required

Unix timestamp when the policy was last updated

Example:

1640995200

ā€‹
client_id
string

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

ā€‹
signer_group_id
string | null

ID of the signer group that governs mutations of this policy. Members of this group must endorse any add_policy_rule, update_policy_rule, remove_policy_rule, or delete_policy intent.

Example:

"grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT"

ā€‹
description
string | null

Optional description of the policy's purpose

Example:

"Requires approval for transactions above $10,000"

ā€‹
rules
object[]

Rules that make up this policy