> 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/5.-blacklist-address-detection-api.md).

# 5. Blacklist Address Detection API

#### Description

This endpoint only checks whether a wallet address is on the blacklist.

It **does not** execute rule engine–configured strategies and **does not** evaluate any private data configured by the user in the KYT system.

***

### 1. Endpoint URL

```
GET /openapi/v3/risk/address/blacklist
```

***

### 2. Request Parameters

| Parameter | Type   | Required | Description    |
| --------- | ------ | -------- | -------------- |
| apikey    | string | true     | API key        |
| address   | string | true     | Wallet address |

***

### 3. Response Parameters

```json
{
  "code": 200,
  "message": "success",
  "data": {
    "unique_id": "0140......8be5",
    "risk_level": "severe",
    "risk_types": "Sanctions",
    "risk_tags": [
      "chenzhi",
      "prince group",
      "Sanctions"
    ],
    "risk_detail": {
      "is_blacklist_address": true
    }
  }
}
```

***

## Response Field Description

<table><thead><tr><th width="123.7734375">Field</th><th width="99.05078125">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="122.66015625">Field</th><th width="101.66015625">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>. Note: After blacklist weight strategy adjustments, the level may not always be <code>severe</code>.</td></tr><tr><td>risk_types</td><td>string</td><td>Risk type (risk category associated with the blacklist), e.g., <code>Sanctions</code>.</td></tr><tr><td>risk_tags</td><td>string[]</td><td>Risk tag array (more granular labels), e.g., <code>["Sanctions","Prince Group"]</code>.</td></tr><tr><td>risk_detail</td><td>object</td><td>Risk detail object.</td></tr></tbody></table>

***

## `risk_detail` Field Description

<table><thead><tr><th width="181.5546875">Field</th><th width="102.55078125">Type</th><th>Description</th></tr></thead><tbody><tr><td>is_blacklist_address</td><td>boolean</td><td>Whether the address is on the blacklist. <code>true</code> indicates a blacklist hit; <code>false</code> indicates no 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/5.-blacklist-address-detection-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.