Dry-run policy evaluation

curl --request POST \
  --url https://api.platform.bitnob.com/policies/evaluate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "actor_id": "<string>",
  "actor_type": "<string>",
  "amount": "<string>",
  "amount_raw": "<string>",
  "amount_usd": "<string>",
  "asset_symbol": "<string>",
  "automation_rule_id": "<string>",
  "chain": "<string>",
  "connection_id": "<string>",
  "destination_type": "<string>",
  "from_address": "<string>",
  "is_automated": true,
  "network": "<string>",
  "operation_type": "<string>",
  "policy_id": "<string>",
  "source_type": "<string>",
  "to_address": "<string>",
  "token_address": "<string>",
  "tx_type": "<string>",
  "user_id": "<string>",
  "vault_id": "<string>",
  "wallet_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actor_id: '<string>',
    actor_type: '<string>',
    amount: '<string>',
    amount_raw: '<string>',
    amount_usd: '<string>',
    asset_symbol: '<string>',
    automation_rule_id: '<string>',
    chain: '<string>',
    connection_id: '<string>',
    destination_type: '<string>',
    from_address: '<string>',
    is_automated: true,
    network: '<string>',
    operation_type: '<string>',
    policy_id: '<string>',
    source_type: '<string>',
    to_address: '<string>',
    token_address: '<string>',
    tx_type: '<string>',
    user_id: '<string>',
    vault_id: '<string>',
    wallet_id: '<string>'
  })
};

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

import requests

url = "https://api.platform.bitnob.com/policies/evaluate"

payload = {
    "actor_id": "<string>",
    "actor_type": "<string>",
    "amount": "<string>",
    "amount_raw": "<string>",
    "amount_usd": "<string>",
    "asset_symbol": "<string>",
    "automation_rule_id": "<string>",
    "chain": "<string>",
    "connection_id": "<string>",
    "destination_type": "<string>",
    "from_address": "<string>",
    "is_automated": True,
    "network": "<string>",
    "operation_type": "<string>",
    "policy_id": "<string>",
    "source_type": "<string>",
    "to_address": "<string>",
    "token_address": "<string>",
    "tx_type": "<string>",
    "user_id": "<string>",
    "vault_id": "<string>",
    "wallet_id": "<string>"
}
headers = {
    "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/evaluate",
  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([
    'actor_id' => '<string>',
    'actor_type' => '<string>',
    'amount' => '<string>',
    'amount_raw' => '<string>',
    'amount_usd' => '<string>',
    'asset_symbol' => '<string>',
    'automation_rule_id' => '<string>',
    'chain' => '<string>',
    'connection_id' => '<string>',
    'destination_type' => '<string>',
    'from_address' => '<string>',
    'is_automated' => true,
    'network' => '<string>',
    'operation_type' => '<string>',
    'policy_id' => '<string>',
    'source_type' => '<string>',
    'to_address' => '<string>',
    'token_address' => '<string>',
    'tx_type' => '<string>',
    'user_id' => '<string>',
    'vault_id' => '<string>',
    'wallet_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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/evaluate"

	payload := strings.NewReader("{\n  \"actor_id\": \"<string>\",\n  \"actor_type\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"amount_raw\": \"<string>\",\n  \"amount_usd\": \"<string>\",\n  \"asset_symbol\": \"<string>\",\n  \"automation_rule_id\": \"<string>\",\n  \"chain\": \"<string>\",\n  \"connection_id\": \"<string>\",\n  \"destination_type\": \"<string>\",\n  \"from_address\": \"<string>\",\n  \"is_automated\": true,\n  \"network\": \"<string>\",\n  \"operation_type\": \"<string>\",\n  \"policy_id\": \"<string>\",\n  \"source_type\": \"<string>\",\n  \"to_address\": \"<string>\",\n  \"token_address\": \"<string>\",\n  \"tx_type\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"vault_id\": \"<string>\",\n  \"wallet_id\": \"<string>\"\n}")

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

	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/evaluate")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actor_id\": \"<string>\",\n  \"actor_type\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"amount_raw\": \"<string>\",\n  \"amount_usd\": \"<string>\",\n  \"asset_symbol\": \"<string>\",\n  \"automation_rule_id\": \"<string>\",\n  \"chain\": \"<string>\",\n  \"connection_id\": \"<string>\",\n  \"destination_type\": \"<string>\",\n  \"from_address\": \"<string>\",\n  \"is_automated\": true,\n  \"network\": \"<string>\",\n  \"operation_type\": \"<string>\",\n  \"policy_id\": \"<string>\",\n  \"source_type\": \"<string>\",\n  \"to_address\": \"<string>\",\n  \"token_address\": \"<string>\",\n  \"tx_type\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"vault_id\": \"<string>\",\n  \"wallet_id\": \"<string>\"\n}")
  .asString();

{
  "allowed": false,
  "result": "matched_rule",
  "trace": [
    {
      "failed_condition": {
        "actual": "500",
        "expected": "10000",
        "field": "amount_usd",
        "operator": "greater_than"
      },
      "rule_index": 0
    }
  ]
}

{
  "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

Dry-run policy evaluation

Runs the policy engine against a synthetic transaction request and returns the decision without any side effects. No approval requests are created, no audit log entries are written, and no transactions are inserted.

Use this endpoint to preview how the active policy would respond to a given request before committing to it — for example, when configuring automation rules or testing policy changes.

All request fields are optional. Omitting a field means ‘not applicable’ for that condition axis. When no active policy exists the verdict is ‘no_match’ with Allowed=true.

The response includes a trace field containing a per-rule evaluation trace when the evaluator supports it. Each entry records whether the rule matched and, if not, which condition failed first.

POST

policies

evaluate

Dry-run policy evaluation

curl --request POST \
  --url https://api.platform.bitnob.com/policies/evaluate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "actor_id": "<string>",
  "actor_type": "<string>",
  "amount": "<string>",
  "amount_raw": "<string>",
  "amount_usd": "<string>",
  "asset_symbol": "<string>",
  "automation_rule_id": "<string>",
  "chain": "<string>",
  "connection_id": "<string>",
  "destination_type": "<string>",
  "from_address": "<string>",
  "is_automated": true,
  "network": "<string>",
  "operation_type": "<string>",
  "policy_id": "<string>",
  "source_type": "<string>",
  "to_address": "<string>",
  "token_address": "<string>",
  "tx_type": "<string>",
  "user_id": "<string>",
  "vault_id": "<string>",
  "wallet_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actor_id: '<string>',
    actor_type: '<string>',
    amount: '<string>',
    amount_raw: '<string>',
    amount_usd: '<string>',
    asset_symbol: '<string>',
    automation_rule_id: '<string>',
    chain: '<string>',
    connection_id: '<string>',
    destination_type: '<string>',
    from_address: '<string>',
    is_automated: true,
    network: '<string>',
    operation_type: '<string>',
    policy_id: '<string>',
    source_type: '<string>',
    to_address: '<string>',
    token_address: '<string>',
    tx_type: '<string>',
    user_id: '<string>',
    vault_id: '<string>',
    wallet_id: '<string>'
  })
};

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

