Documentation

API Reference

The FraudDetect API lets you check a customer's delivery history across 5 Bangladeshi couriers — Steadfast, Pathao, RedX, Paperfly, and Carrybee — in a single HTTP request.

Base URL

api.frauddetect.io

Protocol

HTTPS only

Format

JSON

Authentication

All API requests require an X-Api-Key header with your secret key. Get your key from the dashboard.

curl

curl -X POST https://api.frauddetect.io/api/v1/check \
  -H "X-Api-Key: sk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"phone": "01711223344"}'

Rate Limits

Each API key is limited to 30 requests per minute. Exceeding this returns a 429 Too Many Requests response.

Rate limits are per API key. Create multiple keys for different environments if you need higher throughput.

Endpoints

POST/api/v1/checkX-Api-Key header

Check fraud risk for a Bangladeshi phone number. Returns delivery history across all 5 couriers with an aggregated score.

Request body

JSON

{
  "phone": "01711223344"
}

Response (200 OK)

JSON

{
  "steadfast": { "success": 3,  "cancel": 1, "total": 4  },
  "pathao":    { "success": 5,  "cancel": 2, "total": 7  },
  "redx":      { "success": 20, "cancel": 5, "total": 25 },
  "paperfly":  { "success": 0,  "cancel": 0, "total": 1  },
  "carrybee":  { "success": 10, "cancel": 0, "total": 10 },
  "aggregate": {
    "total_success":    38,
    "total_deliveries": 47,
    "success_ratio":    80.85,
    "cancel_ratio":     17.02
  }
}

Phone Number Format

Phone numbers must be in local Bangladeshi format — 11 digits, starting with 01. Do not include the country code (+88).

Valid

0171122334401876543219

Invalid

+88017112233448801711223344

Error Codes

401UnauthorizedMissing or invalid X-Api-Key header.

422Validation ErrorPhone number is missing or in wrong format.

429Too Many RequestsRate limit exceeded — 30 req/min per key.

500Server ErrorUnexpected server error — please contact support.