Rule Engine

POST /api/v2/engine/evaluate

Allows businesses to define, manage, and execute automated compliance rules based on logical conditions. Each rule follows a clear structure:

If (Condition), then (Action)

These rules automatically evaluate incoming data, such as transactions against defined compliance criteria. When a condition is met, the system takes action, like triggering an alert or flagging a case, allowing compliance teams to respond quickly and accurately.

Typical use cases include:

• Automate compliance checks

• Enforcing country-specific regulations

• Detecting and escalating suspicious activity

This feature is currently in testing and will be available in production soon.

Travel Rule Threshold by Country

Purpose: Apply country-specific transaction thresholds in line with jurisdictional Travel Rule requirements. For each transaction, convert the transaction amount from the original currency to the official currency of the specified country (based on the country code). Compare the converted amount against the applicable Travel Rule threshold for that country.

Condition / Action: If the amount is equal to or exceeds the threshold, then, trigger an alert.

Name	Type	Description	Required
transaction_id	string	Unique identifier for the transfer, generated by the business system. Example: transfer20250312040414	True
amount	number	The value being transferred, whether for an incoming or outgoing transaction.	True
currency	string	The three-letter ISO 4217 currency code representing the currency of the transaction (Example: USD, EUR). Used to determine the value for threshold evaluation.	True
country	string	Country to verify the threshold (use ISO 3166-1 alpha-2 country code). Example: AE (United Arab Emirate)	True

Request

curl -X POST https://sandbox.ospree.io/api/v2/engine/evaluate
-h 'Content-Type: application/json' \
-h 'Accept: application/json' \
-h 'Authorization: ••••••' \
-d '{
  "transaction": {
    "transaction_id": "txn_1234567890",
    "amount": 1000,
    "currency": "USD",
    "country": "AE"
  },
  "rule_codes": [
    "THRESHOLD_BY_COUNTRY"
  ]
}' 

200 - "Breach"

 "status": "success",
  "data": {
    "transaction_id": "txn_1234567890",
    "evaluated_at": "2025-06-30T10:16:58.763539",
    "results": [
      {
        "rule_code": "THRESHOLD_BY_COUNTRY",
        "status": "breach",
        "message": "Transfer exceeds threshold (3500 AED) for AE"
      }
    ]
  }

200 - "Pass"

 "status": "success",
  "data": {
    "transaction_id": "txn_1234567890",
    "evaluated_at": "2025-06-30T10:50:44.836868",
    "results": [
      {
        "rule_code": "THRESHOLD_BY_COUNTRY",
        "status": "pass",
        "message": "Transfer is within threshold (3500 AED) for AE"
      }
    ]
  }