Скачать архив логов KYC

POST /kyc/download

Описание

Метод скачивает архив с логами KYC-сессий, подготовленный по вашему фильтру.

Порядок работы:

  1. Запросите список сессий методом kyc/sessions/filter с параметром "zip": true. В ответе в поле results придут имя архива archiveName и число сессий в нём totalSessions.
  2. Передайте archiveName в метод kyc/download и сохраните полученный файл.

Архив собирается уже после ответа метода kyc/sessions/filter. Пока сборка не закончилась, kyc/download отвечает 404 — повторите запрос через несколько секунд.

Архив можно скачать только один раз: после скачивания он удаляется. Неполученный архив хранится ограниченное время (около суток), после чего удаляется. Чтобы получить логи заново, повторите запрос kyc/sessions/filter с "zip": true.

Для доступа нужен токен с правом на выгрузку логов KYC, см. раздел «Авторизация».

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

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

Авторизация

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

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

Без токена запрос вернёт 401 access denied.

Тело запроса (JSON)

ПолеТипОбязательныйОписание
archiveNamestring✅Имя архива из поля results.archiveName ответа метода kyc/sessions/filter

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

curl -X POST "https://api.neuro-vision.ru/v1/kyc/download" -H "Content-Type: application/json" -H "token: <jwt-token>" -d '{"archiveName": "<archiveName>"}' -o kyc-logs.zip

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

Успех (200 OK)

Тело ответа — сам архив: заголовки Content-Type: application/zip и Content-Disposition: attachment. Сохраните его в файл с расширением .zip.

Ошибка (401 Unauthorized)

Токен не передан или недействителен.

{
  "message": "access denied",
  "status": "error"
}

Ошибка (404 Not Found)

Архив ещё собирается, уже был скачан или удалён по истечении срока хранения.

{
  "error": "File not found"
}