> For the complete documentation index, see [llms.txt](https://docs.vida.id/identity-stack/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vida.id/identity-stack/verify/liveness/integration/liveness-web-sdk/change-logs.md).

# Change Logs

This document outlines the updates of the VIDA Web SDK across key versions. Each release includes categorized details covering new capabilities, security enhancements, and critical backend improvements to ensure a secure, performant, and user-friendly experience.

<mark style="color:green;background-color:green;">**Feature**</mark>: New functionalities and enhancements in this release.

<mark style="color:orange;background-color:orange;">**Bug Fixes**</mark>: Resolving issues and glitches for a smoother experience.

<mark style="color:blue;background-color:blue;">**Security Update**</mark>: Updates addressing potential vulnerabilities for improved security.

<mark style="color:purple;background-color:purple;">**Performance Improvement**</mark>: Optimisations for faster and more efficient usage.

### Releases

<details>

<summary>1.2.0</summary>

<mark style="color:$success;background-color:green;">**Feature**</mark>

Date: Aug 18th, 2026

**Liveness SDK: Tutorial screen changes**

* Updated the tutorial images and text contents
* New fields for locale customization

</details>

<details>

<summary>1.1.3</summary>

**CDN:**

{% hint style="info" %}
Sandbox : <https://web-sdk.vida.id/1.1.3/sandbox/vida-web-sdk.js> \
Prod : <https://web-sdk.vida.id/1.1.3/vida-web-sdk.js>&#x20;
{% endhint %}

**NPM:**

{% hint style="info" %}
Sandbox : yarn add <vida-web-sdk@1.1.3-sandbox> / npm install <vida-web-sdk@1.1.3-sandbox>\
Prod : yarn add vida-web-sdk / npm install vida-web-sdk
{% endhint %}

<mark style="color:$success;background-color:green;">**Feature**</mark>

Date: Jul 21th, 2026

* **VidaSDK.preload()** - Introduced a new method which preload() prefetches SDK assets in the background so they are already cached when the SDK starts the flow. This reduces perceived load time for the end user.
* `userInfo.Id` is made an optional parameter for init() method now for Liveness+Id Fraud shield combined offering.
* Added an exit confirmation pop-up if user tries to manually close the modal during the process, if there is a retry or flow completion possibility.

</details>

<details>

<summary>1.1.1</summary>

<mark style="color:green;background-color:green;">**Feature**</mark>

Date: Apr 28th, 2026

* **Integration with the ID Fraud Shield SDK**, enabling risk-based actions across both Liveness and KYC flows.
* Enhanced callback responses with more details to improve visibility during the liveness process.
* `onComplete(data)` - this callback fires once when liveness passes; returns the successful liveness result. Treat as the success signal.\
  `onError(data)` - this callback fires only at terminal, flow-ending states (max-retry exhausted, session expired, detection timeout, camera/startup errors, manual close). Retry-able liveness failures do not trigger it — except with skipSelfieReviewScreen, where each failure is terminal.\
  `onLivenessApiResponse(data)` — this callback fires on every liveness API response whether the attempt passed or failed on threshold/image quality. Can be used for per-attempt observability, not a terminal signal.

<mark style="color:purple;background-color:purple;">**Performance Improvement**</mark>

Enhanced fraud detection through combined KYC and risk-based validation.

</details>

<details>

<summary>1.1.0</summary>

<mark style="color:green;background-color:green;">**Feature**</mark>\
Date: Jan 12th, 2026

**Color Flash:** New passive liveness detection using color flashes to improve spoof detection while keeping the user experience seamless.

**Geo-X Identity Verification :** New Geo-X KYC support with flexible verification flows:

* **Full KYC:** OCR + Document Verification + Liveness + Face Match
* **Document Verification Only:** OCR + Document Verification

**Screen Flash Feature for Liveness** : The Web SDK automatically triggers a screen flash when lighting is too dark, helping users capture clearer selfie images and improving verification success.

* **Enhanced UI** **for Liveness** :
  * Larger Web SDK modal for better visibility
  * Redesigned liveness tutorial screen
  * Camera help moved to bottom sheet for easier access
  * Configurable head guide icon to help users position their face correctly

**Liveness Tutorial Screen**

**Earlier versions**

<figure><img src="/files/199gckMU6xEIAcGGfJoI" alt="" width="259"><figcaption></figcaption></figure>

**New Version**

<figure><img src="/files/yWY7xng3Z7riYB5Yq68H" alt="" width="304"><figcaption></figcaption></figure>

Tutorial now has 2 instructions (4 earlier). The earlier text content customization keys for tutorial screen have been deprecated and new ones introduced.

**Deprecated Keys**

```json
tutorial: {
  faceCamera: string;
  faceClear: string;
  singleFace: string;
  avoidDark: string;
}
```

**New Keys**

```
livenessTutorial: {
  holdPhoneSteady: string;
  avoidBrightPlace: string; /* For color flash liveness */
  avoidGlasses: string; /* For passive liveness */
}
```

**Selfie capture camera screen**

**Earlier Versions**

<figure><img src="/files/nYYTmiMuIO2xzbLKJ9xr" alt="" width="258"><figcaption></figcaption></figure>

**New Versions**

<figure><img src="/files/KDkBPu7ldS9GECmYXSu9" alt="" width="303"><figcaption></figcaption></figure>

<figure><img src="/files/aSA0kFPl9FtXcTTjNbNJ" alt="" width="304"><figcaption></figcaption></figure>

**Default instructions changed on selfie capture feedback section**

<table><thead><tr><th width="349.19140625">Old Version</th><th>New Version</th></tr></thead><tbody><tr><td>Place your face within the frame</td><td>Put your face in the frame</td></tr><tr><td>Bring your face closer</td><td>Move closer</td></tr><tr><td>Stay still to capture clear photo</td><td>Stay still</td></tr><tr><td>Unable to detect the face</td><td>Put your face in the frame</td></tr><tr><td>Face too dark</td><td>Move to well-lit area</td></tr><tr><td>Face area too bright </td><td>Too bright</td></tr><tr><td>Make sure your eyes are open and visible</td><td>Open your eyes</td></tr></tbody></table>

</details>

<details>

<summary>1.0.6</summary>

<mark style="color:orange;background-color:orange;">**Bug Fixes**</mark>\
Date: Nov 25th, 2025

* **Modal size issue :** Resolved an issue where the web SDK modal size was being rendered in small size in some tablet devices.
* **Darkness check enhancement :** Slightly tightened the threshold for dark area check.
* **Camera - Feedback text size customization** **:** Fixed an issue where the custom font size for camera real time feedback text was not getting applied.

</details>

<details>

<summary>1.0.5</summary>

<mark style="color:$success;background-color:$success;">**Feature**</mark>\
Date: Sept 24th, 2025

* <mark style="color:red;">`detectionTimeOutCountdownDuration`</mark>
  * Added support to configure timeout in milliseconds for face detection countdown.
  * Default: 20,000 ms (20 seconds).
  * Example: Passing 30,000 will show countdown for the last 30 seconds.
* <mark style="color:red;">`hideDetectionTimeOutCountdownAlert`</mark> *(boolean)*
  * New option to hide the countdown alert.
  * Default: `false`.
* <mark style="color:$danger;">`hideMaxRetryError`</mark> *(boolean)*
  * New option to hide the "Maximum retry exhausted" error alert on the selfie review screen.
* <mark style="color:$danger;">`hideDescriptions`</mark> *(object)*
  * New configurable object to hide page descriptions across different screens.
  * Defaults: all descriptions shown.
* Available options:
  * <mark style="color:blue;">`tutorial`</mark> – Tutorial screen
  * <mark style="color:blue;">`cameraAccess`</mark> – Camera access screen
  * <mark style="color:blue;">`camera`</mark> – Selfie capture screen
  * <mark style="color:blue;">`selfieReview`</mark> – Selfie review screen
* <mark style="color:$danger;">`hideErrorCodeOnSelfieReview`</mark> *(boolean)*
  * New option to hide error codes on the selfie review screen.
  * Default: `false`.

<mark style="color:red;">`networkStatus`</mark> *(string)*

* Custom label for network status alert (shown when there is no internet connection).

<mark style="color:red;">`error.moduleDownloadErrorTitle`</mark> *(string)*

* Error title text for camera error when model download fails.

<mark style="color:red;">`error.moduleDownloadErrorDescription`</mark> *(string)*

* Error description text for camera error when model download fails.

<mark style="color:red;">`error.unsupportedDeviceTitle`</mark> *(string)*

* Error title text for camera error due to unsupported device.

<mark style="color:red;">`error.unsupportedDeviceDescription`</mark> *(string)*

* Error description text for camera error due to unsupported device.

<mark style="color:red;">`detectionTimeOut`</mark> *(string)*

* Custom label for detection timeout alert.
* Supports template `\${time}` which will be replaced with actual timeout value.

<mark style="color:red;">`sessionExpired`</mark> *(string)*

* Message when session gets expired.

<mark style="color:red;">`unknownError`</mark> *(string)*

* Message when an unknown error occurs.

<mark style="color:red;">`maxRetryExhausted`</mark> *(string)*

* Message when maximum retries are exhausted.

</details>

<details>

<summary>1.0.4</summary>

<mark style="color:$info;background-color:$info;">**Performance Improvement**</mark>\
Date: Aug 06th, 2025\
**Self hosted face detection models and assets:** Removed dependency of external CDN for models and assets.

</details>

<details>

<summary>1.0.3</summary>

<mark style="color:blue;background-color:blue;">**Security Update**</mark>\
Date: Jun 30th, 2025\
**Enhanced Signing Key Protection**: Implemented stronger encryption algorithms mechanisms for SDK signing keys.

</details>

<details>

<summary>1.0.2</summary>

<mark style="color:blue;background-color:blue;">**Security Update**</mark>\
Date: Mar 25th, 2025\
Generic camera security updates to strengthen security checks in the camera module.

</details>

<details>

<summary>1.0.1</summary>

<mark style="color:blue;background-color:blue;">**Security Update**</mark>\
Date: Jan 18th, 2025\
**Anti-Debugging Measures Introduced**: Strengthened SDK resilience against tampering by detecting and blocking debugging attempts in the browser environment.

</details>

<details>

<summary>1.0.0</summary>

<mark style="color:green;background-color:green;">**Feature**</mark>\
Date: Jan 17th, 2025

* **Initial Launch of the Web SDK**: Introduce web SDK for Passive Liveness check&#x20;
* **Passive Liveness Detection**: The SDK integrates liveness analysis to verify if a real person is present, without requiring user action like blinking or head movement.
* **Real-time Selfie Quality Feedback**: The SDK provides instant user guidance to optimize image quality (e.g., lighting, framing, focus), improving the success rate of facial verification on the first attempt.

</details>