Add rule to draft policy

curl --request POST \
  --url https://api.platform.bitnob.com/policies/{id}/rules \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "action_type": "require_approval",
  "name": "Block large transfers",
  "action_config": [
    "<string>"
  ],
  "conditions": [
    {
      "field": "amount_usd",
      "operator": "greater_than",
      "max": "500",
      "min": "100",
      "value": "10000",
      "values": "[\"BTC\",\"ETH\"]"
    }
  ],
  "description": "<string>",
  "order": 123
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action_type: 'require_approval',
    name: 'Block large transfers',
    action_config: ['<string>'],
    conditions: [
      {
        field: 'amount_usd',
        operator: 'greater_than',
        max: '500',
        min: '100',
        value: '10000',
        values: '["BTC","ETH"]'
      }
    ],
    description: '<string>',
    order: 123
  })
};

fetch('https://api.platform.bitnob.com/policies/{id}/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.platform.bitnob.com/policies/{id}/rules"

payload = {
    "action_type": "require_approval",
    "name": "Block large transfers",
    "action_config": ["<string>"],
    "conditions": [
        {
            "field": "amount_usd",
            "operator": "greater_than",
            "max": "500",
            "min": "100",
            "value": "10000",
            "values": "[\"BTC\",\"ETH\"]"
        }
    ],
    "description": "<string>",
    "order": 123
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.platform.bitnob.com/policies/{id}/rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action_type' => 'require_approval',
    'name' => 'Block large transfers',
    'action_config' => [
        '<string>'
    ],
    'conditions' => [
        [
                'field' => 'amount_usd',
                'operator' => 'greater_than',
                'max' => '500',
                'min' => '100',
                'value' => '10000',
                'values' => '["BTC","ETH"]'
        ]
    ],
    'description' => '<string>',
    'order' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.platform.bitnob.com/policies/{id}/rules"

	payload := strings.NewReader("{\n  \"action_type\": \"require_approval\",\n  \"name\": \"Block large transfers\",\n  \"action_config\": [\n    \"<string>\"\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"amount_usd\",\n      \"operator\": \"greater_than\",\n      \"max\": \"500\",\n      \"min\": \"100\",\n      \"value\": \"10000\",\n      \"values\": \"[\\\"BTC\\\",\\\"ETH\\\"]\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"order\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.platform.bitnob.com/policies/{id}/rules")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action_type\": \"require_approval\",\n  \"name\": \"Block large transfers\",\n  \"action_config\": [\n    \"<string>\"\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"amount_usd\",\n      \"operator\": \"greater_than\",\n      \"max\": \"500\",\n      \"min\": \"100\",\n      \"value\": \"10000\",\n      \"values\": \"[\\\"BTC\\\",\\\"ETH\\\"]\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"order\": 123\n}")
  .asString();

{
  "action_type": "require_approval",
  "conditions": [
    {
      "field": "amount_usd",
      "max": "500",
      "min": "100",
      "operator": "greater_than",
      "value": "10000",
      "values": "[\"BTC\",\"ETH\"]"
    }
  ],
  "created_at": "2026-05-16T10:30:00Z",
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Block large transfers",
  "object": "rule",
  "order": 1,
  "priority": 50,
  "updated_at": "2026-05-16T10:30:00Z"
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

POST

policies

{id}

rules

Add rule to draft policy

curl --request POST \
  --url https://api.platform.bitnob.com/policies/{id}/rules \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "action_type": "require_approval",
  "name": "Block large transfers",
  "action_config": [
    "<string>"
  ],
  "conditions": [
    {
      "field": "amount_usd",
      "operator": "greater_than",
      "max": "500",
      "min": "100",
      "value": "10000",
      "values": "[\"BTC\",\"ETH\"]"
    }
  ],
  "description": "<string>",
  "order": 123
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action_type: 'require_approval',
    name: 'Block large transfers',
    action_config: ['<string>'],
    conditions: [
      {
        field: 'amount_usd',
        operator: 'greater_than',
        max: '500',
        min: '100',
        value: '10000',
        values: '["BTC","ETH"]'
      }
    ],
    description: '<string>',
    order: 123
  })
};

