Skip to content

Release 6.1 — February 23, 2024


  • Supported face match on mobile devices without requiring data transmission to a server. Now, even if a device is offline it is still possible to compare a photo from a document with a selfie. Find more details in the Client-Side Comparison section.

  • Improved performance with up to a 50% reduction in processing time per request, based on internal testing for all features.

  • Optimized GPU memory usage, achieving a 25% reduction. This efficiency boost allows for running more workers simultaneously, processing a higher volume of requests with the same GPU memory allocation.

  • Added support for new database types: Oracle 19c and MS SQL.

  • Introduced YAML-based configuration of the Web Service, see the Configuration page. The instructions on how to migrate from configuration via environment variables to YAML are provided in the Migration Guide.

  • Unified the library paths for Linux-based distributions and deleted subfolder structures within them. From this release onward, library paths for all Linux-based distributions will be /app/extBin/unix and /opt/regula/face-rec-service/extBin/unix.

  • Upgraded the major version of the Helm chart to support YAML configuration. Helm charts created with the upgrade command for the previous version are no longer supported. We recommend using parallel installation to migrate data.

  • Discontinued support for CentOS. We recommend Rocky Linux as an alternative, see details on the Installation page.

  • Increased minimum supported versions on Ubuntu and Debian. Check the documentation for updated requirements.

  • Updated Milvus to version 2.3.8. Refer to the corresponding Milvus Release Notes. For migration to this version, consult the Migration Guide.

  • Enhanced encryption for liveness data that Mobile and Web clients send to backend, so the current version of Mobile SDK and Web Component will no longer function with older versions of the Web Service. Make sure to update accordingly for continued compatibility.


  • Improved the Presentation Attack Detection (PAD) mechanism for electronic devices. Our integral testing has shown that it detects 99% of spoofing attempts, with a false rejection rate of less than 0.1%.

  • Added support for a new mode that ensures secure delivery of the liveness transaction video to a server. See recordingProcess in the Web Components Settings section and the Process Customization on Mobile documentation.

Face Identification

  • Enabled person search by image URL, eliminating the need to send an image to the service. Refer to OpenAPI documentation for details.

  • Fixed a performance degradation issue when adding a large number of persons to the search database.


  • Supported Certificate Pinning for secure connections to trusted servers, see the Certificate Pinning page.

  • Changed the behavior when a user declines a request to allow access to the camera. Now the cameraPermissionDenied error is returned immediately without showing an error screen.

  • Resolved issues with text customization in specific cases.

  • Fixed the issue where a blank screen was displayed when initiating the liveness process on iOS-based devices.

  • Implemented a brief pause for better user experience in Face Capture. Added a customizable parameter for business-specific needs.

  • Disabled the illumination check during the selfie capture.

  • For Liveness, added landscape mode support for the Android Mobile SDK.

  • Supported getting the Liveness results in the Java client.


  • Updated dependencies to address security vulnerabilities in React Native.

  • Fixed a crash on Flutter on iOS occurring in rare cases when the detector failed to detect a face and didn't return the detection.

