JavaScript SDK Changelog¶

Notable changes to the Biometrid JavaScript SDKs (Core and UI).

[3.3.1] – 2026-07-13¶

UI SDK¶

Fix rejected screen
Removed ocr details screen on rejected

[3.3.0] – 2026-06-29¶

UI SDK¶

New Provider for Video Conference
New Step File Validation
Review all face translations
Textarea unescape special fields
Generic error message for OCR
Review events connections

[3.2.0] – 2026-05-18¶

UI SDK¶

Error Handling: Improved error handling and user feedback across all flows
Channel OTP: Added OTP channel support for identity verification steps
Accessibility: Accessibility certification improvements for WCAG compliance
Residence Card: Enabled residence card support on VC flow
Face Compare: Face compare screen improvements
Residence: Added residence title translation support
New Step Age Estimation

Core SDK¶

Error Handling: Standardized error responses and improved error propagation
Channel OTP: OTP channel integration in core process flow
Face06: Updated Face06 dependency to v6.0.2

[3.1.5] – 2026-04-24¶

UI SDK¶

Auto Capture: Added exact on deviceId and facingMode
General: Improved inline layout to maintain parent size

[3.1.4] – 2026-04-02¶

UI SDK¶

Auto Capture: Fixed camera and rotation issues on Firefox
Auto Capture: Hybrid front and back camera review
Initialize: Added phone option to pre-fill QR code SMS link
Initialize: Added autocapture.overlay config options on initialization

[3.1.3] – 2026-03-20¶

UI SDK¶

Auto Capture: Improved toast position on inline mobile layout
Auto Capture: Navigate to upload screen when camera is not available
Sidebar: Fixed sidebar references

[3.1.2] – 2026-03-18¶

UI SDK¶

Auto Capture: Fixed rotation, toast position/width, selfie camera and iOS review
Auto Capture: Models lifecycle update
General: Fixed area number focus on some devices
Initialize: Improvements on appUrl option
Hybrid Device: Force new back camera selection

[3.1.1] – 2026-02-02¶

UI SDK¶

Auto Capture: Container width improvements, fixed blur in some devices and refinements applied.
Change Device Validation: Enhanced Change Device workflow with improved validation.
Document Validation: Fixed inconsistencies in Document Validation, including Change Device scenarios.
Face06 Translations: Added and refined translations for Face06.
General UI Fixes: Various UI corrections and refinements applied.
Hide Copy Link CTA: Added the ability to hide the copy-link action when needed.
Hybrid Device: New toggle to enable 'Mobile' status for hybrid devices.
i18n Template Usage: Improved template usage for internationalization consistency.
Options Ordering: Improved handling of UI option ordering.
OTP Payload Display: Added UI support to show OTP payload information.
Page Title Toggle: Added new setting to enable or disable automatic page title updates.
Pinia Store Updates: Updated Pinia store references for better stability.
Proof of Address: Fixed issues in proof-of-address validation tests.
Responsive Container: Improved application container responsiveness across screen sizes.
Sidebar Animation: Improved sidebar closing animation for a smoother user experience.
Testing: Enhanced functional test coverage and automation.
Video Instructions: Added instructional video guidance to the Video Liveness flow.

Core SDK¶

Face02 Provider Improvements: Technical validation and refinements applied to Face02 provider.
General Refinements: Minor enhancements and stability improvements across Video Liveness and core SDK components.

[3.1.0] – 2025-12-23¶

UI SDK¶

Accessibility: Enhanced accessibility mode for improved user experience.
Auto Capture: Fixed face auto capture initialization issues.
Card Rotation: Improved native:photo card rotation handling.
Chat Design: Updated VC chat notes design for better user experience.
Components: Updated all components pattern.
Dark Mode: Complete dark mode validation and implementation.
Face06 Liveness: New Face06 liveness detection on compare3d2d with enhanced security.
Typography: Corrected autocapture typography errors.
VC Window: Enhanced video conference window resize functionality.
Video Conference: Videoconference SDK customization support.
Warnings: Enhanced landscape capture warning messages.

Core SDK¶

Bug Fix: Resolved liveness 3D undefined error message with face compare.
Improvements: Minor video liveness enhancements and refinements.
KMM Detection: Added KMM source detection capability.
Liveness Screen: Updated liveness screen interface and user experience.
Translations: Guaranteed all translation files exist across all languages.

[3.0.22] – 2025-11-10¶

UI SDK¶

Configuration: Added hideSidebar option for customizable sidebar display.
Date Fields: Resolved date field handling and validation issues.
Environment: Added stamp configuration to UAT SDK environment.
Form Fix: Fixed form submission error in V3.
Layout: Improved first step layout and user interface.
Video Conference: Enhanced VC tasks from current step handling.
Video Liveness: Enhanced video liveness detection with improved accuracy and processing.
Vision: Added Vision Proof of Address document verification support.

