> For the complete documentation index, see [llms.txt](https://docs.compliance.phalcon.blocksec.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/introduction.md).

# 介绍

Phalcon Compliance REST API 让您能够直接将地址筛查和交易监控集成到您的应用程序和工作流中。无论您需要在处理提现前筛查单个钱包，还是持续监控多条链上的交易，该 API 都提供了对 Phalcon Compliance 仪表板中相同风险智能的程序化访问。

## 您可以做什么

### 地址筛查

针对风险引擎筛查区块链地址，以识别受制裁实体、非法资金敞口和其他合规风险。

| 端点                                                                                                                | 描述                 |
| ----------------------------------------------------------------------------------------------------------------- | ------------------ |
| [`POST /address/screen`](/zh/api-documentation/address-screening/screen-a-single-address.md)                      | 筛查单个地址并获取风险结果      |
| [`POST /addresses/screen`](/zh/api-documentation/address-screening/batch-screen-addresses.md)                     | 在一个请求中筛查多达 100 个地址 |
| [`GET /addresses/details/{chain_id}/{address}`](/zh/api-documentation/address-screening/get-an-address-detail.md) | 检索已筛查地址的详细风险分解     |
| [`GET /addresses/screen/tasks/{task_id}`](/zh/api-documentation/address-screening/get-a-task-result.md)           | 轮询异步筛查任务的结果        |
| [`PUT /addresses/{chain_id}/{address}`](/zh/api-documentation/address-screening/update-an-address-info.md)        | 更新地址的自定义标签或备注      |

### 交易筛查

监控单笔交易或批量交易，以获取所有转账的风险敞口。

| 端点                                                                                                                               | 描述                 |
| -------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [`POST /transaction/screen`](/zh/api-documentation/transaction-screening/screen-a-single-transaction.md)                         | 筛查单笔交易             |
| [`POST /transactions/screen`](/zh/api-documentation/transaction-screening/batch-screen-transactions.md)                          | 在一个请求中筛查多达 100 笔交易 |
| [`GET /transactions/screen/tasks/{task_id}`](/zh/api-documentation/transaction-screening/get-a-task-result.md)                   | 轮询异步筛查任务的结果        |
| [`GET /transactions/details/{transfer_id}`](/zh/api-documentation/transaction-screening/get-a-transfer-detail.md)                | 获取特定转账的详细风险信息      |
| [`GET /transactions/transfers/{chain_id}/{hash}`](/zh/api-documentation/transaction-screening/get-transfers-of-a-transaction.md) | 列出交易内的所有转账         |

### 客户管理

将已筛查的地址和交易链接到特定客户，以便进行有组织的合规跟踪。

| 端点                                                                                                               | 描述          |
| ---------------------------------------------------------------------------------------------------------------- | ----------- |
| [`GET /customers/details/{customer_id}`](/zh/api-documentation/customer/get-a-customer-detail.md)                | 获取特定客户的详细信息 |
| [`POST /customers/{customer_id}/addresses`](/zh/api-documentation/customer/add-addresses-to-a-customer.md)       | 向客户添加地址     |
| [`POST /customers/{customer_id}/transactions`](/zh/api-documentation/customer/add-transactions-to-a-customer.md) | 向客户添加交易     |

### 黑名单 / 白名单管理

管理自定义地址列表，以在筛查期间自动标记或跳过地址。

| 端点                                                                                                                   | 描述        |
| -------------------------------------------------------------------------------------------------------------------- | --------- |
| [`POST /blacklists/add`](/zh/api-documentation/blacklist-whitelist-management/add-addresses-to-blacklist.md)         | 将地址添加到黑名单 |
| [`POST /blacklists/remove`](/zh/api-documentation/blacklist-whitelist-management/remove-addresses-from-blacklist.md) | 从黑名单中删除地址 |
| [`POST /whitelists/add`](/zh/api-documentation/blacklist-whitelist-management/add-addresses-to-whitelist.md)         | 将地址添加到白名单 |
| [`POST /whitelists/remove`](/zh/api-documentation/blacklist-whitelist-management/remove-addresses-from-whitelist.md) | 从白名单中删除地址 |

### 账户管理

查询您项目的 API 使用情况和配额。

| 端点                                                                                                | 描述       |
| ------------------------------------------------------------------------------------------------- | -------- |
| [`GET /account/usage/screening`](/zh/api-documentation/account-management/get-screening-usage.md) | 获取筛查使用统计 |

## 快速开始

**1. 获取您的 API 密钥** — 在您的项目工作区中转到**系统 → API**，然后点击**生成密钥**。

**2. 发起您的第一个请求：**

```bash
curl -X POST {BASE_URL}/address/screen \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{
    "chain_id": 1,
    "address": "0x..."
  }'
```

**3. 检查响应** — 如果筛查在 10 秒内完成，您会直接获得结果。否则，您会收到一个 Task ID 来通过 `/task/result` 轮询。

## 关键概念

* **风险引擎** — 每次筛查都针对多个风险引擎运行。结果包括每个引擎的风险分数和风险指标。有关所有可能的指标，请参阅[风险指标列表](/zh/api-documentation/introduction/risk-indicator-list.md)。
* **异步任务** — 批量请求和缓慢筛查会返回一个 Task ID。当结果准备好时，使用 `/task/result` 端点来检索结果。
* **链 ID** — 每条支持的区块链都有一个数字链 ID（例如，以太坊 = `1`，比特币 = `-1`）。有关完整列表，请参阅[支持的链](/zh/api-documentation/introduction/supported-chains.md)。

## 后续步骤

* [身份验证](/zh/api-documentation/introduction/authentication.md) — 如何验证您的 API 请求
* [速率限制](/zh/api-documentation/introduction/rate-limits.md) — 每个端点的默认速率限制
* [支持的链](/zh/api-documentation/introduction/supported-chains.md) — 链及其 ID
* [更新日志](/zh/api-documentation/introduction/changelog.md) — 最近的 API 更新