> 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).

# Введение

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

## Что можно делать

### Проверка адресов

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

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

### Проверка транзакций

Отслеживайте подверженность отдельной транзакции или пакета транзакций рискам, включая все связанные переводы.

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

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

Связывайте проверенные адреса и транзакции с конкретными клиентами для упорядоченного отслеживания соответствия требованиям.

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

### Управление чёрным и белым списками

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

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

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

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

| Endpoint                                                                                                                                      | Описание                                   |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| [`GET /account/usage/screening`](https://docs.compliance.phalcon.blocksec.com/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 '{
    "chainId": 1,
    "address": "0x..."
  }'
```

**3. Проверьте ответ** — Если проверка завершится в течение 10 секунд, результат будет возвращён напрямую. В противном случае вы получите Task ID, по которому можно запросить результат через `/addresses/screen/tasks/{task_id}` (или через `/transactions/screen/tasks/{task_id}` для проверки транзакций).

## Основные понятия

* **Движки оценки рисков** — Каждая проверка выполняется с помощью нескольких движков оценки рисков. Результаты включают оценку риска и индикаторы риска для каждого движка. Полный список возможных индикаторов см. в разделе [Список индикаторов риска](https://docs.compliance.phalcon.blocksec.com/ru/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/ru/api-documentation/introduction/supported-chains.md).

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

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