[3.0.21] – 2025-09-04¶

UI SDK¶

AutoCapture: Fixed autocapture color handling and processing.
Dependencies: Updated all packages to latest stable versions.
Device: Fixed device type detection and classification.
OCR: Enhanced finish secondary color configuration.
QR Code: Added white padding around QR code for better readability.
Windows: Fixed Windows always defaulting to desktop mode.

Core SDK¶

Bug Fixes: Fixed modal closure on device disconnect.
Dependencies: Updated all packages to latest stable versions.
Device: Enhanced device type detection for Surface devices.
Document: Enhanced document sign payload handling.
Video Conference: Improved video conference task initialization.

[3.0.20] – 2025-07-14¶

UI SDK¶

Forms: Enhanced form upload with file preview capability.
Localization: Added comprehensive iProov translations.
PDF: Inline PDF toolbar for better document handling.
Security: Added password field type with visibility toggle.
Testing: Enhanced functional test coverage and automation.
UI Enhancement: Custom password visibility icons.
Video Conference: Improved VC autocapture functionality.

Core SDK¶

Dependencies: Updated all packages to latest stable versions.
Improvement: Better compatibility with modern build tools.
Performance: Improved SDK initialization performance.
Security: Enhanced security patches and vulnerability fixes.

[3.0.19] – 2025-05-26¶

Core SDK¶

AutoCapture: Updated to autocapture v1.1.4 with improved accuracy.
Face Detection: Enhanced face01 module to v2.2.12 for better liveness detection.
Improvement: Reduced false positives in facial recognition.
Performance: Optimized face recognition algorithms.

UI SDK¶

API: Improved real-time event processing.
Improvement: Better video liveness event management.
Performance: Optimized video processing workflows.
Video Conference: Enhanced VC/VL event handling and processing.

[3.0.18] – 2025-05-05¶

Core SDK¶

AutoCapture: Added type configuration option on SDK start.
Bug Fix: Fixed autocapture type validation issues.
Documentation: Updated autocapture configuration examples.
Improvement: Enhanced autocapture initialization with custom parameters.

UI SDK¶

AI Enhancement: Model warm-up on intro screen for faster processing.
AutoCapture: Type configuration on SDK initialization.
Configuration: Improved OCR settings handling and validation.
Design: Added base color customization options.
OCR: Added residence document type recognition.
UI Enhancement: Redesigned command modal interface.
Instructions: Enhanced review action instructions and guidance.

[3.0.17] – 2025-04-14¶

Core SDK¶

Configuration: Added autocapture model URL customization.
Improvement: Better device orientation handling.
Mobile: Force landscape orientation for autocapture functionality.
Performance: Optimized model loading for autocapture.

UI SDK¶

Analytics: Google Tag Manager implementation for tracking.
AutoCapture: Added URL configuration option for model loading.
Optimization: Removed unnecessary API requests for better performance.
Testing: Comprehensive review and update of initialization tests.
Triggers: Enhanced trigger handling and event management.
iOS: Improved face06 handling for iOS devices.

[3.0.16] – 2025-03-13¶

Core SDK¶

AutoCapture: Enhanced autocapture functionality with improved accuracy.
Bug Fix: Resolved autocapture initialization edge cases.
Documentation: Updated README with latest configuration options.
Improvement: Better error handling and validation.

UI SDK¶

Cleanup: Removed debug logs and improved code organization.
Documentation: Updated README with latest features.
Face Detection: Improved face error handling and validation.
Localization: Face06 translations for better user experience.
Organization: Better component structure and organization.
OTP: Paste OTP code functionality for better UX.
Process Management: Enhanced handling of approved/rejected processes.
Video Conference: Enhanced VC settings and configuration.
Video Liveness: Comprehensive video liveness task management.

[3.0.15] – 2025-02-28¶

Core SDK¶

AutoCapture: Added side option configuration for document capture.
Improvement: Better control over capture orientation and angles.
Manual Photo: Enhanced autocapture support for manual photo workflows.
Performance: Optimized capture processing speed.

UI SDK¶

AI Enhancement: Enhanced document validation algorithms.
Fraud Detection: Advanced document fraud detection capabilities.
OCR: Significant improvements to document OCR accuracy and processing.
Validation: Better document authenticity verification.

[3.0.14] – 2025-02-12¶

Core SDK¶

AutoCapture: Updated autocapture engine with improved detection algorithms.
Bug Fix: Fixed edge cases in autocapture validation.
Improvement: Enhanced accuracy for document and face detection.
Performance: Faster capture processing and validation.

UI SDK¶

Camera: Enhanced CSS styling for take photo functionality.
Improvement: Better camera control and user guidance.
UI Enhancement: Improved photo capture interface design.
Video: Disabled picture-in-picture mode for better UX.

[3.0.13] – 2025-02-07¶

UI SDK¶

