Skip to content

Reference

API

Stripe-shaped: bearer authentication, snake_case fields, `object` discriminators and an evidence envelope on every claim. Endpoints not yet built are listed as such rather than documented as if they exist.

Authentication

curl http://localhost:3000/v1/providers \
  -H "Authorization: Bearer rail_test_your_key_here"

Test keys (rail_test_…) stay revealable in the dashboard. Live keys (rail_live_…) are shown once and stored hashed.

Endpoints

POST/v1/corridors/searchBetaEvaluate every provider against a corridor.
GET/v1/providersBetaList mapped providers, filterable by product or country.
GET/v1/changesBetaDetected changes, newest first. Filter by provider, or since a duration (7d/24h) or ISO date.
POST/v1/eligibilityBetaReadiness against your org's KYB profile: what is satisfied, what is outstanding, per provider.
GET/v1/watchlistsBetaList monitors with unread alert counts.
POST/v1/watchlistsBetaArm a monitor on a provider, corridor, country, asset or product. Idempotent per target.
GET·PATCH·DELETE/v1/watchlists/{id}BetaInspect, retune or disarm one monitor; GET includes recent alerts.
GET/v1/watchlists/{id}/alertsBetaWhat one monitor has raised, newest first.
POST/v1/compareComing soonLike-for-like comparison of 2–4 providers.
GET/v1/capabilitiesComing soonRaw capability rows with evidence.

Errors

{
  "object": "error",
  "error": {
    "code": "invalid_api_key",
    "message": "That API key is not valid."
  }
}

401 missing_api_key · 401 invalid_api_key · 400 invalid_request · 404 provider_not_found · 404 watchlist_not_found · 404 target_not_found