fetch('https://api.platform.bitnob.com/policies/{id}/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.platform.bitnob.com/policies/{id}/rules"

payload = {
    "action_type": "require_approval",
    "name": "Block large transfers",
    "action_config": ["<string>"],
    "conditions": [
        {
            "field": "amount_usd",
            "operator": "greater_than",
            "max": "500",
            "min": "100",
            "value": "10000",
            "values": "[\"BTC\",\"ETH\"]"
        }
    ],
    "description": "<string>",
    "order": 123
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.platform.bitnob.com/policies/{id}/rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action_type' => 'require_approval',
    'name' => 'Block large transfers',
    'action_config' => [
        '<string>'
    ],
    'conditions' => [
        [
                'field' => 'amount_usd',
                'operator' => 'greater_than',
                'max' => '500',
                'min' => '100',
                'value' => '10000',
                'values' => '["BTC","ETH"]'
        ]
    ],
    'description' => '<string>',
    'order' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.platform.bitnob.com/policies/{id}/rules"

	payload := strings.NewReader("{\n  \"action_type\": \"require_approval\",\n  \"name\": \"Block large transfers\",\n  \"action_config\": [\n    \"<string>\"\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"amount_usd\",\n      \"operator\": \"greater_than\",\n      \"max\": \"500\",\n      \"min\": \"100\",\n      \"value\": \"10000\",\n      \"values\": \"[\\\"BTC\\\",\\\"ETH\\\"]\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"order\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.platform.bitnob.com/policies/{id}/rules")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action_type\": \"require_approval\",\n  \"name\": \"Block large transfers\",\n  \"action_config\": [\n    \"<string>\"\n  ],\n  \"conditions\": [\n    {\n      \"field\": \"amount_usd\",\n      \"operator\": \"greater_than\",\n      \"max\": \"500\",\n      \"min\": \"100\",\n      \"value\": \"10000\",\n      \"values\": \"[\\\"BTC\\\",\\\"ETH\\\"]\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"order\": 123\n}")
  .asString();

{
  "action_type": "require_approval",
  "conditions": [
    {
      "field": "amount_usd",
      "max": "500",
      "min": "100",
      "operator": "greater_than",
      "value": "10000",
      "values": "[\"BTC\",\"ETH\"]"
    }
  ],
  "created_at": "2026-05-16T10:30:00Z",
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Block large transfers",
  "object": "rule",
  "order": 1,
  "priority": 50,
  "updated_at": "2026-05-16T10:30:00Z"
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "type": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Headers

API-Version

enum<string>

default:v1

API version (defaults to the latest supported version if omitted).

Available options:

v1

Idempotency-Key

string

required

Unique key (1-255 printable ASCII chars) used to safely retry write operations. Same key + body returns the cached response; same key + different body returns 409.

Required string length: 1 - 255

Path Parameters

string<uuid>

required

Policy ID

Body

application/json

action_type

enum<string>

required

Action taken when the rule matches: allow, block, require_approval, alert, or delay.

Available options:

allow,

block,

require_approval,

alert,

delay

Example:

"require_approval"

name

string

required

Human-readable name of the rule (2–255 characters).

Required string length: 2 - 255

Example:

"Block large transfers"

action_config

string[]

Type-specific configuration for the action; shape depends on action_type.

conditions

object[]

Conditions that must all match for the rule to apply; optional on a draft, required when activating.

Show child attributes

description

string

Optional free-text summary of the rule's intent.

Maximum string length: 1000

order

integer

Position of the rule in the policy's first-match-wins evaluation order; appended in creation order when omitted.

Response

Created

action_config

any

Type-specific configuration for the action; shape depends on action_type.

action_type

string

Action taken when the rule matches: allow, block, require_approval, alert, or delay.

Example:

"require_approval"

conditions

object[]

Conditions that must all match for the rule to apply.

Show child attributes

created_at

string<date-time>

Timestamp when the rule was created.

Example:

"2026-05-16T10:30:00Z"

description

string

Optional free-text summary of the rule's intent.

string

Unique identifier of the rule.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

name

string

Human-readable name of the rule.

Example:

"Block large transfers"

object

string

Object type discriminator; always "rule".

Example:

"rule"

order

integer

Position of the rule in the policy's first-match-wins evaluation order.

Example:

1

priority

integer

Evaluation priority of the rule.

Example:

50

updated_at

string<date-time>

Timestamp when the rule was last updated.

Example:

"2026-05-16T10:30:00Z"

Get started

Meta

Assets

Vaults

Wallets

Transactions

Gas stations

Sponsored transfers

Consolidation

Policies

KYT

Insights

Users

Subscriptions

Webhooks

RPC

Add rule to draft policy

Authorizations

Headers

Path Parameters

Body

Response