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

# Введение

Phalcon Compliance REST API позволяет интегрировать скрининг адресов и мониторинг транзакций непосредственно в ваши приложения и рабочие процессы. Независимо от того, нужно ли вам проверить отдельный кошелек перед обработкой вывода средств или постоянно контролировать транзакции в нескольких блокчейнах, API предоставляет программный доступ к той же аналитике рисков, которая доступна в панели управления Phalcon Compliance.

## Что вы можете делать

### Скрининг адресов

Проверяйте адреса блокчейна с использованием механизмов оценки рисков, чтобы выявить санкционированные объекты, воздействие нелегальных средств и другие риски соответствия.

| Endpoint                                                                                                          | Описание                                                      |
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| [`POST /address/screen`](/ru/api-documentation/address-screening/screen-a-single-address.md)                      | Проверить один адрес и получить результаты риска              |
| [`POST /addresses/screen`](/ru/api-documentation/address-screening/batch-screen-addresses.md)                     | Проверить до 100 адресов в одном запросе                      |
| [`GET /addresses/details/{chain_id}/{address}`](/ru/api-documentation/address-screening/get-an-address-detail.md) | Получить подробную информацию о риске для проверенного адреса |
| [`GET /addresses/screen/tasks/{task_id}`](/ru/api-documentation/address-screening/get-a-task-result.md)           | Получить результаты асинхронных задач скрининга               |
| [`PUT /addresses/{chain_id}/{address}`](/ru/api-documentation/address-screening/update-an-address-info.md)        | Обновить пользовательские метки или примечания адреса         |

### Скрининг транзакций

Контролируйте отдельные транзакции или пакеты на предмет воздействия рисков по всем связанным переводам.

| Endpoint                                                                                                                         | Описание                                                       |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| [`POST /transaction/screen`](/ru/api-documentation/transaction-screening/screen-a-single-transaction.md)                         | Проверить одну транзакцию                                      |
| [`POST /transactions/screen`](/ru/api-documentation/transaction-screening/batch-screen-transactions.md)                          | Проверить до 100 транзакций в одном запросе                    |
| [`GET /transactions/screen/tasks/{task_id}`](/ru/api-documentation/transaction-screening/get-a-task-result.md)                   | Получить результаты асинхронных задач скрининга                |
| [`GET /transactions/details/{transfer_id}`](/ru/api-documentation/transaction-screening/get-a-transfer-detail.md)                | Получить подробную информацию о риске для конкретного перевода |
| [`GET /transactions/transfers/{chain_id}/{hash}`](/ru/api-documentation/transaction-screening/get-transfers-of-a-transaction.md) | Список всех переводов в рамках транзакции                      |

### Управление клиентами

Привяжите проверенные адреса и транзакции к конкретным клиентам для организованного отслеживания соответствия.

| Endpoint                                                                                                         | Описание                                 |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| [`GET /customers/details/{customer_id}`](/ru/api-documentation/customer/get-a-customer-detail.md)                | Получить информацию о конкретном клиенте |
| [`POST /customers/{customer_id}/addresses`](/ru/api-documentation/customer/add-addresses-to-a-customer.md)       | Добавить адреса клиенту                  |
| [`POST /customers/{customer_id}/transactions`](/ru/api-documentation/customer/add-transactions-to-a-customer.md) | Добавить транзакции клиенту              |

### Управление списками блокировки и разрешения

Управляйте пользовательскими списками адресов для автоматической отметки или пропуска адресов во время скрининга.

| Endpoint                                                                                                             | Описание                         |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| [`POST /blacklists/add`](/ru/api-documentation/blacklist-whitelist-management/add-addresses-to-blacklist.md)         | Добавить адреса в черный список  |
| [`POST /blacklists/remove`](/ru/api-documentation/blacklist-whitelist-management/remove-addresses-from-blacklist.md) | Удалить адреса из черного списка |
| [`POST /whitelists/add`](/ru/api-documentation/blacklist-whitelist-management/add-addresses-to-whitelist.md)         | Добавить адреса в белый список   |
| [`POST /whitelists/remove`](/ru/api-documentation/blacklist-whitelist-management/remove-addresses-from-whitelist.md) | Удалить адреса из белого списка  |

### Управление аккаунтом

Запрашивайте использование API и квоту вашего проекта.

| Endpoint                                                                                          | Описание                                    |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [`GET /account/usage/screening`](/ru/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`.

## Ключевые концепции

* **Risk Engines** — каждый скрининг запускается на нескольких механизмах оценки рисков. Результаты включают оценки рисков и индикаторы рисков для каждого механизма. Смотрите [Список индикаторов рисков](/ru/api-documentation/introduction/risk-indicator-list.md) для получения полного списка всех возможных индикаторов.
* **Async Tasks** — пакетные запросы и медленные скрининги возвращают Task ID. Используйте endpoint `/task/result` для получения результатов когда они будут готовы.
* **Chain IDs** — каждый поддерживаемый блокчейн имеет числовой идентификатор цепи (например, Ethereum = `1`, Bitcoin = `-1`). Смотрите [Поддерживаемые цепи](/ru/api-documentation/introduction/supported-chains.md) для получения полного списка.

## Следующие шаги

* [Аутентификация](/ru/api-documentation/introduction/authentication.md) — как аутентифицировать ваши API запросы
* [Ограничения скорости](/ru/api-documentation/introduction/rate-limits.md) — ограничения скорости по умолчанию для каждого endpoint
* [Поддерживаемые цепи](/ru/api-documentation/introduction/supported-chains.md) — цепи и их идентификаторы
* [Журнал изменений](/ru/api-documentation/introduction/changelog.md) — недавние обновления API