2. Deposit | Withdrawal Scenario Risk Alert API

Description

In business scenarios where the counterparty wallet address is known in advance (such as deposit or withdrawal transactions), this endpoint performs a risk screening on the wallet address before the transaction is executed. The interface applies the strategies configured in the rule engine.

1. Endpoint URL

GET /openapi/v3/risk/rule/address/screening

---

2. Request Parameters

Parameter	Type	Required	Description
apikey	string	true	API key
chain	string	true	Main chain name
address	string	true	Wallet address
address_role	string	true	Address role (from: outgoing address; to: incoming address)
coin	string	true	Token name
app_id	string	true	Application ID
value	float64	false	Token amount

---

3. Response Parameters

{
  "code": 200,
  "message": "success",
  "data": {
    "unique_id": "0140......8be5",
    "risk_level": "severe",
    "risk_types": [
      "Stolen Crypto"
    ],
    "risk_tags": [
      "Theft",
      "Stolen Crypto"
    ],
    "risk_code": 4444,
    "risk_detail": {
      "private_data": {
        "hit_private_whitelist": false,
        "hit_private_blacklist": false
      },
      "is_blacklist_address": true,
      "hit_direct_risk_review": false,
      "hit_indirect_risk_review": true,
      "hit_aml_review": true
    }
  }
}

---

Response Field Description

Field	Type	Description
code	int	Business status code. 200 indicates success; other values indicate failure (refer to actual error codes returned).
message	string	Response status message, e.g., success.
data	object	Response data object.

---

data Field Description

Field	Type	Description
unique_id	string	Unique request ID (used for tracking and troubleshooting).
risk_level	string	Risk level: severe, high, medium, low, none (no risk hit or unknown).
risk_types	string[]	Risk type array (high-level risk categories), e.g., ["Stolen Crypto"].
risk_tags	string[]	Risk tag array (more granular risk labels), e.g., ["Theft","Stolen Crypto"].
risk_code	int	Risk code: 0 (no risk detected), -1 (not found), 4444 (blacklist hit). For other codes, refer to the Risk Code Specification.
risk_detail	object	Risk detail object (strategy hits, blacklist information, etc.).

---

risk_detail Field Description

Field	Type	Description
private_data	object	Private list hit information.
is_blacklist_address	boolean	Whether the address is classified as a blacklist address (final aggregated result).
hit_direct_risk_review	boolean	Whether direct risk review rules were triggered.
hit_indirect_risk_review	boolean	Whether indirect risk review rules were triggered.
hit_aml_review	boolean	Whether AML review rules were triggered.

---

private_data Field Description

Field	Type	Description
hit_private_whitelist	boolean	Whether the address hits the private whitelist. true indicates a match.
hit_private_blacklist	boolean	Whether the address hits the private blacklist. true indicates a match.