import requests

url = "https://api.platform.bitnob.com/policies/evaluate"

payload = {
    "actor_id": "<string>",
    "actor_type": "<string>",
    "amount": "<string>",
    "amount_raw": "<string>",
    "amount_usd": "<string>",
    "asset_symbol": "<string>",
    "automation_rule_id": "<string>",
    "chain": "<string>",
    "connection_id": "<string>",
    "destination_type": "<string>",
    "from_address": "<string>",
    "is_automated": True,
    "network": "<string>",
    "operation_type": "<string>",
    "policy_id": "<string>",
    "source_type": "<string>",
    "to_address": "<string>",
    "token_address": "<string>",
    "tx_type": "<string>",
    "user_id": "<string>",
    "vault_id": "<string>",
    "wallet_id": "<string>"
}
headers = {
    "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/evaluate",
  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([
    'actor_id' => '<string>',
    'actor_type' => '<string>',
    'amount' => '<string>',
    'amount_raw' => '<string>',
    'amount_usd' => '<string>',
    'asset_symbol' => '<string>',
    'automation_rule_id' => '<string>',
    'chain' => '<string>',
    'connection_id' => '<string>',
    'destination_type' => '<string>',
    'from_address' => '<string>',
    'is_automated' => true,
    'network' => '<string>',
    'operation_type' => '<string>',
    'policy_id' => '<string>',
    'source_type' => '<string>',
    'to_address' => '<string>',
    'token_address' => '<string>',
    'tx_type' => '<string>',
    'user_id' => '<string>',
    'vault_id' => '<string>',
    'wallet_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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/evaluate"

	payload := strings.NewReader("{\n  \"actor_id\": \"<string>\",\n  \"actor_type\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"amount_raw\": \"<string>\",\n  \"amount_usd\": \"<string>\",\n  \"asset_symbol\": \"<string>\",\n  \"automation_rule_id\": \"<string>\",\n  \"chain\": \"<string>\",\n  \"connection_id\": \"<string>\",\n  \"destination_type\": \"<string>\",\n  \"from_address\": \"<string>\",\n  \"is_automated\": true,\n  \"network\": \"<string>\",\n  \"operation_type\": \"<string>\",\n  \"policy_id\": \"<string>\",\n  \"source_type\": \"<string>\",\n  \"to_address\": \"<string>\",\n  \"token_address\": \"<string>\",\n  \"tx_type\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"vault_id\": \"<string>\",\n  \"wallet_id\": \"<string>\"\n}")

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

	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/evaluate")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actor_id\": \"<string>\",\n  \"actor_type\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"amount_raw\": \"<string>\",\n  \"amount_usd\": \"<string>\",\n  \"asset_symbol\": \"<string>\",\n  \"automation_rule_id\": \"<string>\",\n  \"chain\": \"<string>\",\n  \"connection_id\": \"<string>\",\n  \"destination_type\": \"<string>\",\n  \"from_address\": \"<string>\",\n  \"is_automated\": true,\n  \"network\": \"<string>\",\n  \"operation_type\": \"<string>\",\n  \"policy_id\": \"<string>\",\n  \"source_type\": \"<string>\",\n  \"to_address\": \"<string>\",\n  \"token_address\": \"<string>\",\n  \"tx_type\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"vault_id\": \"<string>\",\n  \"wallet_id\": \"<string>\"\n}")
  .asString();

{
  "allowed": false,
  "result": "matched_rule",
  "trace": [
    {
      "failed_condition": {
        "actual": "500",
        "expected": "10000",
        "field": "amount_usd",
        "operator": "greater_than"
      },
      "rule_index": 0
    }
  ]
}

{
  "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

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

Body

application/json

actor_id

string

Specific API key ID or user ID of the initiator.

actor_type

string

Initiator class: apikey or session. Empty means rules on actor_type won't match.

amount

string

Amount as a human-readable decimal in the asset's display unit.

amount_raw

string

Amount as an integer in the asset's smallest base unit.

amount_usd

string

Approximate USD value of the amount, for USD-threshold rules.

asset_symbol

string

Symbol of the asset involved.

automation_rule_id

string

Identifier of the automation rule driving the operation, when automated.

chain

string

Blockchain the synthetic operation is on.

connection_id

string

Identifier of the connection the operation flows through, if any.

destination_type

string

Destination classification for the operation.

from_address

string

Sender address of the synthetic operation.

is_automated

boolean

Whether the operation is initiated by automation rather than a user.

network

string

Network the synthetic operation is on.

operation_type

string

Operation being evaluated (e.g. the transaction/operation type).

policy_id

string

Evaluate against this specific policy (any state) instead of the currently-enforced one. Absent uses the enforced policy.

source_type

string

Source classification of the funds/operation.

to_address

string

Recipient address of the synthetic operation.

token_address

string

Token contract address, for token operations.

tx_type

string

Transaction type of the synthetic operation.

user_id

string

Initiating user, for rules conditioning on the user.

vault_id

string

Vault the synthetic operation targets.

wallet_id

string

Wallet the synthetic operation targets.

Response

Success

allowed

boolean

Whether the synthetic request would be allowed.

Example:

false

delay_minutes

integer

Delay in minutes applied by a delay-action rule.

expiry_hours

integer

Approval expiry window in hours, when approval is required.

policy_id

string

Identifier of the policy that produced the decision.

reason

string

Human-readable explanation of the decision.

required_approvals

integer

Number of approvals required (the N in N-of-M), when approval is required.

requires_approval

boolean

True when the matched rule's action is require_approval.

result

string

Decision outcome: matched_rule, quorum, no_match, approved, rejected, awaiting_approval, or delayed.

Example:

"matched_rule"

rule_id

string

Identifier of the specific rule that matched, if any.

trace

object[]

Per-rule evaluation trace; omitted on no_match / quorum-only paths.

Show child attributes

Get started

Meta

Assets

Vaults

Wallets

Transactions

Gas stations

Sponsored transfers

Consolidation

Policies

KYT

Insights

Users

Subscriptions

Webhooks

RPC

Dry-run policy evaluation

Authorizations

Headers

Body

Response