Перейти к основному содержанию
POST
curl

Обзор

Удаляет одну или несколько сущностей пользователей. Записи пользователей удаляются безвозвратно. Их сессии верификации этот endpoint не затрагивает: они сохраняются, а связь с пользователем удаляется. Удалите их с помощью Delete Session или Batch Delete Sessions. Транзакции также не затрагиваются: удалите их с помощью Batch Delete Transactions.

Когда использовать

  • Запросы на реализацию права на забвение (GDPR / CCPA).
  • Удаление тестовых пользователей во время QA.
  • Деактивация пользователей, удалённых с вашей платформы.

Примечания

  • Принимает список значений vendor_data, список значений didit_internal_id или delete_all: true. Два списка можно комбинировать, и они объединяются по логике OR.
  • Этот endpoint никогда не ограничивает delete_all фильтрами. Пакетные параметры filter_* из Консоли отклоняются с кодом 400, поэтому сужение выборки не приводит к удалению всех пользователей приложения. Исключения: filter_has_approved_sessions и filter_has_declined_sessions не отклоняются и не применяются, поэтому не отправляйте их вместе с delete_all.
  • Принцип «всё или ничего»: если удаление не может быть завершено для выбранных пользователей, ни один из них не удаляется, и вы можете безопасно повторить тот же запрос.
  • Идемпотентность: повторная отправка того же списка возвращает deleted: 0 после первого выполнения.
  • Возвращает только количество удалённых записей, а не отчёт по каждому элементу. Значения, которым ничего не соответствует, пропускаются без уведомления. Если вы хотите сравнить deleted с количеством отправленных идентификаторов, отправьте список без дубликатов, поскольку повторяющийся идентификатор учитывается только один раз.
  • Для удаления webhook не отправляется. webhook-события срабатывают при изменении статуса и данных пользователя, но не при удалении, поэтому интеграция, которой нужен сигнал об удалении, должна фиксировать его на своей стороне.
  • Сессии верификации, связанные с пользователем, этим endpoint НЕ удаляются. Они сохраняются со снятой связью с пользователем, поэтому их документы, лица и медиафайлы удаляются только тогда, когда вы удалите сами сессии.
  • retain_face_embeddings (логическое значение, по умолчанию false) и face_retention_days (от 1 до 3650) — это ваш явный выбор сохранить один биометрический шаблон без изображения для каждого удалённого человека, для обнаружения дубликатов, на указанное количество дней. Больше ничего о человеке не сохраняется. Если не указывать оба параметра, шаблоны будут удалены вместе с пользователями. face_retention_days без retain_face_embeddings: true или retain_face_embeddings: true без face_retention_days возвращает 400 с ошибкой в поле face_retention_days.
  • Если вы не установите retain_face_embeddings в true, сохранённые биометрические шаблоны, привязанные к пользователю, УДАЛЯЮТСЯ до удаления самого пользователя. Если шаблон не может быть удалён из-за недоступности биометрического хранилища, вызов возвращает 503, ни один пользователь из запроса не удаляется, а повтор запроса завершает операцию.

Данные в завершённом регуляторном отчёте

Если какой-либо из выбранных людей входит в кейс с завершённым регуляторным отчётом, запрос завершается с кодом 409, и ничего не удаляется. Ответ содержит code: in_filed_report и называет каждый отчёт, чтобы его можно было открыть в Консоли:
Удалите каждый отчёт с помощью Delete Report, а затем повторите тот же запрос. Исключение одного человека из списка недостаточно, если другой выбранный человек всё ещё находится в отчёте.

Удаление, которое уже выполняется

Одновременно человека может удалять только один запрос. Если другой запрос ещё удаляет одного из выбранных людей, этот запрос ожидает не более нескольких секунд, затем возвращает 409 с code: subject_deletion_in_progress и ничего не удаляет:
Повторите тот же запрос после завершения другого удаления. Человек, которого уже удалил предыдущий запрос, больше не соответствует запросу, поэтому повтор удалит только оставшихся.

Разрешения

Вызывать этот endpoint может любой активный API-ключ приложения. API-ключи Didit привязаны к приложению, а не к роли: роли и разрешения в Консоли (delete:users и другие) определяют, что может делать человек в Консоли, и не проверяются для трафика Management API. Контролируйте, кто может вызывать этот endpoint, ограничивая доступ к чтению API-ключа приложения.

Связанные материалы

Авторизации

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.

Тело

application/json

Укажите vendor_data_list, didit_internal_id_list или delete_all: true. Эти два списка можно комбинировать, они объединяются по условию «ИЛИ». Если delete_all равен true, он имеет приоритет, и оба списка игнорируются.

vendor_data_list
string[]

Ваши собственные идентификаторы для удаления, сопоставляемые в точности с переданными.

didit_internal_id_list
string<uuid>[]

Внутренние идентификаторы пользователей Didit для удаления: didit_internal_id, возвращаемый endpoints создания и получения.

delete_all
boolean
по умолчанию:false

Если true, удаляет всех пользователей в приложении.

retain_face_embeddings
boolean
по умолчанию:false

Ваш явный выбор сохранить один биометрический шаблон без изображений для каждого удалённого человека для обнаружения дубликатов в течение face_retention_days. Все остальные данные о человеке удаляются. Опустите его или отправьте false, чтобы удалить шаблоны вместе с пользователями. Если true, параметр face_retention_days обязателен.

face_retention_days
integer

Количество дней хранения биометрического шаблона без изображения, если параметр retain_face_embeddings равен true. Обязателен при его наличии; без него запрос отклоняется с кодом 400 для face_retention_days.

Требуемый диапазон: 1 <= x <= 3650
Пример:

365

Ответ

Пользователи удалены. Возвращает количество фактически удалённых пользователей.

deleted
integer

Количество удалённых пользователей (исключает значения vendor_data, которым ничего не соответствовало).

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