> 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-hant/api-documentation/introduction.md).

# 簡介

Phalcon Compliance REST API 可讓您將地址篩查和交易監控直接整合到您的應用程式和工作流程中。無論您需要在處理提款前檢查個別錢包，還是持續監控多條鏈上的交易，API 都能以程式化方式存取 Phalcon Compliance 儀表板中提供的相同風險情報。

## 您可以使用的功能

### 地址篩查

使用風險引擎篩查區塊鏈地址，以識別受制裁實體、非法資金曝險及其他合規風險。

| Endpoint                                                                                                                                                           | Description        |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ |
| [`POST /address/screen`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/address-screening/screen-a-single-address.md)                      | 篩查單一地址並取得風險結果      |
| [`POST /addresses/screen`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/address-screening/batch-screen-addresses.md)                     | 在一次請求中篩查最多 100 個地址 |
| [`GET /addresses/details/{chain_id}/{address}`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/address-screening/get-an-address-detail.md) | 取得已篩查地址的詳細風險分析     |
| [`GET /addresses/screen/tasks/{task_id}`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/address-screening/get-a-task-result.md)           | 輪詢非同步篩查任務的結果       |
| [`PUT /addresses/{chain_id}/{address}`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/address-screening/update-an-address-info.md)        | 更新地址的自訂標籤或備註       |

### 交易篩查

監控單筆交易或一批交易的風險曝險，包括所有相關轉帳。

| Endpoint                                                                                                                                                                          | Description        |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [`POST /transaction/screen`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/transaction-screening/screen-a-single-transaction.md)                         | 篩查單筆交易             |
| [`POST /transactions/screen`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/transaction-screening/batch-screen-transactions.md)                          | 在一次請求中篩查最多 100 筆交易 |
| [`GET /transactions/screen/tasks/{task_id}`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/transaction-screening/get-a-task-result.md)                   | 輪詢非同步篩查任務的結果       |
| [`GET /transactions/details/{transfer_id}`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/transaction-screening/get-a-transfer-detail.md)                | 取得特定轉帳的詳細風險資訊      |
| [`GET /transactions/transfers/{chain_id}/{hash}`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/transaction-screening/get-transfers-of-a-transaction.md) | 列出交易中的所有轉帳         |

### 客戶管理

將已篩查的地址和交易連結至特定客戶，以便有系統地追蹤合規狀況。

| Endpoint                                                                                                                                                          | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`GET /customers/details/{customer_id}`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/customer/get-a-customer-detail.md)                | 取得特定客戶的詳細資料 |
| [`POST /customers/{customer_id}/addresses`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/customer/add-addresses-to-a-customer.md)       | 將地址新增至客戶    |
| [`POST /customers/{customer_id}/transactions`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/customer/add-transactions-to-a-customer.md) | 將交易新增至客戶    |

### 黑名單／白名單管理

管理自訂地址清單，以便在篩查期間自動標記或略過地址。

| Endpoint                                                                                                                                                              | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`POST /blacklists/add`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/blacklist-whitelist-management/add-addresses-to-blacklist.md)         | 將地址新增至黑名單   |
| [`POST /blacklists/remove`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/blacklist-whitelist-management/remove-addresses-from-blacklist.md) | 從黑名單移除地址    |
| [`POST /whitelists/add`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/blacklist-whitelist-management/add-addresses-to-whitelist.md)         | 將地址新增至白名單   |
| [`POST /whitelists/remove`](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/blacklist-whitelist-management/remove-addresses-from-whitelist.md) | 從白名單移除地址    |

### 帳戶管理

查詢您專案的 API 使用量和配額。

| Endpoint                                                                                                                                           | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`GET /account/usage/screening`](https://docs.compliance.phalcon.blocksec.com/zh-hant/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-hant/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-hant/api-documentation/introduction/supported-chains.md)以查看完整清單。

## 後續步驟

* [驗證](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/introduction/authentication.md) — 如何驗證您的 API 請求
* [速率限制](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/introduction/rate-limits.md) — 各端點的預設速率限制
* [支援的鏈](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/introduction/supported-chains.md) — 區塊鏈及其 ID
* [變更日誌](https://docs.compliance.phalcon.blocksec.com/zh-hant/api-documentation/introduction/changelog.md) — 近期 API 更新
