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

200

Response Body

object

result

string

Required

Summary result of the screening evaluation.

Allowed valuesAPPROVEDDENIED

decision

object

Required

Show 4 properties

ruleName

string

Name of the matched rule found in screening.

actions

array of strings

Actions to take for the decision.

Allowed valuesAPPROVEREVIEWFREEZE_WALLETDENY

screeningDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

reasons

array of objects

List of risk signals that are associated with the blockchain address.

Show 6 properties

source

string

Required

Source of the risk signal.

Allowed valuesADDRESSBLOCKCHAINASSET

sourceValue

string

Required

Value of the source. For example, if source is “ADDRESS”. The source value would be an blockchain address.

riskScore

string

Required

Risk score of the signal.

Allowed valuesUNKNOWNLOWMEDIUMHIGHSEVEREBLOCKLIST

riskCategories

array of strings

Required

List of risk categories for the signal.

Allowed valuesSANCTIONSCSAMILLICIT_BEHAVIORGAMBLINGTERRORIST_FINANCINGUNSUPPORTEDFROZENOTHERHIGH_RISK_INDUSTRYPEPTRUSTEDHACKINGHUMAN_TRAFFICKINGSPECIAL_MEASURES

type

string

Required

Type of the signal.

Allowed valuesOWNERSHIPCOUNTERPARTYINDIRECT

signalSource

object

Required

Source info that is used to look up more information of the signal.

Show 2 properties

rowId

object

Required

pointer

string

Required

Json path of the risk signal in the vendor response.

object

Required

address

string

Required

Blockchain address which is screened.

chain

string

Required

Blockchain network.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYALGOATOMARBARB-SEPOLIAHBARSOLSOL-DEVNETUNIUNI-SEPOLIATRXXLMBCHBTCBSVETCLTCXMRXRPZRXOPDOT

details

array of objects

Required

List of more details of the screening from vendor response.

Show 4 properties

string

Required

System-generated unique identifier of the resource.

vendor

string

Required

Vendor name.

response

object

Required

Free form vendor response base on the selected vendor, this field is opaque.

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

alertId

object

400BadRequestResponse

401NotAuthorizedResponse

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?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy