Evaluate

Evaluate controls

Evaluates organization controls for JSON null, or effective order controls for an order context with a resolved instrument. Non-equity instruments are blocked. Supply side when position or daily-loss controls apply; those controls block orders without it. Both allowed and blocked results return 200. Users and API keys require Controls Basic or Premium. Users need an organization role; API keys need control read permission for the account environment, or both environments for null. Services need control:evaluate and x-organization-id.

POST

controls

evaluate

Evaluate controls

curl --request POST \
  --url https://api.anthid.com/v1/controls/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "instrument": {
    "asset_class": "EQUITY",
    "exchange": "NASDAQ",
    "symbol": "AAPL"
  },
  "quantity": "100",
  "side": "BUY",
  "symbol": "AAPL"
}
'

import requests

url = "https://api.anthid.com/v1/controls/evaluate"

payload = {
    "account_id": "550e8400-e29b-41d4-a716-446655440000",
    "instrument": {
        "asset_class": "EQUITY",
        "exchange": "NASDAQ",
        "symbol": "AAPL"
    },
    "quantity": "100",
    "side": "BUY",
    "symbol": "AAPL"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: '550e8400-e29b-41d4-a716-446655440000',
    instrument: {asset_class: 'EQUITY', exchange: 'NASDAQ', symbol: 'AAPL'},
    quantity: '100',
    side: 'BUY',
    symbol: 'AAPL'
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anthid.com/v1/controls/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([
    'account_id' => '550e8400-e29b-41d4-a716-446655440000',
    'instrument' => [
        'asset_class' => 'EQUITY',
        'exchange' => 'NASDAQ',
        'symbol' => 'AAPL'
    ],
    'quantity' => '100',
    'side' => 'BUY',
    'symbol' => 'AAPL'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.anthid.com/v1/controls/evaluate"

	payload := strings.NewReader("{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"instrument\": {\n    \"asset_class\": \"EQUITY\",\n    \"exchange\": \"NASDAQ\",\n    \"symbol\": \"AAPL\"\n  },\n  \"quantity\": \"100\",\n  \"side\": \"BUY\",\n  \"symbol\": \"AAPL\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.anthid.com/v1/controls/evaluate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"instrument\": {\n    \"asset_class\": \"EQUITY\",\n    \"exchange\": \"NASDAQ\",\n    \"symbol\": \"AAPL\"\n  },\n  \"quantity\": \"100\",\n  \"side\": \"BUY\",\n  \"symbol\": \"AAPL\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anthid.com/v1/controls/evaluate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"instrument\": {\n    \"asset_class\": \"EQUITY\",\n    \"exchange\": \"NASDAQ\",\n    \"symbol\": \"AAPL\"\n  },\n  \"quantity\": \"100\",\n  \"side\": \"BUY\",\n  \"symbol\": \"AAPL\"\n}"

response = http.request(request)
puts response.read_body

{
  "allowed": false,
  "triggered": [
    {
      "control_type": "Manual",
      "reason": "Symbol restricted during earnings",
      "scope": {
        "Symbol": {
          "account_id": "550e8400-e29b-41d4-a716-446655440000",
          "symbol": "AAPL"
        }
      }
    }
  ]
}

"<string>"

"<string>"

<string>

<string>

<string>

"<string>"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-organization-id

string<uuid> | null

Organization ID required for service-account credentials

Body

application/json

JSON null for organization-only evaluation, or a complete order context including its required instrument

account_id

string<uuid>

required

instrument

object

required

What is being traded.

Mandatory, and that is the safety property. A control has to be evaluated against the same instrument the order is placed in, so the caller resolves once and carries it: this service resolving independently would leave a window where it judged one instrument and the order was placed in another, which a catalogue sync between the two is enough to open.

There is deliberately no "unknown" case. An order in something the catalogue cannot identify is not an order this platform can price, and the caller refuses it before reaching here rather than sending an absence for the evaluator to interpret.

Show child attributes

quantity

string

required

symbol

string

required

The venue's spelling, which is what symbol-scoped controls are keyed on. Kept beside instrument rather than read out of it: a control the tenant wrote against ESZ25 has to match whether or not the catalogue resolved that order, and the key must not change depending on whether the resolution succeeded.

side

null | enum<string>

Which way the order moves the position.

Position size and daily loss limits need it: whether an order opens or closes a position is the whole question they ask. Optional on the wire so a caller built before it existed still parses, but a request without it is refused by any control that needs it rather than guessed at.

Available options:

UNSPECIFIED,

BUY,

SELL,

SELL_SHORT

Response

Control evaluation result

allowed

boolean

required

triggered

object[]

required

Show child attributes

Evaluate controls

curl --request POST \
  --url https://api.anthid.com/v1/controls/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "instrument": {
    "asset_class": "EQUITY",
    "exchange": "NASDAQ",
    "symbol": "AAPL"
  },
  "quantity": "100",
  "side": "BUY",
  "symbol": "AAPL"
}
'

import requests

url = "https://api.anthid.com/v1/controls/evaluate"

payload = {
    "account_id": "550e8400-e29b-41d4-a716-446655440000",
    "instrument": {
        "asset_class": "EQUITY",
        "exchange": "NASDAQ",
        "symbol": "AAPL"
    },
    "quantity": "100",
    "side": "BUY",
    "symbol": "AAPL"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: '550e8400-e29b-41d4-a716-446655440000',
    instrument: {asset_class: 'EQUITY', exchange: 'NASDAQ', symbol: 'AAPL'},
    quantity: '100',
    side: 'BUY',
    symbol: 'AAPL'
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anthid.com/v1/controls/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([
    'account_id' => '550e8400-e29b-41d4-a716-446655440000',
    'instrument' => [
        'asset_class' => 'EQUITY',
        'exchange' => 'NASDAQ',
        'symbol' => 'AAPL'
    ],
    'quantity' => '100',
    'side' => 'BUY',
    'symbol' => 'AAPL'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.anthid.com/v1/controls/evaluate"

	payload := strings.NewReader("{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"instrument\": {\n    \"asset_class\": \"EQUITY\",\n    \"exchange\": \"NASDAQ\",\n    \"symbol\": \"AAPL\"\n  },\n  \"quantity\": \"100\",\n  \"side\": \"BUY\",\n  \"symbol\": \"AAPL\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.anthid.com/v1/controls/evaluate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"instrument\": {\n    \"asset_class\": \"EQUITY\",\n    \"exchange\": \"NASDAQ\",\n    \"symbol\": \"AAPL\"\n  },\n  \"quantity\": \"100\",\n  \"side\": \"BUY\",\n  \"symbol\": \"AAPL\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anthid.com/v1/controls/evaluate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"instrument\": {\n    \"asset_class\": \"EQUITY\",\n    \"exchange\": \"NASDAQ\",\n    \"symbol\": \"AAPL\"\n  },\n  \"quantity\": \"100\",\n  \"side\": \"BUY\",\n  \"symbol\": \"AAPL\"\n}"

response = http.request(request)
puts response.read_body

{
  "allowed": false,
  "triggered": [
    {
      "control_type": "Manual",
      "reason": "Symbol restricted during earnings",
      "scope": {
        "Symbol": {
          "account_id": "550e8400-e29b-41d4-a716-446655440000",
          "symbol": "AAPL"
        }
      }
    }
  ]
}

"<string>"

"<string>"

<string>

<string>

<string>

"<string>"

Connections

Organizations

Controls

Accounts

Intents

Ledger

Instruments

Stream

MCP

Billing

Evaluate controls

Authorizations

Headers

Body

Response