Create draft policy
curl --request POST \
--url https://api.platform.bitnob.com/policies \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "High-value transfer review",
"category": "approvals",
"description": "Require approval for transfers above $10k",
"rules": [
{
"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({
name: 'High-value transfer review',
category: 'approvals',
description: 'Require approval for transfers above $10k',
rules: [
{
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.bitnob.com/policies"
payload = {
"name": "High-value transfer review",
"category": "approvals",
"description": "Require approval for transfers above $10k",
"rules": [
{
"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",
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([
'name' => 'High-value transfer review',
'category' => 'approvals',
'description' => 'Require approval for transfers above $10k',
'rules' => [
[
'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"
payload := strings.NewReader("{\n \"name\": \"High-value transfer review\",\n \"category\": \"approvals\",\n \"description\": \"Require approval for transfers above $10k\",\n \"rules\": [\n {\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 }\n ]\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")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"High-value transfer review\",\n \"category\": \"approvals\",\n \"description\": \"Require approval for transfers above $10k\",\n \"rules\": [\n {\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 }\n ]\n}")
.asString();{
"category": "approvals",
"created_at": "2026-05-16T10:30:00Z",
"created_by": "3f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"created_by_name": "Jane Doe",
"description": "Require approval for transfers above $10k",
"id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"is_active": false,
"is_template": false,
"name": "High-value transfer review",
"object": "policy",
"priority": 100,
"rule_count": 2,
"rules": [
{
"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"
}
],
"status": "draft",
"template_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"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>"
}
}Policies
Create draft policy
Creates a new policy in draft status. Drafts are not enforced — they can be edited freely before activation. To activate, see POST /v1/policies//activate (coming in a future release). The Idempotency-Key header is required. Omitting category defaults to “access”.
POST
/
policies
Create draft policy
curl --request POST \
--url https://api.platform.bitnob.com/policies \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "High-value transfer review",
"category": "approvals",
"description": "Require approval for transfers above $10k",
"rules": [
{
"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({
name: 'High-value transfer review',
category: 'approvals',
description: 'Require approval for transfers above $10k',
rules: [
{
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.bitnob.com/policies"
payload = {
"name": "High-value transfer review",
"category": "approvals",
"description": "Require approval for transfers above $10k",
"rules": [
{
"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",
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([
'name' => 'High-value transfer review',
'category' => 'approvals',
'description' => 'Require approval for transfers above $10k',
'rules' => [
[
'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"
payload := strings.NewReader("{\n \"name\": \"High-value transfer review\",\n \"category\": \"approvals\",\n \"description\": \"Require approval for transfers above $10k\",\n \"rules\": [\n {\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 }\n ]\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")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"High-value transfer review\",\n \"category\": \"approvals\",\n \"description\": \"Require approval for transfers above $10k\",\n \"rules\": [\n {\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 }\n ]\n}")
.asString();{
"category": "approvals",
"created_at": "2026-05-16T10:30:00Z",
"created_by": "3f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"created_by_name": "Jane Doe",
"description": "Require approval for transfers above $10k",
"id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"is_active": false,
"is_template": false,
"name": "High-value transfer review",
"object": "policy",
"priority": 100,
"rule_count": 2,
"rules": [
{
"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"
}
],
"status": "draft",
"template_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"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>"
}
}Authorizations
Headers
API version (defaults to the latest supported version if omitted).
Available options:
v1 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 - 255Body
application/json
Human-readable name of the policy (2–100 characters).
Required string length:
2 - 100Example:
"High-value transfer review"
Policy category controlling how it is evaluated; defaults to "access" when omitted.
Available options:
access, whitelist, limits, approvals, velocity, compliance, quorum Example:
"approvals"
Optional free-text summary of the policy's intent.
Maximum string length:
1000Example:
"Require approval for transfers above $10k"
Optional list of inline rules; rules can also be added later via the rule endpoints.
Show child attributes
Show child attributes
Response
Created
Policy category controlling how it is evaluated: access, whitelist, limits, approvals, velocity, compliance, or quorum.
Example:
"approvals"
Timestamp when the policy was created.
Example:
"2026-05-16T10:30:00Z"
Identifier of the user who created the policy.
Example:
"3f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
Display name of the user who created the policy.
Example:
"Jane Doe"
Optional free-text summary of the policy's intent.
Example:
"Require approval for transfers above $10k"
Unique identifier of the policy.
Example:
"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
Deprecated: derived from status (true when status is "enforced"). Read status instead.
Example:
false
Whether this policy is a reusable template.
Example:
false
Human-readable name of the policy.
Example:
"High-value transfer review"
Object type discriminator; always "policy".
Example:
"policy"
Evaluation priority of the policy relative to other policies.
Example:
100
Number of rules contained in the policy.
Example:
2
The policy's rules, when expanded.
Show child attributes
Show child attributes
Canonical lifecycle status: draft, enforced, or archived.
Example:
"draft"
Identifier of the template this policy was created from, if any.
Example:
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Timestamp when the policy was last updated.
Example:
"2026-05-16T10:30:00Z"