Настройки файла конфигурации

В этом разделе описано содержимое файла конфигурации /core/app_config.json.

• use_for_liveness — опция применяется при использовании WebSDK операторами банка для съемки клиентов. Если use_for_liveness = true, при съемке лица на мобильных устройствах выбирается тыловая камера, на десктопе отключается флип; отключается обводка овала;

• preinit — параметр включает предварительную загрузку библиотек и инициализацию, уменьшая время использования plugin. Параметр необязательный, значение по умолчанию off — загрузка скриптов и инициализация происходит после открытия plugin и вызова функции OzLiveness.open(). В таком режиме plugin не создает нагрузки на сайт (приложение), на котором он установлен, но сам plugin может открываться долго из-за описанных выше процессов. Значение script — предварительная загрузка только библиотек плагина. Значение full — предварительная загрузка библиотек и инициализация процесса определения лица.

• architecture — выбор архитектуры, в которой используется WebSDK. Параметр необязательный, значение по умолчанию normal.

  • normal для включения полной версии Oz API;

  • lite для использования Instant API;

  • capture — режим для работы с бэкэндом клиента напрямую. В этом случае возможно распространение Oz Liveness Web Plugin только через статические файлы, без адаптера (работает с версии 0.7.4);

• api_url — адрес сервера Oz API, текстовый параметр;

• api_token — токен для доступа к Oz API, текстовый параметр;

• api_use_token — параметр, определяющий источник получения системой токена для доступа к Oz API. Возможные значения = config, client.

  • Если установлено значение client, то токен для доступа к Oz API ожидается от JS-плагина;

  • Если установлено значение config, то токен берется из параметра api_token файла /core/app_config.json.

• video_actions_list — блок используемых в системе тегов файлов видео, текстовый массив. Список актуальных тегов.

• photo_actions_list — блок используемых в системе тегов файлов фотографий, текстовый массив. Список актуальных тегов.

• actions_default_importance — возможность при запуске анализа переопределить массив действий из WEB-плагина. Возможные значения = true, false;

  • Если установлено true, то адаптер будет использовать массив действий из конфигурационного файла.

  • Если установлено false, то адаптер будет использовать массив действий, переданный из браузера методом open(options).

• actions_default — массив действий. Доступные параметры:

  • video_count — количество передаваемых видеофайлов, числовой параметр;

  • photo_front — наличие фронтальной страницы документа. Возможные значения = true, false;

  • photo_back — наличие оборотной страницы документа. Возможные значения = true, false.

• analyses — блок настройки запуска анализов. Доступные параметры:

  • quality — запуск анализа Oz Liveness. Возможные значения = true, false;

  • biometry — запуск анализа Oz Biometry. Возможные значения = true, false;

  • documents — запуск анализа Oz Text. Возможные значения = true, false;

  • collection_ids (с версии 1.4.0) — массив идентификаторов коллекций для анализа по черному списку.

• extract_best_shot — параметр, определяющий необходимость добавления в результат анализа прямой ссылки на лучший кадр, извлеченный из видео. Возможные значения = true, false. Если установлено true, в ответе в output_images (results_media) будет ссылка на извлеченное изображение;

• result_mode — параметр, определяющий содержание ответа сервера с результатами проверки. Возможные значения:

  • safe — возвращается только состояние анализов (завершены или еще нет);

  • status — возвращаются результаты выполнения анализов;

  • folder — то же самое, что status, но дополнительно возвращается folder_id.

• result_codes — блок кодов ответа с комментариями.

• delete_old_sessions — если установлено true, старые сессии удаляются.

• delete_old_sessions_offset_minutes — если установлено, старые сессии удаляются с соответствующим смещением в минутах.

• video_required_actions_list — массив обязательных действий, которые снимающему нужно воспроизвести. См. Active Liveness.

"video_required_actions_list":
[
    "video_selfie_smile"
],

• debug (с версии 1.1.0) — при значении true дает возможность открыть страницу /debug.php, на которой размещена информация о текущих конфигурации и лицензии.

• tm_url (с версии 1.2.0) — адрес сервера телеметрии;

• tm_token (с версии 1.2.0) — токен для телеметрии;

• load_3d_mask (с версии 1.2.1) — если установлено true, загружает модели для обработки видео, снятого с помощью 3D-маски. Значение по умолчанию — false; в этом случае модель не подгружается, и 3D-маску использовать нельзя (параметр enable_3d_mask игнорируется). _{Внимание: с 1 января 2027 года мы отключаем возможность использования 3D-маски.}

• enable_3d_mask (с версии 1.2.1) — включает использование 3D-маски при съемке вместо овала. Параметр работает только в случае load_3d_mask= true; значение по умолчанию — false. _{Внимание: с 1 января 2027 года мы отключаем возможность использования 3D-маски.}

• master_license_signature (с версии 1.3.1) — подпись мастер-лицензии; по умолчанию null.

• results_polling_interval (с версии 1.4.0) — интервал опроса для получения результатов анализов, мс; значение по умолчанию — 1000.

• get_user_media_timeout (с версии 1.5.0) — определяет время, по истечении которого отобразится подсказка о том, как получить доступ к камере, если к тому моменту доступ не был получен; default_default для всех браузеров и android_facebook для Facebook браузеров.

"get_user_media_timeout": {
        "default_default": 40,
        "android_facebook": 5
    }

• disable_adapter_errors_on_screen (с версии 1.5.0) — выключает отображение ошибок в модальных окнах, оставляя возможность их просмотра только в коллбэке on_error. Значение по умолчанию — False.

• auth (с версии 1.7.14) — указывает, используется ли авторизация, и если да, то каким способом:

  • true (по умолчанию) — включена авторизация на базе генерируемого ключа доступа;

  • user:pass — включена авторизация на базе логина и пароля;

  • false — авторизация выключена.

• use_wasm_container (с версии 1.9.2) – при значении true включает использование контейнера данных OzCapsula. Значение по умолчанию — False.

• api_use_session_token (с версии 1.9.2) — определяет, как SDK получает и передает session token. client (по умолчанию) — вы запрашиваете токен у Oz API, как описано здесь.

• logo (с версии 1.9.7) — URL для изображения с логотипом. Работает, только если это указано в лицензии (за дополнительную плату). Форматы: SVG (рекомендуется), PNG, JPG.

• feature_stateless_adapter (с версии 2.0.0) — режим для развертываний с несколькими инстансами, при котором мы не сохраняем состояние сессии на диске, а возвращаем его в каждом ответе в виде зашифрованного blob-объекта.