Черный список

API сервиса

Метод	URL	Описание
GET|HEAD	auth/blacklist/template	Получить шаблон
POST	blacklist/load-template	Загрузить файл с данными для массового добавления
POST	auth/blacklist/load-template	Загрузить файл с данными для массового добавления (авторизация)
GET|HEAD|POST| PUT|PATCH| DELETE|OPTIONS	blacklist/list/limit/{limit}/page/{page}	Получить список ЧС с пагинацией
GET|HEAD|POST| PUT|PATCH| DELETE|OPTIONS	auth/blacklist/list/limit/{limit}/page/{page}	Получить список ЧС с пагинацией (авторизация)
POST	blacklist/add-entry	Добавить запись в ЧС
POST	auth/blacklist/add-entry	Добавить запись в ЧС (авторизация)
GET|HEAD	blacklist/{type}/client/{client_id}	Проверить клиента по типу
GET|HEAD	auth/blacklist/{type}/client/{client_id}	Проверить клиента по типу (авторизация)
GET|HEAD	blacklist/{type}/lead/{lead_id}	Проверить лида по типу
GET|HEAD	auth/blacklist/{type}/lead/{lead_id}	Проверить лида по типу (авторизация)
GET|HEAD	api/inside/complexblacklist/{type}/ taskId/{taskId}/leadId/{leadId}	Проверить по шагу в СПР (taskId) для лида
GET|HEAD	blacklist/list/delete/{id}	Удалить запись по ID
GET|HEAD	auth/blacklist/list/delete/{id}	Удалить запись по ID (авторизация)
GET|HEAD	blacklist/list/clear	Очистить ЧС
GET|HEAD	auth/blacklist/list/clear	Очистить ЧС (авторизация)

---

Получить шаблон ЧС

GET|HEAD /auth/blacklist/template

Описание

Метод позволяет получить актуальный шаблон для массового добавления записей в черный список (.xlsx). Используйте этот шаблон для подготовки данных перед массовой загрузкой через API.

Скачать шаблон:

blacklist_template.xlsx

Пример запроса

GET /auth/blacklist/template

Пример успешного ответа

{
    "status": "ok",                    // Статус выполнения запроса
    "timestamp": 1751000006000,         // Время ответа (UNIX timestamp, ms)
    "data": {
        "url": "https://example.com/blacklist-template.xlsx" // Ссылка на шаблон
    }
}

---

Загрузить файл с данными для массового добавления

POST /blacklist/load-template

POST /auth/blacklist/load-template

Описание

Метод позволяет загрузить файл с данными (.xlsx) для массового добавления записей в черный список. Используйте актуальный шаблон, предварительно скачанный через метод получения шаблона, заполните его своими данными и загрузите с помощью этого метода.

Скачать пример заполненного шаблона:

blacklist_template(1).xlsx

Тело запроса (multipart/form-data)

Поле	Тип	Описание
file	файл	Файл с данными для загрузки

Пример запроса

POST /blacklist/load-template

Content-Type: multipart/form-data

file: blacklist.xlsx

Пример успешного ответа

{
    "status": "ok",
    "timestamp": 1751465170000,
    "data": {
        "result": "Файл успешно загружен, поставлен в очередь на обработку"
    }
}

---

Получить список ЧС с пагинацией

GET|HEAD|POST|PUT|PATCH|DELETE|OPTIONS /blacklist/list/limit/{limit}/page/{page} GET|HEAD|POST|PUT|PATCH|DELETE|OPTIONS /auth/blacklist/list/limit/{limit}/page/ {page}

Описание

Метод позволяет получить список записей черного списка с пагинацией. В ответе возвращается массив записей (с расширенным набором полей) и информация о страницах.

Пагинация (от англ. pagination) — это механизм разбиения большого списка данных на отдельные страницы (страничный вывод). Вместо того чтобы возвращать все записи сразу, API или веб-интерфейс выдает только ограниченное количество элементов за один запрос (например, 10, 20 или 100), а остальные можно получить, переходя на следующие страницы.

