> 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-sdk/android-sdk/change-logs.md).

# Change Logs

This document logs all modifications made to the **Liveness Android SDK**, keeping our partners informed of the most recent version. 

Each release is organized by tags. These tags give you a quick idea of the changes—whether they include new features, bug fixes, or important security updates.

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

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

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

<mark style="background-color:purple;">**Device Support**</mark>: Added support to device versions.

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

## Releases

<details>

<summary><strong>id.vida:liveness-sandbox: 1.9.8</strong>             </summary>

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

* Added configuration support for **Behavioral Biometrics**.
* Behavioral Biometrics is **disabled by default**.
* The following configurations can now be controlled via OSS:
  * `behavior_biometrics_enabled`
  * `clipboard_tracking`
  * `field_tracking`
* Based on the OSS configuration, the SDK will consume the settings and act accordingly.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.9.7</strong>             </summary>

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

* Introduced **Video Liveness**, which captures a 1-second video for liveness verification.
* The SDK returns the image selected by the liveness model through the SDK callback.

***Note:***&#x20;

* **Review Screen** is not supported for Video Liveness.
* **Video Liveness** and **Color Flash Liveness** cannot be enabled simultaneously. If both are enabled, **Color Flash Liveness** takes precedence.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.9.6</strong>             </summary>

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

* User ID ***optional*** when Fraud Shield is enabled. A default User ID will be used if one is not provided.
* Enhanced multi-face detection by triggering detection only when a secondary face is at least 60% of the primary face size.
* Added device signal support.

<mark style="background-color:orange;">**Bug fixes**</mark>

* Improved handling of null error messages.
* Fixed SDK stability issues.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.9.5</strong>             </summary>

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

* Added support for custom camera orientation on kiosk devices (0°, 90°, 180°, and 270°)

<mark style="background-color:orange;">**Bug fixes**</mark>

* Improved head shape detection for both Passive Liveness and Active Liveness (Gesture-Based)

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.9.4</strong>             </summary>

<mark style="background-color:purple;">**Device Support**</mark>

* Added support for kiosk devices

<mark style="background-color:orange;">**Bug fixes**</mark>

* Minor bug fixes

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.9.3</strong>             </summary>

<mark style="background-color:orange;">**Bug fixes**</mark>

* Fixed crashes and improved app stability.
* Improved error handling and image processing.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.9.2</strong>             </summary>

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

Integration with the **ID Fraud Shield SDK**, including configuration to define actions based on detected risk levels.

<mark style="background-color:orange;">**Bug fixes**</mark>

Fixed crashes and improved app stability.

<mark style="background-color:red;">**Security Update**</mark>

Improved risk-based decisioning to strengthen fraud prevention.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.9.1</strong>             </summary>

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

Introduced the Color Flash feature to enhance verification reliability and improve fraud detection.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.12</strong>             </summary>

<mark style="background-color:red;">**Security Update**</mark>

1. Improved system stability by removing a check that could mistakenly detect normal application behavior as a debugging activity.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.11</strong>             </summary>

<mark style="background-color:$danger;">**Security Update**</mark>

1. Protection Update with support for 16KB memory pages

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.10</strong>           </summary>

<mark style="background-color:$warning;">**Bug Fixes**</mark>

1. This release includes fixes for cases 70012 and 50012, bringing smoother and more reliable performance in the Liveness SDK.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.9</strong>               </summary>

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

1. **Watermark on Selfies:** All selfie captures now include a watermark to give extra security and authenticity.
2. **Better Android 15+ Support:** The interface has been improved to work more smoothly on the latest Android versions, ensuring a consistent user experience.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.7</strong>              </summary>

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

1. **Eye-Closure Check:** The system is now better at recognizing when users blink or close their eyes, making liveness checks more accurate.
2. Fixed minor bugs.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.6</strong>                </summary>

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

1. **Auto Flash Feature:** The SDK now automatically enables flash in low-light conditions across all liveness types, making it easier for users to complete verification successfully.
2. **Flickering Message Fix:** We resolved the flickering message issue in Active Liveness during dark conditions, ensuring a smoother experience for users.
3. **Face Size Validation:** New face size validation logic in Active Liveness helps users position themselves correctly, reducing errors and failed attempts.
4. **Stability Improvements:** Various minor fixes and optimizations deliver a more stable and reliable liveness verification process.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.5</strong>              </summary>

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

1. Fixed an issue that caused crashes on slow network connections.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.4</strong>             </summary>

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

1. Removed 3rd party library to streamline the system.
2. Added support for Android 15+ with improved compatibility for better performance.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.3</strong>              </summary>

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

1. Enabled support for 16 KB memory pages for better performance.
2. Combined all liveness attempt details into one session for easier tracking.
3. Added a new tracking point to help monitor and improve the liveness feature.
4. Improved UI/UX animations for a smoother user experience.
5. Strengthened security to better detect potential threats from devices and surroundings.
6. Improved fraud detection in the Jakarta (JK) region with updated protection tools.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.2</strong>              </summary>

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

