Создать новую KYC-сессию

Метод создаёт новую KYC-сессию по выбранному сценарию. Дальше по sessionId из ответа загружаются изображения методом kyc/process, а результат читается методом kyc/session/status.

Метод: POST
Путь: kyc/session/create
Content-Type: application/json

Авторизация

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

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

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

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

Параметр	Тип	Обязательный	Описание
`schemaId`	string (UUID)	да	Идентификатор сценария проверки. Сценарий должен быть активным и принадлежать вашей компании
`token`	string (UUID)	—	Постоянный API-токен, если нет заголовка `token`

Ответ

Успешный ответ (200)

В ответе — сама созданная сессия. Поле status — это статус сессии: у новой сессии он idle.

{
  "sessionId": "00000000-0000-0000-0000-000000000000",
  "errors": [],
  "schemaId": "11111111-1111-1111-1111-111111111111",
  "status": "idle",
  "clientId": "",
  "spent": 0,
  "createdAt": "2026-03-19T10:00:00.000Z",
  "isClientNew": true,
  "clientKey": "",
  "secondsToLive": 3600,
  "responseTime": "2026-03-19T10:00:00.000Z",
  "results": [
    {
      "status": "idle",
      "type": "document",
      "spent": 0,
      "errors": [],
      "history": [],
      "isBackSide": false
    }
  ]
}

Поле	Тип	Описание
`sessionId`	string (UUID)	Идентификатор сессии. Сохраните его: он нужен для загрузки изображений и получения статуса
`errors`	array	Общие ошибки сессии; у новой сессии пусто
`schemaId`	string (UUID)	Сценарий, по которому создана сессия
`selectedSchemaId`	null	Есть только у сессии связанных сценариев: `null`, пока первый документ не выбрал сценарий
`status`	string	Статус сессии, у новой — `idle`
`clientId`	string	Идентификатор клиента; пустая строка, пока клиент не определён
`spent`	number	Время обработки в секундах
`createdAt`	string (ISO 8601)	Дата и время создания сессии
`isClientNew`	boolean	`true` — первый визит клиента
`clientKey`	string	Ваш идентификатор клиента. Задаётся параметром `clientKey`, когда сессию создаёт метод `kyc/process`; у сессии, созданной этим методом, — пустая строка
`secondsToLive`	number	Оставшееся время жизни сессии в секундах
`responseTime`	string (ISO 8601)	Время формирования ответа
`results`	array	Шаги сценария; у новой сессии все в статусе `idle`

Сессия связанных сценариев

Если сценарий связан с другими сценариями, сессия начинается с одного шага — первого документа. По распознанному документу система выбирает, по какому сценарию идти дальше, и добавляет его шаги. До выбора selectedSchemaId равен null, results содержит один шаг.

Ошибки

Ответ	Причина
400 `invalid schema`	Тело запроса не соответствует описанию параметров, например `schemaId` не в формате UUID
400 `bad schemaId`	`schemaId` не передан или сценарий не найден среди активных сценариев компании. Сессия не создаётся
400 `questionnaire is widget-only`	В сценарии есть шаг анкеты: такой сценарий проходится только через виджет
401 `access denied`	Нет токена или токен недействителен. JWT-токен передаётся только в заголовке `token`: в теле запроса он даст 400 `invalid schema`

Пример ответа с ошибкой:

{
  "status": "error",
  "message": "bad schemaId"
}

Пример запроса

curl -X POST https://api.neuro-vision.ru/v1/kyc/session/create -H 'Content-Type: application/json' -H 'token: <jwt-token>' -d '{"schemaId": "11111111-1111-1111-1111-111111111111"}'

С постоянным API-токеном в теле запроса:

curl -X POST https://api.neuro-vision.ru/v1/kyc/session/create -H 'Content-Type: application/json' -d '{"token": "<api-token>", "schemaId": "11111111-1111-1111-1111-111111111111"}'