API Documentation

Start detecting fraud in minutes

Simple REST API for real-time fraud detection. Get started with just a few lines of code.

Documentation

Quick Start

Get started with Rifraux in 3 simple steps:

1
Get your API key
Sign up and generate your API key from the dashboard
2
Make your first API call
Send a transaction for fraud scoring
3
Integrate into your system
Add fraud detection to your transaction flow

Authentication

Authenticate your API requests using the X-API-Key header:

X-API-Key: rfx_your_api_key_here

Security Tip: Never expose your API key in client-side code. Always make API calls from your backend server.

API Endpoints

POST/v1/score

Score a single transaction for fraud

curl -X POST https://api.rifraux.com/v1/score \
  -H "X-API-Key: rfx_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "transaction_id": "TXN_001",
    "amount": 1500.50,
    "currency": "NGN",
    "timestamp": "2025-10-27T10:30:00",
    "user_id": "USER_12345",
    "merchant_id": "MERCHANT_ABC",
    "transaction_type": "PAYMENT"
  }'

Response

{
  "transaction_id": "TXN_001",
  "score": 750,
  "fraud_probability": 0.75,
  "risk_level": "HIGH",
  "action": "challenge",
  "confidence": 0.85,
  "reasons": [
    "High fraud probability detected",
    "Challenge with additional verification"
  ],
  "matched_rules": ["high_fraud_probability"],
  "timestamp": "2025-10-27T10:30:01"
}

POST/v1/score/batch

Score multiple transactions in a single request

curl -X POST https://api.rifraux.com/v1/score/batch \
  -H "X-API-Key: rfx_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "transactions": [
      {
        "transaction_id": "TXN_001",
        "amount": 100.00,
        "user_id": "USER_001",
        "timestamp": "2025-10-27T10:30:00"
      },
      {
        "transaction_id": "TXN_002",
        "amount": 5000.00,
        "user_id": "USER_002",
        "timestamp": "2025-10-27T10:31:00"
      }
    ]
  }'

Ready to get started?

Generate your API key and start protecting your transactions in minutes

Get Your API Key →