Skip to main content
GET
/
v1
/
compliance
Get compliance status
curl --request GET \
  --url https://api.testnet.arcus.xyz/v1/compliance
{
  "geo": {
    "country": "<string>",
    "region": "<string>",
    "restrictions": {
      "perpetuals": true,
      "spot": true
    },
    "bypassed": true
  },
  "address": {
    "address": "<string>",
    "reason": "<string>"
  }
}
Returns the caller’s compliance posture for rendering banners and gating product UI. geo.restrictions is derived from the request origin (real per-product restrictions); address is the screening status of the optional ?address= query param. Use this to drive product availability without hard-coding country lists. Restricted callers retain read-only API access; only state-changing actions are blocked elsewhere (those return 403 with code: GEO_RESTRICTED). perpetuals / spot are evaluated independently — a GB caller may be perps-restricted but spot-allowed.

Query Parameters

​
address
string

Optional account address to report screening status for.

Response

Caller compliance status.

The caller's compliance posture, split into independent sections so each can evolve on its own. geo is derived from the request origin and is always present. address is the screening status of the ?address= param and is present ONLY when that param is supplied; it is omitted otherwise.

​
geo
object
required

Caller geography posture derived from the request origin.

​
address
object

On-chain / screening status of the caller's address.