API Documentation

PAUSE Risk Engine REST API — Bayesian address risk scoring with 11 independent signals.

BASE URL

https://pause.tcher.io/api/v1

Authentication

Two authentication methods are supported. The scanner endpoint works without auth (rate-limited).

API Key

X-API-Key: pause_xxxxxxxxxxxx

Pass in header. Get one via signup or POST /keys.

JWT

Authorization: Bearer <token>

From /auth/login or /auth/signup. 7-day expiry.

Plans & Limits

Starter (Free)

Free

Scans: 25/day

Rate: 5/min

Watchlist: 5

Webhooks: 1

Starter Plus

$9/mo

Scans: 100/day

Rate: 15/min

Watchlist: 25

Webhooks: 3

Pro

$29/mo

Scans: 500/day

Rate: 60/min

Watchlist: 200

Webhooks: 10

Core Endpoints

Auth Endpoints

Watchlist Endpoints

Webhook Endpoints

Alert Events

score_changeFires when risk score changes by 5+ points

risk_changeFires when risk level transitions (SAFE↔MEDIUM↔HIGH)

threshold_breachFires when score change exceeds user-set threshold

Webhook Payload Format

{
  "event": "risk_change",
  "timestamp": 1707654321,
  "data": {
    "address": "0x742d35cc...",
    "old_score": 85.0,
    "new_score": 42.0,
    "old_risk": "SAFE",
    "new_risk": "HIGH",
    "delta": -43.0
  }
}

// Verify with X-Pause-Signature header (HMAC-SHA256)