Удалить персональные данные сессии

POST /kyc/session/erase


Описание

Метод уничтожает персональные данные KYC-сессии: распознанные данные, изображения и видео. Можно указать одну сессию (sessionId) или все сессии пользователя (clientUser).

Сама сессия и её итоговый статус сохраняются. Каждый вызов записывается в журнал, см. kyc/session/erase/log.

Для вызова у пользователя, которому принадлежит токен, должно быть право на удаление сессий KYC.


Формат запроса

  • HTTP метод: POST
  • URL: /kyc/session/erase
  • Тип контента: application/json

Авторизация

Токен передаётся одним из способов:

  • заголовок token: <jwt-token> — временный JWT-токен, полученный методом user/login;
  • поле token в теле запроса — постоянный API-токен (UUID) из личного кабинета.

Без токена запрос вернёт 401 access denied. Подробнее — на странице Аутентификация.


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

ПараметрТипГде передаётсяОбязательныйОписание
tokenstring (UUID)body—Постоянный API-токен, если нет заголовка token
sessionIdstring (UUID)body✅ или clientUserСессия, данные которой нужно уничтожить
clientUserstringbody✅ или sessionIdИдентификатор пользователя в вашей системе, от 1 до 36 символов. Уничтожаются данные всех его сессий
reasonstringbody❌Основание: subject_request, consent_withdrawn, purpose_achieved, unlawful_processing, operator_request. По умолчанию operator_request. Записывается в журнал

Передайте ровно одно из полей sessionId и clientUser.


Пример запроса (cURL)

curl -X POST "https://api.neuro-vision.ru/v1/kyc/session/erase" -H "token: <jwt-token>" -H "Content-Type: application/json" -d '{"sessionId": "00000000-0000-0000-0000-000000000000", "reason": "subject_request"}'

Как читать ответ

Ориентируйтесь на поле result, а не на HTTP-код или status.

resultHTTPstatusЧто означает
erased200okДанные уничтожены
in_progress202okУничтожение началось и ещё не завершилось. parts показывает текущее состояние
not_found404errorСессия не найдена
no_permission403errorНет права на удаление сессий KYC. Ответ одинаков для существующей и несуществующей сессии
invalid_request400errorТело запроса не соответствует схеме, подробности в ответе

При внутренней ошибке метод отвечает 500 internal error.

Метод ждёт завершения около 20 секунд. Если за это время уничтожение не закончилось, придёт in_progress: система доведёт его сама, а повторный вызов вернёт текущее состояние. Когда уничтожение завершится, на адрес вебхука сценария придёт событие PD_ERASURE_COMPLETE (см. Вебхуки).

Части данных (parts)

ЧастьЧто входит
textДанные документов, контакты, ответы проверок по базам данных
mediaИзображения лица и документов, видео проверки живости
personЗапись о человеке, созданная сессией: фото и имя в списке лиц
questionnaireОтветы анкеты первого этапа, с которой связана сессия

Состояние части (state):

stateЧто означает
erasedУничтожено
keptСохранено, причина в поле reason
unconfirmedУничтожение ещё не подтверждено, система продолжает попытки
absentТаких данных у сессии нет

Причины сохранения (reason): linked_session — запись нужна другой сессии того же человека; manual_person — запись добавлена вручную; blacklist_person — запись в чёрном списке.


Что происходит после уничтожения

  • Если сессия была активна, она закрывается.
  • Сессия остаётся в списке со своим итоговым статусом.
  • Повторный вызов с тем же clientKey вернёт эту же завершённую сессию. Для новой проверки используйте новый clientKey.
  • Ссылки на изображения сессии отвечают 404.
  • Если по анкете с уничтоженными данными открыта сессия второго этапа, она завершится ошибкой [questionnaire] session not found.
  • Если уничтожение началось, пока сессия ждала проверок по базам данных, вебхук SESSION_COMPLETE по ней не придёт.

Запись анкеты первого этапа этим методом не удаляется. Для неё есть метод kyc/questionnaire/session/delete.

Не передавайте в clientKey и clientUser персональные данные: используйте свои внутренние идентификаторы.


Примеры ответов

Успех (200 OK)

{
  "status": "ok",
  "result": "erased",
  "sessionId": "00000000-0000-0000-0000-000000000000",
  "pdErasedAt": "2026-03-02T10:15:30Z",
  "parts": {
    "text": { "state": "erased" },
    "media": { "state": "erased" },
    "person": { "state": "kept", "reason": "linked_session" },
    "questionnaire": { "state": "absent" }
  }
}

Успех по clientUser (200 OK)

Сессии идут от новых к старым.

{
  "status": "ok",
  "result": "erased",
  "clientUser": "user-0001",
  "sessions": [
    {
      "sessionId": "00000000-0000-0000-0000-000000000000",
      "result": "erased",
      "pdErasedAt": "2026-03-02T10:15:30Z",
      "parts": {
        "text": { "state": "erased" },
        "media": { "state": "erased" },
        "person": { "state": "erased" },
        "questionnaire": { "state": "absent" }
      }
    }
  ]
}

Уничтожение идёт (202 Accepted)

{
  "status": "ok",
  "result": "in_progress",
  "sessionId": "00000000-0000-0000-0000-000000000000",
  "parts": {
    "text": { "state": "erased" },
    "media": { "state": "unconfirmed" },
    "person": { "state": "kept", "reason": "linked_session" },
    "questionnaire": { "state": "absent" }
  }
}

Ошибка (404 Not Found)

{
  "status": "error",
  "result": "not_found"
}

Ошибка (403 Forbidden)

{
  "status": "error",
  "result": "no_permission"
}