Параметры запроса (path)

Параметр	Тип	Описание
limit	integer	Количество записей на страницу
page	integer	Номер страницы

Пример запроса

GET /blacklist/list/limit/10/page/1

Пример успешного ответа

{
    "status": "ok",                    // Статус выполнения запроса
    "timestamp": 1751465512000,        // Время ответа (UNIX timestamp, ms)
    "data": {
        "per_page": 10,                // Количество записей на страницу
        "total_entries": 149,          // Общее количество записей
        "page": 1,                     // Текущая страница
        "data": [
            {
                "id": 149,                         // Уникальный идентификатор записи
                "last_name": "Sato",               // Фамилия
                "first_name": "Aoi",               // Имя
                "patronymic": "Deep",              // Отчество
                "birthdate": "1994-08-10",         // Дата рождения
                "passport_seria": "1334",          // Серия паспорта
                "passport_no": "601234",           // Номер паспорта
                "inn": "809234567890",             // ИНН
                "snils": "601-234-567 28",         // СНИЛС
                "mobile_phone": "+7 (999) 123-47-15", // Мобильный телефон
                "email": "",                       // Электронная почта
                "qiwi_wallet": null,               // Qiwi-кошелек
                "ya_wallet": null,                 // Яндекс-кошелек
                "web_money": null,                 // WebMoney
                "account_no": null,                // Расчетный счет
                "bank_name": null,                 // Банк
                "card_no": null,                   // Банковская карта
                "company_name": "",                // Название компании
                "comments": null,                  // Комментарии
                "deleted_at": null,                // Дата удаления (если запись удалена)
                "ip4": "",                         // IP-адрес
                "mac": "",                         // MAC-адрес
                "fio": "Sato Aoi Deep",            // ФИО одной строкой
                "passport_number": "601234",       // Номер паспорта (дублируется)
                "mobile": "+7 (999) 123-47-15",    // Мобильный телефон (дублируется)
                "birthDate": "1994-08-10",         // Дата рождения (дублируется)
                "cardnumber": null                 // Банковская карта (дублируется)
            }
            // ... другие записи
        ]
    }
}

---

Добавить запись в ЧС через тело запроса (вариант 1: application/json)

POST /blacklist/add-entry

POST /auth/blacklist/add-entry

Описание

Первый способ добавления записи в черный список — через прямой API-запрос с телом запроса в формате JSON (application/json).

Тело запроса (application/json)

Поле	Тип	Описание
value	string	Значение (например, телефон, ИНН, email)
type	string	Тип значения (mobile_phone, inn, email и др.)

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

В поле value указывайте соответствующее значение.

Справочник допустимых значений "type" черного списка

type	Описание	Пример value
last_name	Фамилия	Sato
first_name	Имя	Aoi
patronymic	Отчество	Deep
birthdate	Дата рождения (y-m-d)	1994-08-1
passport_seria	Серия паспорта	1334
passport_no	Номер паспорта	601234
inn	ИНН	809234567890
snils	СНИЛС	601-234-567 28
mobile_phone	Мобильный телефон	79991234715
email	Электронная почта	test@example.com
qiwi_wallet	Qiwi-кошелек	QIWI123456
ya_wallet	Яндекс-кошелек	YANDEX123456
web_money	WebMoney	WMID123456
account_no	Расчетный счет	40817810099910004312
bank_name	Банк	Сбербанк
card_no	Банковская карта	4276380012345678
company_name	Название компании	ООО «Ромашка»
comments	Комментарии	Мошенничество
deleted_at	Дата удаления	2025-07-01T10:00:00+00:00
ip4	IP-адрес	192.168.1.1
mac	MAC-адрес	00:1A:2B:3C:4D:5E
fio	ФИО одной строкой	Sato Aoi Deep
passport_number	Номер паспорта (дубль)	601234
mobile	Мобильный (дубль)	79991234715
birthDate	Дата рождения (y-m-d) (дубль)	1994-08-1
cardnumber	Банковская карта (дубль)	4276380012345678

