Результаты

Сессия завершается ровно одним результатом. Любой исход — вердикт, отмена, отказ в доступе к камере, отсутствие сети — это результат, а не исключение. Плагины Flutter и React Native бросают исключение только при неправильном использовании: второй start, пока идёт сессия, или пустой запрос.

РезультатAndroidiOSFlutterReact Native
Сервер вынес вердикт по сессииKycResult.Completed(verdict).completed(verdict)KycCompleted(verdict){ kind: 'completed', verdict }
Пользователь ушёл до конца сессииKycResult.Cancelled.cancelledKycCancelled(){ kind: 'cancelled' }
Сессию не удалось продолжитьKycResult.Failed(reason, message).failed(reason, message:)KycFailed(reason, message){ kind: 'failed', reason, message }

Сессия, по которой сервер уже вынес вердикт, завершается как completed с этим вердиктом, на каком бы экране пользователь её ни закрыл.

Вердикты

ВердиктЗначение
successПроверка пройдена
failedПроверка не пройдена
suspiciousСервер подозревает мошенничество; пользователю SDK показывает это как непройденную проверку
expiredВремя сессии истекло
unknownВердикт, который эта версия SDK не знает

Вердикт в приложении нужен для следующего экрана. Важное решение (открытие счёта, лимит платежей) должно опираться на результат сессии, который ваш сервер получает от «Нейровижн» по вебхуку или запросом статуса сессии, а не на то, что сообщает приложение.

Ошибки

ПричинаКогдаЧто показать пользователю
cameraDeniedПользователь не дал доступ к камереЧто камера нужна, и переход в настройки приложения
networkНет соединения, или оно оборвалось и повторные попытки исчерпаныПроверить соединение и попробовать снова
serverСервер ответил ошибкойПопробовать позже
cameraКамеру не удалось открыть, или она перестала отдавать кадры (её заняло другое приложение)Закрыть другие приложения, использующие камеру, и попробовать снова
configЗапрос отклонён: неверный apiHost, id сценария или ключ клиента, которые сервер не принял, или уже идёт другая сессия (что именно — сказано в сообщении)Общую ошибку; запишите сообщение в лог — это проблема интеграции, а не пользователя
unsupportedDeviceAndroid: приложение работает как x86_64 (устройство или эмулятор x86_64); на iOS не возникаетЧто это устройство не поддерживается
internalНепредвиденный сбой в SDKОбщую ошибку; пришлите в поддержку сообщение и время

message — короткий технический текст для ваших логов, на английском. Не показывайте его пользователю как есть.

Совместимость с новыми версиями

Более новый SDK может добавить вердикт или причину ошибки:

  • Flutter и React Native читают неизвестный вердикт как unknown, а неизвестную причину ошибки — как internal.
  • В Swift в switch по перечислениям SDK нужен @unknown default.