1. Third-party library policy management is now available via the internal dashboard (OSS)

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.1</strong>                 </summary>

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

1. Enhanced user experience by handling threat detection on the backend, eliminating potential disruptions on the app interface.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.8.0</strong>              </summary>

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

1. Enhanced user experience by handling threat detection on the backend, eliminating potential disruptions on the app interface.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.7.6</strong>                 </summary>

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

1. Upgraded SDK code Protection
2. Collecting additional telemetry data like device sensors for further protection visibility.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.7.5</strong>                 </summary>

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

1. Enhancements and optimizations related to better SDK protection

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.7.4</strong>             </summary>

<mark style="background-color:purple;">**Device Support**</mark>

1. Introduced a  new flavour to support devices without Play Store

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

1. Added logger support to improve debugging and traceability

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.7.3</strong>                                                                          </summary>

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

1. Updated the version of a third-party dependency library.
2. Added de-sugaring library support in the SDK.

<mark style="background-color:orange;">**Bug Fixes**</mark>

1. Fixed an issue involving multiple threads
2. Fixed an exception caused during deviceId generation in an edge case. <br>

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.6.9</strong>                                                                         </summary>

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

1. Enhancements and optimisations related to better SDK protection/obfuscation

\ <mark style="background-color:orange;">**Bug Fixes**</mark>

* Fix an issue related to string resource not found for a specific application  configuration.
* Fix  issues related to Desugaring library causing failures on liveness flow&#x20;
* Fixed an issue  when keystore is not available on device causing StackOverflowError

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.6.7</strong>                                                                        </summary>

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

1. Added support for session Id for overall liveness flow and  transaction Id for each independent liveness calls.

\ <mark style="background-color:orange;">**Bug Fixes**</mark>

* Fix for Null Pointer Exception on camera  handling  and face detection option being null&#x20;
* Fix ConcurrentModificationException for a case where handling for camera frames

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.6.5</strong>                                                                       </summary>

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

1. Added capability to accept deviceID from application. This helps application track users
2. Enhancements to internal logging to improve tracking of authentication event errors.

\ <mark style="background-color:orange;">**Bug Fixes**</mark>

* Fix for Null Pointer Exception OnCaptureSuccess when image decode failed
* Performance Issue fix for darkImage detection.
* Illegal State Exception related to fragment state.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.6.4</strong>                                                                        </summary>

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

* Gesture based Active liveness eye blink, smile , and head shake
* zoom gesture  based liveness with three stages &#x20;

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.36</strong>                                                                      </summary>

<mark style="background-color:orange;">**Bug Fixes**</mark>

* Potential fix for Null Pointer Exception on handling backend liveness response
* Potential fix for Concurrent Modification Exception on management of internal data

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.35</strong>                                                                       </summary>

\ <mark style="background-color:orange;">**Bug Fixes**</mark>

* Potential fix for Null Pointer Exception on API response of liveness.
* Potential fix for Illegal State Exception when Fragment is not attached
* Potential fix for  Illegal State Exception when activity state is already saved

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.34</strong>                                                                        </summary>

\ <mark style="background-color:orange;">**Bug Fixes**</mark>

* Potential fix for Null Pointer Exception when detection options is cleared

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.33</strong>                                                                     </summary>

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

* Support for partnerTransactionID input from application,  This is for  tracking a liveness transaction based on partnerTransactionID.

\ <mark style="background-color:orange;">**Bug Fixes**</mark>

* Potential fix for Null Pointer Exception while creating  fragment on an edge case.
* Illegal Argument Exception while creating face bitmap due to bitmap width.&#x20;
* Bug fixes related to UI/UX.

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.31</strong>                                                                      </summary>

<mark style="background-color:orange;">**Bug Fixes**</mark>

* Bug fixes where the app  gets renamed if application name  string is missing.
* Return failed images in case of error if image is available
* Potential fix for null pointer exception leading to layout Inflate Exception
* &#x20;Bug fixes related UI/UX&#x20;

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.26</strong>                                                                    </summary>

<mark style="background-color:orange;">**Bug Fixes**</mark>

* The VIDA logo has been replaced with the new logo.
* Bug fixes related SDK security

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.25</strong>                                                                     </summary>

<mark style="background-color:orange;">**Bug Fixes**</mark>

* Enhancement in UI/UX customisation support
* Return  error code and error message for retry exhausted use case.
* &#x20;Bug fixes related UI/UX&#x20;

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.20</strong>                                                                    </summary>

<mark style="background-color:orange;">**Bug Fixes**</mark>

* Bug fixes for flutter integration&#x20;

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.17</strong>                                                                      </summary>

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

* Localisation support added for the application

</details>

<details>

<summary><strong>id.vida:liveness-sandbox: 1.4.16</strong>                                                                     </summary>

<mark style="background-color:purple;">**Device Support**</mark>

* Supported added to Android 5 Devices and above&#x20;

</details>