Parameters

Common CipherOwl API request parameters — the chain key, address, config, hops, and namespace — and their accepted values.

This section explains the common parameters used in CipherOwl API requests. Each parameter defines the behavior and scope of the API call.

Chain

The chain parameter specifies the blockchain network on which the query will be performed. The value must be one of the following:

  • bitcoin
  • evm
  • tron
  • solana
  • bitcoin_cash
  • bitcoin_gold
  • bitcoin_sv
  • dash
  • litecoin
  • monero
  • verge
  • xrp
  • zcash

EVM addresses are shared across all EVM-compatible networks (e.g., Ethereum, Base, Optimism, etc.). Risk is evaluated based on address behavior across all EVM networks. Therefore, use evm as the chain value when querying EVM addresses.

Config

The config parameter selects a preconfigured risk model — the risk categories, hop depths, and thresholds — that the API applies when screening or scoring an address. It is optional: when omitted (or sent empty), the server resolves your organization's default configuration for the requested chain and returns the resolved name.

Risk configurations are scoped to the caller's organization, determined by the API key.

Canonical configurations

CipherOwl-managed configurations are prefixed with co-. The current
catalog covers three profiles:

ConfigNote
co-defiDeFi-focused profile. Severe risk categories, short-hop tracing.
co-vaspVASP compliance profile. All risk categories.
co-institutionBroad institutional profile. All risk categories, deep hop tracing.

An unprefixed name (e.g. defi) resolves against your organization's
customized configurations — configurations your organization has
defined on top of the CipherOwl catalog. If no org-specific configuration
matches the name, the request is rejected.

Resolved configuration in responses

Every screening / scoring response tells you which configuration was actually applied — this may differ from the request when the request omitted config and the server resolved your organization's default.

  • The screening and reason endpoints return a config field in the response body.
  • The report endpoints (/api/report/v1/…) return the resolved name in the cipherowl-resolved-config response header.

Chain support

Bitcoin, EVM, TRON, and Solana support the full canonical set (co-defi, co-institution, co-vasp). Other supported chains (bitcoin_cash, bitcoin_gold, bitcoin_sv, dash, litecoin, monero, verge, xrp, zcash) support only a reduced set — typically co-defi and co-institution at limited hop depths. Configurations available to your organization may be further restricted by tier; contact CipherOwl if you need a configuration that isn't listed.