Screen address

Screens a single blockchain address against a risk configuration and returns a fast yes/no risk verdict (found_risk). This is the lowest-latency SRR endpoint, intended for real-time compliance checks such as gating a deposit, withdrawal, or counterparty before a transaction is allowed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Query Params
string

Selects the risk configuration (preconfigured risk model — categories,
hop depths, thresholds) to apply for this address. Accepted values are
moniker names such as co-defi, co-vasp, co-institution. Prefix
with co- to reference a CipherOwl-managed configuration. An
unprefixed name resolves against your organization's customized
configurations. When omitted or empty, the server resolves
your organization's default configuration for the requested chain and
returns the resolved name on the response. See
https://readme.cipherowl.ai/reference/parameters for the current list.

string

Optional namespace for request attribution and reporting purposes.
Format: dot-separated lowercase alphanumeric segments (e.g., "client.team", "binance.security")
Max length: 256 characters. Does not affect screening logic.
Use cases: sub-organization tracking, billing attribution, audit trails.

int32

Hop distance for multihop bloomfilter queries (0-8).
When set, uses multihop bloomfilter and checks all hops from 0 to this value.
When not set, uses legacy single-hop bloomfilter behavior.

boolean

Explicitly opt this request into Simple Case tracking. Default/omitted is false.
Event publication still requires global producer enablement, org-config
allow_simple_case=true, and a risk_found=true result.
Field is named track_alert for wire-compatibility; it means
"create a Simple Case from this screening if it triggers."

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json