LogoLogo
To the Oz WebsiteOz API ReferenceContact Us
  • General
    • Oz Liveness and Biometry Key Concepts
      • Solution Architecture
      • Liveness, Face Matching, Black List Checks
      • Passive and Active Liveness
      • Hybrid Liveness
      • Oz API Key Concepts
      • Oz API vs. Oz API Lite
      • SaaS, On-premise, On-device: What to Choose
      • Oz Licensing Options
    • Integration Quick Start Guides
      • Server-Based Liveness
        • How to Integrate Server-Based Liveness into Your Web Application
        • How to Integrate Server-Based Liveness into Your Mobile Application
        • How to Check Your Media for Liveness without Oz Front End
      • On-Device Liveness
        • How to Integrate On-Device Liveness into Your Mobile Application
      • Face Matching
        • How to Add Face Matching of Liveness Video with a Reference Photo From Your Database
        • How to Add Photo ID Capture and Face Matching to Your Web or Mobile Application
  • Guides
    • Developer Guide
      • API
        • Oz API
          • Working with Oz System: Basic Scenarios
            • Authentication
            • Uploading Media
            • Liveness
            • Biometry (Face Matching)
            • Best Shot
            • Blacklist Check
              • Blacklist (Collection) Management in Oz API
            • Quantitative Results
            • Using a Webhook to Get Results
            • Single Request
            • Instant API: Non-Persistent Mode
          • System Objects
          • User Roles
          • Types of Analyses and What They Check
          • Rules of Assigning Analyses
          • Statuses in API
          • Media Tags
          • Metadata
          • API Error Codes
          • Oz API Postman Collections
          • Changelog
        • Oz API Lite
          • API Lite Methods
          • Oz API Lite Postman Collection
          • Changelog
      • SDK
        • Oz Mobile SDK (iOS, Android, Flutter)
          • On-Device Mode
          • Android
            • Getting a License for Android SDK
              • Master License for Android
            • Adding SDK to a Project
            • Connecting SDK to API
            • Capturing Videos
            • Checking Liveness and Face Biometry
            • Customizing Android SDK
              • How to Restore the Previous Design after an Update
            • Android Localization: Adding a Custom or Updating an Existing Language Pack
            • Android SDK Methods and Properties
            • Changelog
          • iOS
            • Getting a License for iOS SDK
              • Master License for iOS
            • Adding SDK to a Client’s Mobile App
            • Connecting SDK to API
            • Capturing Videos
            • Checking Liveness and Face Biometry
            • Customizing iOS SDK Interface
              • How to Restore the Previous Design after an Update
            • iOS Localization: Adding a Custom or Updating an Existing Language Pack
            • iOS SDK Methods and Properties
            • Changelog
          • Flutter
            • How to Install and Use Oz Flutter Plugin
            • Flutter SDK Methods and Properties
            • Changelog
        • Oz Liveness Web SDK
          • Web Plugin
            • Adding the Plugin to Your Web Page
            • Launching the Plugin
              • Description of the on_complete Callback
              • Description of the on_result Callback
              • Capturing Video and Description of the on_capture_complete Callback
              • Description of the on_error Callback
            • Closing or Hiding the Plugin
            • Localization: Adding a Custom Language Pack
            • Look-and-Feel Customization
              • Customization Options for Older Versions (before 1.0.1)
            • Security Recommendations
            • Browser Compatibility
            • No-Server Licensing
          • Changelog
    • Administrator Guide
      • Deployment Architecture
      • Installation in Docker
      • Installation in Kubernetes
      • Performance and Scalability Guide
      • Publishing API Methods in the Internet: Security Recommendations
      • Monitoring
      • License Server
      • Web Adapter Configuration
        • Installation and Licensing
        • Configuration File Settings
        • Configuration Using Environment Variables
        • Server Configuration via Environment Variables
      • Oz API Configuration
    • User Guide
      • Oz Web UI
        • Requesting Analyses
        • Users and Companies
        • Blacklist
        • Statistics
        • Settings
        • Changelog
  • Other
    • Media Quality Requirements
    • Oz SDK Media Quality Checks
    • Media File Size Overview
    • Compatibility
    • FAQ
    • Tips and Tricks
      • Oz Liveness Gestures: Table of Correspondence
      • Sudo without Password
      • Android: Certificate Validation Error
    • Previous Documentation
      • Mobile SDK
        • Android
          • Interactions with the Oz API Server
          • Uploading and Analyzing Media
        • iOS
          • Uploading and Analyzing Media
      • User Guides
        • Oz Demo Kit
        • Web UI
      • Oz Modules Installation
        • Standalone Installer
        • Oz System Lite
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Guides
  2. Administrator Guide
  3. Web Adapter Configuration

Configuration File Settings

