> 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 儀表板中提供的相同風險情報。

## 您可以做什麼

### 地址筛查

針對風險引擎筛查區塊鏈地址，以識別受制裁實體、非法資金敞口和其他合規風險。

| 端點                                                                                                                     | 說明                 |
| ---------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [`POST /address/screen`](/zh-hant/api-documentation/address-screening/screen-a-single-address.md)                      | 筛查單一地址並取得風險結果      |
| [`POST /addresses/screen`](/zh-hant/api-documentation/address-screening/batch-screen-addresses.md)                     | 在一個請求中筛查最多 100 個地址 |
| [`GET /addresses/details/{chain_id}/{address}`](/zh-hant/api-documentation/address-screening/get-an-address-detail.md) | 檢索已筛查地址的詳細風險明細     |
| [`GET /addresses/screen/tasks/{task_id}`](/zh-hant/api-documentation/address-screening/get-a-task-result.md)           | 輪詢非同步筛查任務的結果       |
| [`PUT /addresses/{chain_id}/{address}`](/zh-hant/api-documentation/address-screening/update-an-address-info.md)        | 更新地址上的自訂標籤或備註      |

### 交易筛查

監控個別交易或批次，以識別所有涉及轉移的風險敞口。

| 端點                                                                                                                                    | 說明                 |
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| [`POST /transaction/screen`](/zh-hant/api-documentation/transaction-screening/screen-a-single-transaction.md)                         | 筛查單一交易             |
| [`POST /transactions/screen`](/zh-hant/api-documentation/transaction-screening/batch-screen-transactions.md)                          | 在一個請求中筛查最多 100 個交易 |
| [`GET /transactions/screen/tasks/{task_id}`](/zh-hant/api-documentation/transaction-screening/get-a-task-result.md)                   | 輪詢非同步筛查任務的結果       |
| [`GET /transactions/details/{transfer_id}`](/zh-hant/api-documentation/transaction-screening/get-a-transfer-detail.md)                | 取得特定轉移的詳細風險資訊      |
| [`GET /transactions/transfers/{chain_id}/{hash}`](/zh-hant/api-documentation/transaction-screening/get-transfers-of-a-transaction.md) | 列出交易內的所有轉移         |

### 客戶管理

將已筛查的地址和交易連結到特定客戶，以進行有組織的合規追蹤。

| 端點                                                                                                                    | 說明          |
| --------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`GET /customers/details/{customer_id}`](/zh-hant/api-documentation/customer/get-a-customer-detail.md)                | 取得特定客戶的詳細資訊 |
| [`POST /customers/{customer_id}/addresses`](/zh-hant/api-documentation/customer/add-addresses-to-a-customer.md)       | 新增地址到客戶     |
| [`POST /customers/{customer_id}/transactions`](/zh-hant/api-documentation/customer/add-transactions-to-a-customer.md) | 新增交易到客戶     |

### 黑名單/白名單管理

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

| 端點                                                                                                                        | 說明       |
| ------------------------------------------------------------------------------------------------------------------------- | -------- |
| [`POST /blacklists/add`](/zh-hant/api-documentation/blacklist-whitelist-management/add-addresses-to-blacklist.md)         | 新增地址到黑名單 |
| [`POST /blacklists/remove`](/zh-hant/api-documentation/blacklist-whitelist-management/remove-addresses-from-blacklist.md) | 從黑名單移除地址 |
| [`POST /whitelists/add`](/zh-hant/api-documentation/blacklist-whitelist-management/add-addresses-to-whitelist.md)         | 新增地址到白名單 |
| [`POST /whitelists/remove`](/zh-hant/api-documentation/blacklist-whitelist-management/remove-addresses-from-whitelist.md) | 從白名單移除地址 |

### 帳戶管理

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

| 端點                                                                                                     | 說明       |
| ------------------------------------------------------------------------------------------------------ | -------- |
| [`GET /account/usage/screening`](/zh-hant/api-documentation/account-management/get-screening-usage.md) | 取得筛查使用統計 |

## 快速開始

**1. 取得您的 API 金鑰** — 在您的專案工作區中轉到 **System → API**，然後點擊 **Generate Key**。

**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-hant/api-documentation/introduction/risk-indicator-list.md)。
* **非同步任務** — 批次請求和緩慢筛查會傳回 Task ID。當結果準備就緒時，使用 `/task/result` 端點檢索結果。
* **鏈 ID** — 每條受支援的區塊鏈都有一個數字鏈 ID（例如，Ethereum = `1`、Bitcoin = `-1`）。請參閱 [支援的鏈](/zh-hant/api-documentation/introduction/supported-chains.md) 以取得完整清單。

## 後續步驟

* [驗證](/zh-hant/api-documentation/introduction/authentication.md) — 如何驗證您的 API 請求
* [速率限制](/zh-hant/api-documentation/introduction/rate-limits.md) — 每個端點的預設速率限制
* [支援的鏈](/zh-hant/api-documentation/introduction/supported-chains.md) — 鏈及其 ID
* [變更日誌](/zh-hant/api-documentation/introduction/changelog.md) — 最近的 API 更新