> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Lists API: черные и белые списки Didit

> Управляйте блокировочными и разрешающими списками Didit для KYC, антифрода и скрининга транзакций. Вся инфраструктура верификации в одном API, оплата за вызов.



Промпт для Lists API
        Скопировать промпт в буфер обмена



      
      

\<pre>

\`Manage Didit blocklists, allowlists, and custom lists through the Management API.

Base path:
https://verification.didit.me/v3/lists/

Authentication:
Use the x-api-key header with my Didit API key on every call.

Concepts:
\- Blocklist — system-created, one per entry type. Items in a blocklist cause automatic decline during verification or transaction screening. Cannot be deleted or renamed.
\- Allowlist: created by you, or by Didit as a system allowlist that cannot be renamed or deleted. Used in workflow conditions and to suppress duplicate/reuse actions for trusted matching items.
\- Custom — user-created. Flexible lists for workflow branching, monitoring rules, or manual review.

Supported entry_type values:
face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business, country, key.

Endpoints I should know:
\- GET /v3/lists/ — list all lists (filter by list_type, entry_type).
\- POST /v3/lists/ — create allowlist or custom list (cannot create blocklists).
\- GET /v3/lists/{list_uuid}/ — get one list.
\- PATCH /v3/lists/{list_uuid}/ — rename or update description (system lists immutable).
\- DELETE /v3/lists/{list_uuid}/ — delete allowlist/custom only. Returns 204.
\- GET /v3/lists/{list_uuid}/entries/ — paginated entries; supports search query.
\- POST /v3/lists/{list_uuid}/entries/ — add an entry by value, by reference_session_id, or by reference_object_uuid + metadata.reference_type ("transaction" | "vendor_user" | "vendor_business").
\- POST /v3/lists/{list_uuid}/entries/face-upload/: upload a base64 face image to a face blocklist or face allowlist; Didit extracts the biometric.
\- DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/ — remove an entry. For system blocklists this auto-unblocks the underlying entity.

Value validation (Create entry):
\- email — valid email address.
\- phone — valid international phone number (auto-normalized to E.164).
\- ip_address — IP or CIDR range (e.g. 10.0.0.0/8).
\- device_fingerprint: at least 8 characters among letters, digits, -, _, : and . (a blocklist refuses a fingerprint that several distinct devices have reported).
\- country — ISO 3166-1 alpha-3 (alpha-2 is accepted and converted).
\- Other types — any non-empty string. Values are case-insensitive and normalized on storage.

Traceability:
\- Pass reference_session_id when blocklisting from a verification session: Didit auto-extracts the right value (face/document/phone/email/IP/device), marks the underlying model as blocklisted, and links the entry back to the session. Didit reads the session's most recent record of that type; to list a value from an earlier record, add it by value without reference_session_id.
\- Pass reference_object_uuid plus metadata.reference_type ("transaction" | "vendor_user" | "vendor_business") when blocklisting from a transaction or vendor user/business so the console can link back to the source.

Common failure modes:
\- 400: value fails the entry_type validator or is already in the list, list_type is wrong for the operation (e.g. POST face-upload on a non-face list), reference_session_id has no data of the requested type, a system list is modified or deleted, or a list name is already used in this application (on create or rename).
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows access.
\- 404: list or entry not found in this application (a list of another application also returns 404).

Side effects:
\- Adding to a system blocklist immediately blocks future matches at verification/screening time.
\- Deleting an entry from a system blocklist unblocks the matching entity.
\- Lists are referenced by workflow status_rules (value_type: "list") for runtime list checks.

For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`

\</pre>



      
      

Вставьте в