Web Service API

  • Introduced the ability to configure image processing parameters in all requests. Note that the thumbnails parameter is deprecated and will be removed in the next version. Use outputImageParams for thumbnails, see the Migration Guide for details.

  • Supported the usage of the Milvus Cloud Service, refer to the Configuration page.

  • Revised and optimized permissions required by the Web Service to interact with storage, removing unnecessary access. Refer to the Storage article.

  • Updated package dependencies to the latest version to fix security breaches.

  • Resolved an issue where users encountered an error when attempting to perform Liveness Assessment after a long idle in environments using MySQL or MariaDB.

  • Fixed an issue where an S3 path to a liveness video contained an extra / symbol after a bucket name.

  • Fixed an issue where it was possible to rename the default group.

  • Fixed an issue where the Web Service required the ListAllMyBuckets permission when using AWS storage.

  • Fixed an issue with incorrect types for transactionId, tag, and image_id fields in the OpenAPI.

  • Adjusted error handling for match requests with inappropriate images (without a person's face). The Service now returns error 400 and a corresponding message in the response body instead of error 500.

  • For Face Match, added support for a new image source type barcode, see the ImageSource enumeration.

Demo Website

  • Introduced support for processing of custom JSON requests. Now you can fine-tune a request, save it as a JSON file, and then upload or drag-and-drop it onto the demo site. The demo site will forward the request to the server and display the results.

  • Enhanced the advanced mode for Face Image Quality Assessment. Now, when selecting this mode, all fields are automatically pre-filled with values from the scenario you switched from when selecting the advanced mode.

  • Fixed an issue where the message "No face detected" was displayed even when a request was not actually sent to the server.

  • Fixed an issue where images in the WebP file format were not processed on the demo site.

Web Clients

  • Added support for searching using image URLs for all Web Clients.

  • Revised the JS Web Client for improved efficiency. It now weighs three times less, supports types in responses, and automatically exports the correct version of CommonJS or ESM.

  • Performed massive bug fix in the JS Web Client.

  • Performed massive bug fix in the Python Web Client.

  • Supported async/await patterns for the C# Web Client.

  • Introduced the ability to add custom headers to requests in the C# Web Client.

  • Performed massive bug fix in the C# Web Client.

  • Added the missing codes to the FaceSDKResultCode enum.

Web Components

  • Introduced support for Content Security Policy (CSP) Nonce policy. Refer to the Security Page for detailed information.

  • Added support for video rotation by 90, 180, 270, or -90 degrees to accommodate various camera installations. See the rotationAngle parameter.

  • Implemented a brief pause before capturing selfies in Face Capture, providing a better user experience. Users are prompted to hold still, and the adjustable holdStillDuration parameter allows customization for specific business needs.

  • Disabled the illumination check during the selfie capture.

  • Added a sample for the Nuxt3 framework.

  • Updated package dependencies to the latest version to fix security breaches.

Installation Packages

  • Added templates illustrating how to deploy in the AWS Cloud. Explore the options in the Deployment in Clouds section.

  • Supported using tags to pull the latest version of the GPU container. Refer to the Docker Installation documentation.

  • Removed the FACEAPI_LIC_URL environment variable; now you should use REGULA_LICENSE instead. Refer to the Configuration page for details.

  • Resolved an issue in the Docker Compose configuration where the Web Server was running under the /export directory, conflicting with the mounted volume for the /data directory.

  • Updated the Docker Compose file to replace deprecated environment variables MINIO_ACCESS_KEY and MINIO_SECRET_KEY with MINIO_ROOT_USER and MINIO_ROOT_PASSWORD.


The following Face SDK component versions comply with this release:

Component Version
Web Service 6.1.391.1013
Web Components 3.1.0
Mobile Native
ㅤㅤㅤiOS API 6.1.1746
ㅤㅤㅤiOS Core Basic 6.1.584
ㅤㅤㅤiOS Core Match 6.1.583
ㅤㅤㅤAndroid API 6.1.3021
ㅤㅤㅤAndroid Core Basic 6.1.407
ㅤㅤㅤAndroid Core Match 6.1.408
Mobile Hybrid
ㅤㅤㅤXamarin iOS API 6.1.1746
ㅤㅤㅤXamarin iOS Core Basic 6.1.584
ㅤㅤㅤXamarin iOS Core Match 6.1.583
ㅤㅤㅤXamarin Android API 6.1.3021
ㅤㅤㅤXamarin Android Core Basic 6.1.407
ㅤㅤㅤXamarin Android Core Match 6.1.408
ㅤㅤㅤReact Native API 6.1.2
ㅤㅤㅤReact Native Core Basic 6.1.0
ㅤㅤㅤReact Native Core Match 6.1.0
ㅤㅤㅤCordova API 6.1.0
ㅤㅤㅤCordova Core Basic 6.1.0
ㅤㅤㅤCordova Core Match 6.1.0
ㅤㅤㅤIonic Native API 6.1.0
ㅤㅤㅤFlutter API 6.1.1
ㅤㅤㅤFlutter Core Basic 6.1.0
ㅤㅤㅤFlutter Core Match 6.1.0