We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Web3 Services
API Overview
Configurations
Developer-Controlled Wallets
Smart Contract Platform
User-Controlled Wallets
Compliance Engine
Screen a blockchain address
POSThttps://api.circle.com/v1/w3s/compliance/screening/addresses
Create a screening request for a specific blockchain address and chain.
Body parameters
chain
string
Required
Blockchain network.
address
string
Required
Blockchain address of the blockchain network.
idempotencyKey
object
Required
Response
RequestChoose a language
ResponseChoose an example
1{
2 "result": "APPROVED",
3 "decision": {
4 "ruleName": "Low Gambling Risk (Owner)",
5 "actions": [],
6 "screeningDate": "2023-01-01T12:04:05Z",
7 "reasons": [
8 {
9 "source": "ADDRESS",
10 "sourceValue": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
11 "riskScore": "LOW",
12 "riskCategories": [],
13 "type": "OWNERSHIP",
14 "signalSource": {
15 "rowId": {},
16 "pointer": "/addressRiskIndicator/0"
17 }
18 }
19 ]
20 },
21 "id": {},
22 "address": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
23 "chain": "MATIC-AMOY",
24 "details": [
25 {
26 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
27 "vendor": "VENDOR",
28 "response": {},
29 "createDate": "2023-01-01T12:04:05Z"
30 }
31 ],
32 "alertId": {}
33}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
