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: Investigate flagged transactions. Cases are auto-created when rules trigger, or manually created by compliance officers.
ActionEndpointWho Can Do It
Create casePOST /api/v1/casesSUPER_ADMIN, BANK_ADMIN, COMPLIANCE_OFFICER, ANALYST
List casesGET /api/v1/casesAll authenticated users
Get case detailGET /api/v1/cases/:idAll authenticated users
Update statusPATCH /api/v1/cases/:id/statusSUPER_ADMIN, BANK_ADMIN, COMPLIANCE_OFFICER
Assign casePATCH /api/v1/cases/:id/assignSUPER_ADMIN, BANK_ADMIN, COMPLIANCE_OFFICER
Add notePOST /api/v1/cases/:id/notesAll authenticated users
Case Types:
TypeWhen It’s Created
SUSPICIOUS_TRANSACTIONTransaction BLOCKED by screening
AML_ALERTTransaction ESCALATED
SANCTIONS_HITSanctions list match detected
PEP_MATCHPolitically Exposed Person matched
FRAUD_ALERTBehavioral anomaly detected
KYC_REVIEWKYC verification issue
REGULATORY_INQUIRYManual regulatory investigation
BEHAVIORAL_ANOMALYDevice/velocity anomaly flagged
Case Statuses (Lifecycle): 
OPEN → IN_PROGRESS → PENDING_REVIEW → ESCALATED → RESOLVED_TRUE_POSITIVE / RESOLVED_FALSE_POSITIVE → CLOSED
Create Case Request: 
{
  "type": "SUSPICIOUS_TRANSACTION",
  "priority": "HIGH",
  "title": "Large cash deposit — possible structuring",
  "description": "Customer made 4 deposits totaling ₦4.8M in 3 hours",
  "relatedTransactionId": "uuid-of-transaction",
  "tags": ["structuring", "cash"]
}
Filtering cases: 
GET /api/v1/cases?status=OPEN&type=SANCTIONS_HIT&priority=CRITICAL&page=1&limit=20