Пример запроса

{
    "last_name": "Джо",            // Фамилия
    "first_name": "Джо",            // Имя
    "patronymic": "Джо",           // Отчество
    "birthdate": "1994-08-10",      // Дата рождения (ГГГГ-ММ-ДД)
    "comment": "Мошенничество"      // Комментарий
}

Пример успешного ответа

{
    "status": "ok",                    
    "timestamp": 1751000001000,
    "data": {
        "result": "ok"
    }
}

---

Добавить запись в ЧС через файл (вариант 2: multipart/form-data)

POST /blacklist/add-entry

POST /auth/blacklist/add-entry

Описание

Второй способ добавления записи в черный спискок — загрузка файла (.xlsx), содержащего данные для добавления.

Тело запроса (multipart/form-data)

Поле	Тип	Описание
file	файл	Файл с данными для загрузки

Скачать шаблон:

blacklist_template.xlsx

Пример запроса

POST /blacklist/add-entry

Content-Type: multipart/form-data

file: single_blacklist_entry.xlsx

Пример успешного ответа

{
    "status": "ok",
    "timestamp": 1751479717000,
    "data": {
        "result": "ok"
    }
}

---

Проверить клиента по типу

GET|HEAD /blacklist/{type}/client/{client_id}

GET|HEAD /auth/blacklist/{type}/client/{client_id}

Описание

Метод позволяет проверить, есть ли у клиента записи в ЧС по определённому типу (например, phone, inn, email). В ответе возвращается рекомендация (разрешить или отказать в операции) и информация о совпадениях.

Параметры запроса

• {type} (string, обязательный) — тип значения (phone, inn, email и др.). См. выше "Справочник допустимых значений "type" черного списка".
• {client_id} (integer, обязательный) — идентификатор клиента

Пример запроса

GET /blacklist/mobile_phone/client/3173

Пример ответа: запись не найдена в черном списке

{
    "status": "ok",
    "timestamp": 1751482337000,
    "data": {
        "recommendation": "APPROVE",           // Рекомендация: разрешить (нет в blacklist)
        "options": {
            "mobile_record_id": null,           // Нет записи в blacklist
            "mobile_match": 0,                  // Совпадение не найдено
            "mobile_match_partly": 0            // Частичное совпадение не найдено
        }
    }
}

Если recommendation = "APPROVE" и mobile_match = 0 — запись не найдена в черном списке, можно разрешить операцию.

Пример запроса

GET /blacklist/mobile_phone/client/3174

Пример ответа: запись найдена в черном списке

{
    "status": "ok",
    "timestamp": 1751482391000,
    "data": {
        "recommendation": "DENY",              // Рекомендация: отказать (найдено в blacklist)
        "options": {
            "mobile_record_id": 121,            // ID найденной записи в blacklist
            "mobile_match": 1,                  // Совпадение найдено
            "mobile_match_partly": 0,           // Частичное совпадение не найдено
            "mobile_comments": null             // Комментарии
        }
    }
}

Если recommendation = "DENY" и mobile_match = 1 — запись найдена в черном списке, рекомендуется отказать в операции.

Описание полей ответа

Поле	Тип	Описание
status	string	Статус выполнения запроса
timestamp	integer	Время ответа (UNIX timestamp, ms)
data.recommendation	string	Рекомендация по результату проверки (DENY — отказать, ALLOW — разрешить)
data.options.mobile_record_id	integer	Внутренний идентификатор записи мобильного телефона
data.options.mobile_match	integer	Признак полного совпадения (1 — найдено в ЧС, 0 — нет)
data.options.mobile_match_partly	integer	Признак частичного совпадения (1 — частичное совпадение, 0 — нет)
data.options.mobile_comments	string|null	Комментарии к результату проверк

---

Проверить лида по типу

GET|HEAD /blacklist/{type}/lead/{lead_id}

GET|HEAD /auth/blacklist/{type}/lead/{lead_id}

Описание

