API Reference

Screen a blockchain address

posthttps://api.circle.com/v1/w3s/compliance/screening/addresses

  • Reference
  • Playground

Create a screening request for a specific blockchain address and chain.

Body parameters
chain
string
Required

Blockchain network.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYALGOATOMARBARB-SEPOLIAHBARSOLSOL-DEVNETUNIUNI-SEPOLIATRXXLMBCHBTCBSVETCLTCXMRXRPZRXOPDOT
address
string
Required

Blockchain address of the blockchain network.

idempotencyKey
string
Required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "result": "APPROVED",
3  "decision": {
4    "ruleName": "Low Gambling Risk (Owner)",
5    "actions": [
6      "REVIEW"
7    ],
8    "screeningDate": "2023-01-01T12:04:05Z",
9    "reasons": [
10      {
11        "source": "ADDRESS",
12        "sourceValue": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
13        "riskScore": "LOW",
14        "riskCategories": [
15          "GAMBLING"
16        ],
17        "type": "OWNERSHIP",
18        "signalSource": {
19          "rowId": {},
20          "pointer": "/addressRiskIndicator/0"
21        }
22      }
23    ]
24  },
25  "id": {},
26  "address": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
27  "chain": "MATIC-AMOY",
28  "details": [
29    {
30      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
31      "vendor": "VENDOR",
32      "response": {},
33      "createDate": "2023-01-01T12:04:05Z"
34    }
35  ],
36  "alertId": {}
37}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.