Skip to main content
GET
Read the tenant Fraud Shield configuration

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Response

The tenant's resolved Fraud Shield configuration: the master switch, enforcement mode (alert-only or block), the risk-score band thresholds, the per-prefix velocity and 24h geo-spread ceilings (null keeps the platform default), the country allow/block lists, and the ML-scoring layer that blends a trained model with the heuristic score. A never-configured tenant resolves to the all-defaults config (Shield disabled).

The tenant's resolved Fraud Shield configuration: the master switch, enforcement mode (alert-only or block), the risk-score band thresholds, the per-prefix velocity and 24h geo-spread ceilings (null keeps the platform default), the country allow/block lists, and the ML-scoring layer that blends a trained model with the heuristic score. A never-configured tenant resolves to the all-defaults config (Shield disabled).

data
object
meta
object