Compliance

Screen an address across configured compliance providers

Runs address screening against configured compliance providers and returns provider-level risk scores.

post/v1/compliance/address-screenings

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

addressstring required

Address to screen.

networkstring

Network identifier expected by the compliance provider.

intent'transfer_destination' | 'wallet_address_addition' | 'unknown'

Business intent for address screening.

Example request

{
  "address": "8dHEsGLpCZHZbXnFVvqWq4kMfM2pVDuNrXvVJVhQWRGZ",
  "network": "solana",
  "intent": "transfer_destination"
}

Response

Address screening results

Example response

{
  "data": {
    "screening": {
      "address": "8dHEsGLpCZHZbXnFVvqWq4kMfM2pVDuNrXvVJVhQWRGZ",
      "network": "solana",
      "intent": "transfer_destination",
      "checkedAt": "2025-01-01T00:00:00.000Z",
      "providers": [
        {
          "provider": "range",
          "status": "ok",
          "riskScore": 7,
          "riskLevel": "High risk",
          "evaluatedAt": "2025-01-01T00:00:00.000Z"
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 1 of the 9 revisions of this API.4

Aug 15, 20263e302bba53864See the full diff
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 403
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 500
  response-property-enum-value-added

Full history