Перейти к основному содержанию
GET
curl
Получите сведения об одном списке, включая количество его записей и время добавления самой новой записи. Список другого приложения или удалённый список возвращает 404. Чтобы прочитать значения в списке, используйте Записи списка.

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Параметры пути

list_uuid
string<uuid>
обязательно

UUID списка, возвращённый методами List lists или Create a list.

Ответ

Список.

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

uuid
string<uuid>
обязательно

Идентификатор списка. Используйте его как list_uuid в endpoint'ах списков и записей, а также как значение условия правила сценария или правила транзакции с value_type: "list".

name
string
обязательно

Название списка, уникальное среди списков приложения.

Maximum string length: 255
description
string
обязательно

Описание в виде произвольного текста. Пустая строка, если не задано.

list_type
enum<string>
обязательно

blocklist: совпадение отклоняет сессию или транзакцию (только системные списки, по одному на каждый тип записи). allowlist: совпадающие элементы считаются доверенными, например список разрешённых лиц пропускает действие при обнаружении дубликата лица; никогда не переопределяет совпадение со списком блокировки. custom: используется в условиях правил сценария и транзакций (value_type: "list").

Доступные опции:
blocklist,
allowlist,
custom
entry_type
enum<string>
обязательно

Что содержит список: face, document (номер документа), phone, email, ip_address (IP-адрес или диапазон CIDR), device_fingerprint, wallet_address, bank_account, country (ISO 3166-1 alpha-3), user или business (ваши vendor_data), либо key (любая строка). Это определяет, как проверяются и сопоставляются значения записей.

Доступные опции:
face,
document,
phone,
email,
ip_address,
device_fingerprint,
wallet_address,
bank_account,
country,
user,
business,
key
is_system
boolean
обязательно

true для списков, предоставляемых Didit: по одному списку блокировки на каждый тип записи (face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business), пользовательский список High Risk Countries и системные белые списки. Системные списки нельзя переименовывать, редактировать или удалять; вы можете добавлять и удалять их записи.

entry_count
integer
обязательно

Количество записей, находящихся в списке в данный момент.

Требуемый диапазон: x >= 0
last_entry_added_at
string<date-time> | null
обязательно

Время добавления самой новой текущей записи. null для пустого списка.

created_at
string<date-time>
обязательно

Время создания списка.

updated_at
string<date-time>
обязательно

Время последнего обновления списка.

Последнее изменение 7 ноября 2026 г.