Installation

Our engineers will help you to install Oz Web SDK using the standalone installer (requires your technical personnel to take part) or manually (everything is done by us). Once installed, the adapter part generates the plugin files: file with styles (ozliveness.css) and the primary script of the plugin (plugin_liveness.php).

Licensing

To generate the license, we need the domain name of the website where you are going to use Oz Forensics Web SDK, for instance, your-website.com. You can also define subdomains.

1. Unzip the file received:

unzip license.0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json.zip

2. Copy the JSON license file to the host where you’ve deployed the container from the ozforensics/oz-webliveness-dev:latest image.

Example

scp -i ~/ozforensics/keys/id_rsa-test-hostname-vm license.0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json user@hostname:/opt/oz/web-sdk

• -i ~/ozforensics/keys/id_rsa-test-hostname-vm is the path to the public ssh key of your host license.

• 0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json is the JSON license file.

• user is the username on host.

• hostname is the host alias.

• /opt/oz/web-sdk is the directory where you’ve deployed the Web SDK container.

3. Replace the license file.

Example

ssh user@hostname -i ~/ozforensics/keys/id_rsa-test-hostname-vm sudo cp -v /opt/oz/web-sdk/license.license.0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json /opt/oz/web-sdk/license.json

4. Restart the Web SDK container for the new license to be applied.

Example

ssh user@hostname -i ~/ozforensics/keys/id_rsa-test-hostname-vm sudo docker restart web-sdk

• web-sdk is the name of the container you’ve deployed from the ozforensics/oz-webliveness-dev:latest image.

Once the license is added, the system will check its validity on launch.

License Errors

Oz Liveness WEB Adapter is set up via changes in the configuration file stored at the Oz Liveness WEB Adapter server: /core/app_config.json

Please find a sample for Oz Liveness Web SDK here. To make it work, replace <web-adapter-url> with the Web Adapter URL you've received from us.

For Angular and React, replace https://web-sdk.sandbox.ozforensics.com in index.html.

• Angular sample

• React sample

Some configuration file parameters can be changed without direct editing of the /core/app_config.json file. You can do it using the environment variables.

• WA_ARCHITECTURE – redefines the architecture parameter

• WA_API_URL – redefines the api_url parameter

Here's an example of using environment variables for the dockered Web SDK in the Lite mode:

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

• 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

• disable_adapter_errors_on_screen (since 1.5.0) – if true, disables the display of API errors in modal windows, allowing you to view them solely using the on_error callback. The default value is False.

• WA_CORS_ORIGINS defines what sources are allowed to make requests. The's no default value. Please bear in mind that if you don't set this value, the CORS headers will be switched off and no such headers will be added within the Web SDK container.

• WA_CORS_METHODS(optional) – HTTP methods allowed to use. If the variable is not set, it gets the default value, which is 'GET, POST, OPTIONS'. If the variable is not used, any method is accepted.

• WA_CORS_HEADERS(optional) – HTTP headers allowed to use. If the variable is not set, it gets the default value which is 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type'. If the variable is not used, any header is accepted.

An example of using environment variables for server configuration: