For the complete documentation index, see llms.txt. This page is also available as Markdown.

How to Update Web SDK

This guide is for on-premise installations, where you run the Web SDK in your own infrastructure. Oz engineers can assist with the update; contact your Oz representative.

The Web SDK consists of two parts: the Web Adapter (server side) and the Web Plugin (plugin_liveness.php, the frontend part). Your web page loads the plugin from the Web Adapter URL, so the plugin version always matches the Web Adapter it is served from. To update the Web SDK, you update the Web Adapter. Your page code stays the same unless the updating instructions say otherwise.

Before you update

  1. Read the updating instructions for every version between your current one and the target one, not only the latest. They are published in the Web SDK changelog and list what you must change on your side: configuration parameters, infrastructure settings and breaking changes.

Example

For example, when updating to 2.0.0:

  • if you use the OzCapsula container (use_wasm_container: true), Oz API must be 6.6.1 or newer – update Oz API first, or keep the container disabled;

  • the Correlation-ID request header is sent by default – if the plugin is served from a different origin than the Web Adapter, your CORS policy, reverse proxy, WAF, CDN or API gateway must allow this header;

  • video_file_format: mov is no longer supported – switch to zip.

  1. Back up your Web Adapter configuration: the app_config.json file you mount into the container, and any WA_* environment variables or Helm values. Note the image tag or chart version you run now, so you can roll back.

Update

The Web SDK image is ozforensics/oz-webliveness on Docker Hub. The image tag is the Web SDK version, for example, ozforensics/oz-webliveness:2.2.0.

  • Docker / Docker Compose: set the new image tag, pull the image and recreate the container:

    docker pull ozforensics/oz-webliveness:<version>
    docker compose up -d
  • Kubernetes (Helm): run helm repo update, then upgrade the oz-k8s-sdk release to the new chart version with your existing values file.

Apply any configuration changes the updating instructions require. The Web Adapter reads its configuration only at container start, so the new configuration takes effect after a restart.

After you update

  1. Open your page and launch the plugin. The Web SDK version is shown in the bottom right corner of the plugin screen; make sure it is the new one.

  2. Run a full liveness session. Make sure the capture completes and you receive the result in your callbacks.

Rollback

If something goes wrong, redeploy the previous image tag or chart version with the configuration you backed up, and contact Oz support.

Last updated

Was this helpful?