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

Обзор

Возвращает сведения о массовом удалении сессий, запущенном через Пакетное удаление сессий: его статус, количество обработанных сессий и количество сессий по каждому результату. Когда под пакетное удаление попадает более 20 сессий KYC, отобранных через session_numbers или с помощью delete_all, запрос возвращает 202 с заданием в статусе PENDING, а сессии удаляются в фоновом режиме. Опрашивайте этот endpoint каждые несколько секунд, пока status не станет COMPLETED или FAILED. Каждая сессия, которую удаляет задание, удаляется точно так же, как при Удалении сессии: удаляются сама сессия, каждая попытка верификации в ней и все её сохранённые файлы, а URL медиафайлов перестают работать. Удаление является безвозвратным и необратимым. Задание сообщает только количества. Оно никогда не перечисляет, какие сессии удалило.

Статус задания

Задание delete_all удаляет только сессии, созданные до запроса. Сессии, начатые во время его выполнения, не удаляются.

Количество результатов

Счётчик deleted_child_verifications учитывает верификации, которые были созданы удаляемыми верификациями бизнеса и удалены вместе с ними. Для задания, запущенного через Пакетное удаление сессий, он всегда равен 0, так как это удаление касается только сессий KYC.

Разрешения

Любой активный API-ключ приложения может вызвать этот endpoint. Задание видно только приложению, которое его создало; любой другой job_id возвращает 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.

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

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

Параметр job_id, возвращённый вместе со статусом 202 из POST /v3/sessions/delete/.

Ответ

Задание.

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

job_id
string<uuid>

Опрашивайте GET /v3/sessions/delete/{job_id}/ с этим id.

status
enum<string>

PENDING: принято, ещё не запущено. PROCESSING: удаление; processed и outcomes обновляются. COMPLETED: учтена каждая выбранная сессия. FAILED: задача завершилась досрочно; см. error.

Доступные опции:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

Сессии, выбранные при запросе удаления.

processed
integer

Сессии, обработку которых задание завершило к настоящему моменту.

outcomes
object

Сколько сессий завершилось с каждым из исходов. Все ключи присутствуют всегда.

deleted_child_verifications
integer

Верификации, созданные удалёнными верификациями бизнеса, удалённые вместе с ними. Всегда 0 для задачи, запущенной через POST /v3/sessions/delete/, которая удаляет только сессии KYC.

error
string | null

null, если status не равен FAILED; в противном случае указана причина остановки удаления. Сессии, до которых задание не дошло, остаются на месте: повторите запрос, чтобы удалить их.

created_at
string<date-time>

Когда было запрошено удаление.

completed_at
string<date-time> | null

Время завершения задачи; null во время выполнения.

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