> For the complete documentation index, see [llms.txt](https://www.bokk.ltd/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.bokk.ltd/readme/v3/2.-deposit-or-withdrawal-scenario-risk-alert-api.md).

# 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

```json
{
  "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

<table><thead><tr><th width="116.8828125">Field</th><th width="108.40234375">Type</th><th>Description</th></tr></thead><tbody><tr><td>code</td><td>int</td><td>Business status code. <code>200</code> indicates success; other values indicate failure (refer to actual error codes returned).</td></tr><tr><td>message</td><td>string</td><td>Response status message, e.g., <code>success</code>.</td></tr><tr><td>data</td><td>object</td><td>Response data object.</td></tr></tbody></table>

***

## `data` Field Description

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

***

## `risk_detail` Field Description

<table><thead><tr><th width="206.62109375">Field</th><th width="106.83984375">Type</th><th>Description</th></tr></thead><tbody><tr><td>private_data</td><td>object</td><td>Private list hit information.</td></tr><tr><td>is_blacklist_address</td><td>boolean</td><td>Whether the address is classified as a blacklist address (final aggregated result).</td></tr><tr><td>hit_direct_risk_review</td><td>boolean</td><td>Whether direct risk review rules were triggered.</td></tr><tr><td>hit_indirect_risk_review</td><td>boolean</td><td>Whether indirect risk review rules were triggered.</td></tr><tr><td>hit_aml_review</td><td>boolean</td><td>Whether AML review rules were triggered.</td></tr></tbody></table>

***

## `private_data` Field Description

<table><thead><tr><th width="207.4375">Field</th><th width="106.31640625">Type</th><th>Description</th></tr></thead><tbody><tr><td>hit_private_whitelist</td><td>boolean</td><td>Whether the address hits the private whitelist. <code>true</code> indicates a match.</td></tr><tr><td>hit_private_blacklist</td><td>boolean</td><td>Whether the address hits the private blacklist. <code>true</code> indicates a match.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://www.bokk.ltd/readme/v3/2.-deposit-or-withdrawal-scenario-risk-alert-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.