PreviousInstallation and LicensingNextConfiguration Using Environment Variables

Last updated 4 months ago

Was this helpful?

This part covers the containing of the /core/app_config.json file.

  • use_for_liveness – the option is used when bank managers are taking clients' videos. If the option is set to true, mobile devices use the back camera by default, and on desktop, flip and oval circling are off.

  • preinit – this optional parameter switches on the preliminary loading of scripts and face detection initialization. This is needed to reduce the plugin loading time. The default value is off that means all the scripts are loaded after calling OzLiveness.open(). The script value means that the scripts will be loaded before the plugin launches. The full value enables preliminary loading of scripts and face detection initialization.

  • architecture – this optional parameter is used to choose the architecture for Web SDK. The default value is normal.

    • normal is used for the full Oz API version;

    • lite is used for ;

    • capture is used for the that aims to work directly with client backend. In this mode, Oz Liveness Web Plugin can be distributed via static files only (without the adapter part; implemented in 0.7.4);

  • api_url – Oz API server address, a text parameter;

  • api_token – Oz API access token, a text parameter;

  • api_use_token – a parameter to specify the source of the Oz API access token for the system. Possible values = config, client.

    • If the parameter value is client, then an Oz API access token is expected to be derived from the JS plug-in;

    • If you specify config in this parameter, a token will be retrieved from the api_token parameter of the Oz Liveness Web Adapter configuration file.

  • video_actions_list – block of video file tags used in the system, a text array. .

  • photo_actions_list – block of photo file tags used in the system, a text array. .

  • actions_default_importance – this parameter specifies whether override with an actions array from a web plug-in is allowed at launching an analysis. Possible values = true, false;

    • If true, the Adapter will use an actions array from the configuration file.

    • If false, the Adapter will use an actions array forwarded from your browser with the use of the open(options) method.

  • actions_default – the actions array. Options include:

    • video_count – the number of transmitted video files, a numeric parameter;

    • photo_front – whether there is a front-side page in the document. Possible values = true, false;

    • photo_back – whether there is a back-side page in the document. Possible values = true, false.

  • analyses – a block for configuring the launch of analyses. Options include:

    • quality – launch of Oz Liveness analysis. Possible values = true, false;

    • biometry – launch of Oz Biometry analysis. Possible values = true, false;

    • documents – launch of Oz Text analysis. Possible values = true, false;

    • collection_ids (since 1.4.0) – an array of the identifiers of collections for the Black List analysis.

  • extract_best_shot – a parameter that specifies if a direct link to the best shot (bestshot) extracted from the video should be appended to the analysis result. Possible values = true, false. If true, the response will contain a link to the extracted image inoutput_images (results_media);

  • result_mode – a parameter that specifies the contents of the server response with verification results. Possible values:

    • safe– only the state of analyses is returned (completed or not yet);

    • status– results of completed analyses are returned;

    • folder – same as status but with folder identifier added;

    • full– full Oz API response on the analyses is returned in the JSON format.

  • result_codes– a block of response codes with annotations.

  • delete_old_sessions: true, false– whether you want to delete old sessions

  • delete_old_sessions_offset_minutes: ***– old sessions deletion time offset (in minutes)

  • video_required_actions_list– the array of required actions

"video_required_actions_list":
[
  "video_selfie_smile"
],
  • save_lossless_frame: true– saving the original frame without compression

  • debug (since 1.1.0) – if true, enables access to the /debug.php page, which contains information about the current configuration and the current license.

  • load_3d_mask (since 1.2.1) – if true, loads the model to process the video taken with the 3D mask functionality. The default value is false which means that the model is not used, and the 3D mask is unavailable (the enable_3d_mask parameter is being ignored).

  • enable_3d_mask (since 1.2.1) – enables the 3D mask as the default face capture behavior. This parameter works only if load_3d_mask is set to true; the default value is false.

  • master_license_signature (since 1.3.1) – the parameter for the master license signature; the default value is null.

  • results_polling_interval (since 1.4.0) – the interval for polling for the analyses’ results in ms; the default value is 1000.

  • get_user_media_timeout (since 1.5.0) – it defines camera access timeout in sec; after this timeout it displays a hint on how to solve the problem; default_default for all browsers and android_facebook for Facebook

"get_user_media_timeout": {
        "default_default": 40,
        "android_facebook": 5
    }
  • disable_adapter_errors_on_screen (since 1.5.0) – if true, disables the display of errors in modal windows, allowing you to view them solely using the on_error callback. The default value is False.

video_file_format – optional; here you can choose the video file format. This video file is passed to the api. Possible values: zip (recommended) and mov (less secure). If you need to retrieve your captured video in the MP4 format, please find the instructions .

API Lite
mode
Current tag list
Current tag list
here