Метод позволяет проверить, есть ли у лида записи в ЧС по определённому типу (например, phone, inn, email).

Параметры запроса

• {type} (string, обязательный) — тип значения (phone, inn, email и др.). См. выше "Справочник допустимых значений "type" черного списка".
• {lead_id} (integer, обязательный) — идентификатор лида.

Пример запроса

GET /blacklist/mobile_phone/lead/7336

Пример ответа: запись не найдена в черном списке

{
    "status": "ok",
    "timestamp": 1751481784000,
    "data": {
        "recommendation": "APPROVE",           // Рекомендация: разрешить (нет в blacklist)
        "options": {
            "mobile_record_id": null,           // Нет записи в blacklist 
            "mobile_match": 0,                  // Совпадение не найдено
            "mobile_match_partly": 0            // Частичное совпадение не найдено
        }
    }
}

Если recommendation = "APPROVE" и mobile_match = 0 — запись не найдена в черном списке, можно разрешить операцию.

Пример запроса

GET /blacklist/mobile_phone/lead/7337

Пример ответа: запись найдена в черном списке

{
    "status": "ok",
    "timestamp": 1751481902000,
    "data": {
        "recommendation": "DENY",              // Рекомендация: отказать (найдено в blacklist)
        "options": {
            "mobile_record_id": 121,            // ID найденной записи в blacklist
            "mobile_match": 1,                  // Совпадение найдено
            "mobile_match_partly": 0,           // Частичное совпадение не найдено
            "mobile_comments": null             // Комментарии
        }
    }
}

Если recommendation = "DENY" и mobile_match = 1 — запись найдена в черном списке, рекомендуется отказать в операции.

Описание полей ответа

Поле	Тип	Описание
status	string	Статус выполнения запроса
timestamp	integer	Время ответа (UNIX timestamp, ms)
data.recommendation	string	Рекомендация по результату проверки (DENY — отказать, ALLOW — разрешить)
data.options.mobile_record_id	integer	Внутренний идентификатор записи мобильного телефона
data.options.mobile_match	integer	Признак полного совпадения (1 — найдено в ЧС, 0 — нет)
data.options.mobile_match_partly	integer	Признак частичного совпадения (1 — частичное совпадение, 0 — нет)
data.options.mobile_comments	string|null	Комментарии к результату проверк

---

Проверить по шагу в СПР (taskId) для лида

GET|HEAD /blacklist/checks/{type}/taskId/{taskId}/leadId/{leadId}

!GET|HEAD /api/inside/complexblacklist/{type}/taskId/{taskId}/leadId/{leadId}

!GET|HEAD /api/inside/blacklist/{type}/taskId/{task_id}/leadId/{lead_id}

Описание

Метод позволяет проверить наличие записей в черном списке по определённому типу для лида в рамках конкретного шага в системе принятия решений (СПР), идентифицируемого по taskId.

Примечание о taskId:

taskId — это идентификатор шага в СПР (системе принятия решений). Чтобы узнать актуальный taskId для заявки, откройте на странице заявки DevTools и выполните в консоли команду:

engymod()

В результате в консоли будет выведен объект, где можно найти нужный taskId (ruleTaskId=...).

Параметры запроса

• {type} (string, обязательный) — тип значения (например, mobile_phone, inn, email и др.)
• {taskId} (integer, обязательный) — идентификатор шага в СПР (taskId)
• {leadId} (integer, обязательный) — идентификатор лида

Пример запроса

GET /api/inside/complexblacklist/mobile_phone/taskId/15531/leadId/7328

Пример ответа: запись найдена в черном списке

{
    "status": "ok",
    "timestamp": 1751481902000,
    "data": {
        "recommendation": "DENY",              // Рекомендация: отказать (найдено в blacklist)
        "options": {
            "mobile_record_id": 121,            // ID найденной записи в blacklist
            "mobile_match": 1,                  // Совпадение найдено
            "mobile_match_partly": 0,           // Частичное совпадение не найдено
            "mobile_comments": null             // Комментарии
        }
    }
}

