Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ratel-docs.bevars.com/llms.txt

Use this file to discover all available pages before exploring further.

Purpose: Create, edit, activate, and pause custom detection rules. These are bank-specific rules that run alongside the 7 mandatory CBN rules.
ActionEndpointWho Can Do It
Create rulePOST /api/v1/rulesSUPER_ADMIN, BANK_ADMIN, COMPLIANCE_OFFICER
List rulesGET /api/v1/rulesAll authenticated users
Get rule detailGET /api/v1/rules/:idAll authenticated users
Update rulePATCH /api/v1/rules/:idSUPER_ADMIN, BANK_ADMIN, COMPLIANCE_OFFICER
Activate rulePATCH /api/v1/rules/:id/activateSUPER_ADMIN, BANK_ADMIN
Pause rulePATCH /api/v1/rules/:id/pauseSUPER_ADMIN, BANK_ADMIN
Delete ruleDELETE /api/v1/rules/:idSUPER_ADMIN, BANK_ADMIN
Create Rule Request: 
{
  "name": "High-Value ATM Withdrawal",
  "description": "Flag ATM withdrawals over ₦500,000",
  "ruleType": "CUSTOM",
  "configuration": {
    "conditions": [
      { "field": "amount", "operator": "GREATER_THAN", "value": 500000 },
      { "field": "channel", "operator": "EQUALS", "value": "ATM" }
    ],
    "conditionLogic": "AND",
    "outcome": "REVIEW",
    "riskScore": 45,
    "actions": ["NOTIFY_OFFICER"]
  },
  "scoreModifier": 45
}
Note: The 7 CBN mandatory rules cannot be edited, paused, or deleted. They appear in rule listings with ruleType: "CBN_BUILTIN".