Lists API позволяет управлять типизированными списками для вашего приложения. Системные списки блокировки создаются автоматически и проверяются при верификации и скрининге транзакций. Вы также можете создавать белые списки и пользовательские списки для условий сценария.## Основные понятия| Тип | Описание |
| - | - |
| **Список блокировки** | Создается системой, по одному на каждый тип записи. Элементы списка блокировки приводят к автоматическому отклонению при верификации или скрининге транзакций. |
| **Белый список** | Создается пользователем. Используется в условиях сценария и для подавления действий при дубликатах и повторном использовании для доверенных совпадающих элементов. |
| **Пользовательский список** | Создается пользователем. Гибкие списки для ветвления сценария, правил мониторинга или ручной проверки. |## Типы записей| Тип записи | Проверяется при | При совпадении |
| - | - | - |
| `face` | Проверке живости | Сессия отклонена |
| `document` | Верификации личности (OCR) | Сессия отклонена |
| `phone` | Проверке телефона | Сессия отклонена |
| `email` | Проверке электронной почты | Сессия отклонена |
| `ip_address` | Анализе устройства и IP (поддерживает диапазоны CIDR) | Сессия отклонена |
| `device_fingerprint` | Анализе устройства и IP | Сессия отклонена |
| `wallet_address` | Скрининге транзакций | Транзакция отклонена |
| `bank_account` | СкрININГе транзакций | Транзакция отклонена |
| `user` | Скрининге транзакций | Пользователь заблокирован |
| `business` | Скрининге транзакций | Компания заблокирована |
| `country` | Условиях сценария | Настраивается |
| `key` | Пользовательском использовании | Настраивается |## Белые спискиБелые списки не отменяют списки блокировки и проверки подлинности. Они только подавляют действия при дубликатах и повторном использовании для того же типа записи. Например, лицо из белого списка лиц может пропустить действие `DUPLICATED_FACE`, IP-адрес из белого списка IP может пропустить действие `DUPLICATED_IP_ADDRESS`, а отпечаток устройства из белого списка устройств может пропустить действие `DUPLICATED_DEVICE_FINGERPRINT`. Didit всё равно фиксирует информационное предупреждение о белом списке, чтобы вы могли проверить, почему действие для дубликата не выполнилось.## Системные списки блокировкиКаждое приложение автоматически получает 10 системных списков блокировки (по одному на каждый поддерживаемый тип записи) и системный список **High Risk Countries**. Их нельзя удалить или переименовать. Записи в них можно добавлять через API или из консоли.## ТрассировкаКаждую запись списка блокировки можно связать с исходным объектом, чтобы перейти от списка к исходной записи:- **Из сессии**: передайте `reference_session_id` при [создании записи](https://docs.didit.me/ru/management-api/lists/create-entry.md). Didit автоматически извлекает значение (лицо, документ, телефон, email, IP или устройство), помечает связанную модель как занесённую в список блокировки и связывает запись с сессией. Didit использует самую последнюю запись этого типа в сессии. Чтобы внести значение из более ранней записи, добавьте его по `value` без `reference_session_id`.
- **Из транзакции, пользователя или компании**: передайте `reference_object_uuid` с UUID объекта и укажите `metadata.reference_type` (`"transaction"`, `"vendor_user"` или `"vendor_business"`), чтобы консоль могла связать запись с исходной записью.## Endpoints> [card] [Получить все списки](https://docs.didit.me/ru/management-api/lists/list.md)
>
> Получение всех списков приложения.> [card] [Записи списка](https://docs.didit.me/ru/management-api/lists/list-entries.md)
>
> Получение записей списка.> [card] [Создать запись](https://docs.didit.me/ru/management-api/lists/create-entry.md)
>
> Добавление значения в список блокировки: по значению, ссылке на сессию или ссылке на транзакцию.> [card] [Удалить запись](https://docs.didit.me/ru/management-api/lists/delete-entry.md)
>
> Удаление записи и разблокировка связанной сущности.> [card] [Загрузить лицо](https://docs.didit.me/ru/management-api/lists/upload-face.md)
>
> Загрузка изображения лица напрямую в список блокировки лиц.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.