Описание полей ответа

Поле	Тип	Описание
status	string	Статус выполнения запроса
timestamp	integer	Время ответа (UNIX timestamp, ms)
data.recommendation	string	Рекомендация по результату проверки (DENY — отказать, ALLOW — разрешить)
data.options.mobile_record_id	integer	Внутренний идентификатор записи мобильного телефона
data.options.mobile_match	integer	Признак полного совпадения (1 — найдено в ЧС, 0 — нет)
data.options.mobile_match_partly	integer	Признак частичного совпадения (1 — частичное совпадение, 0 — нет)
data.options.mobile_comments	string|null	Комментарии к результату проверки

---

Удалить запись по ID

GET|HEAD /blacklist/list/delete/{id}

GET|HEAD /auth/blacklist/list/delete/{id}

Описание

Метод позволяет удалить запись из ЧС по её уникальному идентификатору. Используйте этот метод, когда необходимо удалить одну конкретную запись из черного списка (например, по ошибке или по запросу пользователя).

Параметры запроса (path)

Параметр	Тип	Описание
id	integer	Уникальный идентификатор записи

Пример запроса

GET /blacklist/list/delete/121

Пример успешного ответа

{
    "status": "ok",
    "timestamp": 1751483864000,
    "data": null
}

---

Очистить ЧС

GET|HEAD /blacklist/list/clear

GET|HEAD /auth/blacklist/list/clear

Описание

Метод позволяет полностью очистить ЧС (удалить все записи из черного списка).

Пример запроса

GET /blacklist/list/clear

Пример успешного ответа

{
    "status": "ok",
    "timestamp": 1751483030000,
    "data": null
}

---

Описание полей

Поле	Тип	Описание
status	string	Статус выполнения запроса
timestamp	integer	Время ответа (UNIX timestamp, ms)
per_page	integer	Количество записей на страницу (при пагинации)
total_entries	integer	Общее количество записей (при пагинации)
page	integer	Текущая страница (при пагинации)
data	array/object	Массив или объект с данными (например, записи blacklist, результат загрузки и т.д.)
id	integer	Уникальный идентификатор записи
last_name	string	Фамилия
first_name	string	Имя
patronymic	string	Отчество
birthdate / birthDate	string	Дата рождения (YYYY-MM-DD). Может встречаться как birthdate или birthDate
passport_seria	string	Серия паспорта
passport_no / passport_number	string	Номер паспорта
inn	string	ИНН
snils	string	СНИЛС
mobile_phone / mobile	string	Мобильный телефон. Может встречаться как mobile_phone или mobile
email	string	Электронная почта
qiwi_wallet	string	Qiwi-кошелек
ya_wallet	string	Яндекс-кошелек
web_money	string	WebMoney
account_no	string	Расчетный счет
bank_name	string	Банк
card_no / cardnumber	string	Банковская карта. Может встречаться как card_no или cardnumber
company_name	string	Название компании
comments	string	Комментарий
deleted_at	string	Дата удаления записи
ip4	string	IPv4-адрес
mac	string	MAC-адрес
fio	string	ФИО одной строкой (полное имя)
value	string	Значение для добавления в blacklist (например, телефон, ИНН, email и др.)
type	string	Тип значения (mobile_phone, inn, email и др.; см. справочник типов)
file	файл	Файл для массовой загрузки
recommendation	string	Рекомендация по результату проверки (APPROVE — разрешить, DENY — отказать, ALLOW — разрешить)
options	object	Объект с деталями результата проверки
mobile_record_id	integer/null	Внутренний идентификатор записи мобильного телефона (или null, если не найдено)
mobile_match	integer	Признак полного совпадения (1 — найдено в ЧС, 0 — нет)
mobile_match_partly	integer	Признак частичного совпадения (1 — частичное совпадение, 0 — нет)
mobile_comments	string/null	Комментарии к результату проверки (если есть)
url	string	Ссылка на скачивание шаблона или файла
result	string	Результат выполнения операции (например, "ok" или текстовое сообщение)