Browser: Enhanced browser version detection and compatibility.
Design: Comprehensive review of scrollbar, sidebar, and date field styling.
Forms: Fixed radio button styling and behavior issues.
Responsive: Improved responsive CSS for all device sizes.
Video Liveness: Enhanced video liveness introduction interface.

[3.0.12] – 2024-01-10¶

UI SDK¶

API: Version information sent with all API requests.
Device: Automatic modal closure on device orientation changes.
Forms: Enhanced date picker with month/year selection.
QR Code: QR code path limited to process-specific contexts.
Validation: Comprehensive review of initialization validations.
Video: VC/VL components now work inside shadow DOM.

[3.0.11] – 2024-01-06¶

UI SDK¶

Configuration: Enhanced deployment flexibility options.
Container: Added custom container configuration option.
Improvement: Better environment-specific settings.
Path: Root folder configuration for flexible deployment.

[3.0.10] – 2024-12-07¶

Core SDK¶

AI Enhancement: Improved machine learning models for better accuracy.
AutoCapture: Major autocapture engine update with enhanced capabilities.
Improvement: Better lighting and angle detection.
Performance: Significantly faster capture processing.

UI SDK¶

Cleanup: Removed testing CSS classes from production.
Monitoring: Integrated Sentry for error tracking and monitoring.
Styling: Fixed text-align left as base styling.
Video Liveness: Added new Video Liveness action capability.
iOS: Fixed zoom and inline height issues on iOS devices.

[3.0.9] – 2024-12-06¶

UI SDK¶

Forms: Improved HTML field design and styling.
Language: Reviewed and improved language setting functionality.
Localization: Updated China zipcode validation.
Styling: Reset CSS on container for better isolation.
Upload: Enhanced upload to take photo button functionality.

[3.0.8] – 2024-12-04¶

UI SDK¶

Improvement: Better form validation and user guidance.
Phone: Fixed phone number default values and validation.
Retry: Enhanced retry trigger functionality.
Scheduling: VC schedule with time block management.

[3.0.7] – 2024-11-28¶

UI SDK¶

Camera: Fixed take photo frame positioning and sizing.
Configuration: Added appUrl to initialization parameters.
Context: Handle context changes on page refresh.
Device: Better handling of device disconnection events.
Mobile: Improved mobile sidebar with outside click handling.

[3.0.6] – 2024-11-25¶

Core SDK¶

Configuration: Added SDK root path configuration option.
Documentation: Updated configuration examples.
Improvement: Better support for custom deployment environments.
Path Management: Enhanced file and resource path handling.

UI SDK¶

Configuration: Added SDK root path configuration option.
Improvement: Better support for custom deployment environments.
Path Management: Enhanced file and resource path handling.

[3.0.5] – 2024-11-20¶

Core SDK¶

Device Detection: Updated device type detection and classification.
Face Model: Added dedicated face model for enhanced autocapture accuracy.
Improvement: Better device-specific optimizations.
Performance: Optimized face detection algorithms.

UI SDK¶

Device Context: Enhanced device context transition handling.
Performance: Improved context switching performance.
State Management: Better state management across device changes.

[3.0.4] – 2024-10-28¶

Core SDK¶

AutoCapture: Initialized new autocapture functionality.
Improvement: Enhanced liveness validation accuracy.
Liveness: Integrated new liveness detection provider.
Testing: Comprehensive liveness validation tests.

[3.0.4] – 2024-10-11¶

UI SDK¶

Flow Review: Comprehensive user flow review and optimization.
Improvement: Streamlined process flows.
UX: Enhanced user experience and workflow improvements.

[3.0.3] – 2024-09-30¶

Core SDK¶

AI Integration: Machine learning-powered document and face capture.
AutoCapture: Added comprehensive autocapture functionality.
Documentation: Complete autocapture integration guide.
Improvement: Automated quality validation and feedback.

UI SDK¶

AutoCapture: Added comprehensive autocapture functionality.
Camera: Camera rotation functionality for better positioning.
Date: Reviewed and improved date component functionality.
Request Edit: Enhanced request editing capabilities.

[3.0.0] – 2024-09-05¶

Core SDK¶

API: Full compatibility with Biometrid API v3.
Documentation: Complete API documentation and examples.
Performance: Significantly improved performance and reliability.
Security: Enhanced security features and encryption.
Testing: Comprehensive test coverage and validation.
Major Release: Complete SDK architecture redesign for version 3.

UI SDK¶

Architecture: New component architecture and design system.
Interface: Modern, responsive user interface.
Localization: Multi-language support.
Mobile: Optimized mobile and tablet experience.
Performance: Significantly improved loading and rendering performance.
Major Release: Complete UI SDK redesign for version 3.

Breaking Changes from 2.x¶

Complete API restructure.
New initialization pattern and configuration options.
Updated event handling and callback mechanisms.

Note: Version 2.x is now in maintenance mode. Please upgrade to 3.x for new features and active support.