Screen address

get

https://svc.cipherowl.ai/api/screen/v1/chains/{chain}/addresses/{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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

chain

string

required

address

string

required

Query Params

config

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.

reference

string

Optional opaque reference for customer-side attribution of this request
(e.g. sub-tenant, team, workflow). Contract:

Opaque: the server never parses or interprets the value.
Format: dot-separated segments of [a-z0-9_], max 256 characters.
Input is trimmed and lowercased before validation; violations return
400 INVALID_ARGUMENT. Example: "binance.compliance.apac".
Empty or whitespace-only means absent (unreferenced).
Does not affect screening logic. Propagation: echoed on the response
as applied, stamped on structured screening logs (audit trail) and on
the Simple Case screening event. Never a metric label.
Customer-supplied and reusable across requests; never generated by
the server. Distinct from address label tags and from XRP/XLM
destination tags.

hops

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.

trackAlert

boolean

Opt this request out of Case tracking by setting it to false. Omitted
means true (APP-5011): screenings are tracked by default, and the
parameter exists so callers can opt out per request.
Event publication still requires global producer enablement, org-config
allow_case_management=true, and a risk_found=true result.
Field is named track_alert for wire-compatibility; it means
"create a Case from this screening if it triggers."

Response

200A successful response.