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: Submit transactions for real-time AML/CFT screening. This is the core module.
ActionEndpointWho Can Do It
Screen transactionPOST /api/v1/transactions/screenAll authenticated users
List transactionsGET /api/v1/transactionsAll authenticated users
Get transaction detailGET /api/v1/transactions/:idAll authenticated users
What you send: See the Integration Guide above for the full field reference. What you get back: A verdict with outcome (APPROVE/REVIEW/ESCALATE/BLOCK), riskLevel, aggregateScore, riskBreakdown per engine category, and triggeredRules. Filtering transactions: 
GET /api/v1/transactions?outcome=BLOCK&riskLevel=CRITICAL&type=TRANSFER&page=1&limit=20