> 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`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/address-screening/screen-a-single-address.md)                      | 筛查单个地址并获取风险结果      |
| [`POST /addresses/screen`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/address-screening/batch-screen-addresses.md)                     | 在一个请求中筛查最多 100 个地址 |
| [`GET /addresses/details/{chain_id}/{address}`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/address-screening/get-an-address-detail.md) | 获取已筛查地址的详细风险明细     |
| [`GET /addresses/screen/tasks/{task_id}`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/address-screening/get-a-task-result.md)           | 轮询异步筛查任务的结果        |
| [`PUT /addresses/{chain_id}/{address}`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/address-screening/update-an-address-info.md)        | 更新地址的自定义标签或备注      |

### 交易筛查

监控单笔或一批交易的风险敞口，包括所有相关转账。

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

### 客户管理

将已筛查的地址和交易关联到特定客户，以便有序地进行合规跟踪。

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

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

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

| 端点                                                                                                                                                               | 说明        |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| [`POST /blacklists/add`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/blacklist-whitelist-management/add-addresses-to-blacklist.md)         | 将地址添加到黑名单 |
| [`POST /blacklists/remove`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/blacklist-whitelist-management/remove-addresses-from-blacklist.md) | 从黑名单中移除地址 |
| [`POST /whitelists/add`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/blacklist-whitelist-management/add-addresses-to-whitelist.md)         | 将地址添加到白名单 |
| [`POST /whitelists/remove`](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/blacklist-whitelist-management/remove-addresses-from-whitelist.md) | 从白名单中移除地址 |

### 账户管理

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

| 端点                                                                                                                                            | 说明         |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [`GET /account/usage/screening`](https://docs.compliance.phalcon.blocksec.com/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 '{
    "chainId": 1,
    "address": "0x..."
  }'
```

**3. 检查响应** — 如果筛查在 10 秒内完成，您将直接收到结果。否则，您将收到一个 Task ID，可通过 `/addresses/screen/tasks/{task_id}` 轮询结果（交易筛查则通过 `/transactions/screen/tasks/{task_id}` 轮询）。

## 关键概念

* **风险引擎** — 每次筛查都会使用多个风险引擎。结果包括每个引擎的风险评分和风险指标。所有可能的指标请参阅[风险指标列表](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/introduction/risk-indicator-list.md)。
* **异步任务** — 批量请求和耗时较长的筛查会返回一个 Task ID。结果准备就绪后，可使用 `/addresses/screen/tasks/{task_id}` 或 `/transactions/screen/tasks/{task_id}` 获取。
* **链 ID** — 每个受支持的区块链都有一个数字链 ID（例如，Ethereum = `1`，Bitcoin = `-1`）。完整列表请参阅[支持的链](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/introduction/supported-chains.md)。

## 后续步骤

* [身份验证](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/introduction/authentication.md) — 如何对 API 请求进行身份验证
* [速率限制](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/introduction/rate-limits.md) — 各端点的默认速率限制
* [支持的链](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/introduction/supported-chains.md) — 链及其 ID
* [更新日志](https://docs.compliance.phalcon.blocksec.com/zh/api-documentation/introduction/changelog.md) — 近期 API 更新
