API Changelog¶

Below is a comprehensive list of notable changes, improvements, and fixes to the Biometrid API across all versions.

[3.6.0] – 2026-09-15¶

New Features¶

Face Liveness New Provider: Integrated a new provider for Face Liveness.
Billing: New internal billing page
Authentication: Session Context-Aware

Improvements¶

New Storage file system
Process Summary Dashboard

[3.5.1] – 2026-07-16¶

Bug fixes¶

Evidence report error
Joint ownership provider error and translation
OCR03 AO issue_date
Recover password verification

[3.5.0] – 2026-06-29¶

New Features¶

File Validation: Added a new File Validation step for verifying uploaded documents and files.
ASR on Video Liveness: Automatic Speech Recognition is now available within Video Liveness flows.
Face Compare New Provider: Integrated a new provider for Face Compare.
Video Conference New Provider: Integrated a new provider for Video Conference.

Improvements¶

User password strength
Form fields improvements across configuration and review screens.
AML & Triggers improvements, including handling of empty AML results and full AML translation review.
Auto-approve is now enabled by default for agents.
Default value support for Face Compare and provider collection fields.
Provider configuration fields can now be hidden by admins.
Document validation trigger values improved.
Processes can now be filtered by those made with Video Liveness (VL).
Dashboard process cards now show a tooltip with the process number on hover.
Process event handling reviewed: previous-step process events are now handled, and process:updated is dispatched before process:finished on the last update step.
Step data info is now surfaced in the review modal, including info from the previous process.
Review process locked modal reviewed.
Request Edit now correctly shows its information.
Flow Builder improvements: new dependencies, action trigger fields, separation of actions / provider actions / flow builder actions, and general drag-and-drop and interaction refinements.
Steps can now indicate whether the next step is API handled.
Search is now preserved when navigating back to the list.
Device is now set on step background enabled.
Rejected status translation added and reject status is now correctly sent.

Bug Fixes¶

Report evidence
VL duplicate reason
Account provider settings
Fixed Request Edit not showing information.
Fixed empty AML result handling.

[3.4.0] – 2026-05-18¶

New Features¶

Flow Cloning: Flows can now be duplicated directly from the Flow Builder, preserving all steps and configurations.
CMD Authentication Proxy: A new proxy endpoint is available for CMD Auth, allowing server-side CMD authentication flows.
Structured Error Handling: Expanded error handling layer with consistent error codes and recovery guidance across all endpoints.
Main Member Account: Accounts can now designate a primary (main) member, improving multi-member account management.
Channel OTP: Added support for new OTP delivery channels, providing additional options beyond SMS and email.
Accessibility Certification: The platform has achieved accessibility certification, meeting recognized standards for inclusive user experiences.
Flow Builder with AI
Step Age Estimation

Improvements¶

Analytics dashboard now displays the finish state of processes, providing clearer journey completion visibility.
Process details view now exposes individual step information, including step-level status and configuration.
More detailed metrics and breakdowns are available in the Analytics dashboard.
OCR03 now maps the residence_pt (residence in Portugal) field automatically.
Face06 liveness detection is now available in the Standard liveness tier.
Auto-approved processes for Video Conference and Video Liveness now appear in analytics reporting.
Process start details are now surfaced in the process details view.
Flow import now supports custom columns and respects light/dark theme preferences.
Task module has been reviewed and optimized for reliability and performance.
Error notifications are now dispatched when a process export fails.
File signed RTM event reviewed and corrected for consistent delivery.
Maximum attempt limits can now be configured independently for SIGN and OTP steps.
Proxy CMD authentication now validates allowed domain origins to prevent unauthorized usage.
A new real-time event is dispatched to send user information at key points in the verification journey.
Webhook payloads now include the process.reference field for easier process correlation on the integrator side.

Bug Fixes¶

Fixed inconsistency between data shown in the Backoffice and data filled during the verification journey.
Fixed BIOPMSCE006 error occurring during Face06 liveness evaluation.
Fixed Step Verify configurations not being persisted after save.
Fixed finish error occurring on auto-approved processes.
Fixed incorrect face reference when phoneNumber was used as the process identifier.
Fixed PT BI Card
Fixed Ignore OCR validations on default choosen map
Fixed flow analytics

[3.3.2] – 2026-03-18¶

Improvements¶

Maintain negativeFinish flag.
Send appUrl on custom sms/email.
Added notes support for AML sources.
Agents can now view evidence files directly in the review interface.
Improved copy text and layout in the review flow.
Added export functionality from the review view.
OCR now maps the age field automatically.
VL, VC and V files are now included in process exports.
A real-time event is now dispatched when a process reaches its maximum retry limit.
Added validation for child flows.
Roles updated to include new permissions.
Integrated Face03 face-adapt-2d model support.
Multi AML hits handling improvements.
Gallery filename normalization.
Modernized account module code.
Modernized app, credential, and certificate code.
Call module code quality improvements.
Views code quality improvements.
Dashboard, member, role, and notification module code quality improvements.
Cleaned unused packages.
TypeScript types improvements.
Mock data added for flow tests.
Dashboard tests refactored with mock data.
Process list tests refactored with mock data.
Account, role, and member tests updated.

Bug Fixes¶

Fixed document verify form edit issues.
Fixed document verify edit window cancel behavior.
Fixed export being available without the required permission.
Fixed name disappearing on joint ownership save.
Fixed AML tabs sizing issue.
Fixed conflicting prop and component name.
Fixed preview component name conflict.
Fixed account form prop names.
Fixed app preview display issues.
Fixed ocr mrz field.
Fixed step webhooks.
Fixed process export large excel files.

[3.3.1] – 2026-02-02¶

New Features¶

Auto‑Capture Recommendations: Added intelligent guidance to improve capture success.
Change Device Improvements: Enhanced the Change Device workflow with better validation.
CMD Authentication: Introduced a new authentication method using CMD for enhanced security.
Locked State Handling: Implemented a new locked‑state flow for improved process control.
Process Deletion: Added support for deleting processes.

Improvements¶

Implemented fallback to OCR03 when OCR00 fails.
Added user notifications when a process is rejected.
Improved form option ordering for better usability.
Added the user’s name to email templates.
Added support for sending approval and rejection emails in Video Liveness and Video Conference flows.
Added instructional video guidance to the Video Liveness flow.
Improved readability of process variables by presenting them in a more human‑friendly format.
Enhanced SMS error reporting with additional details.
Added SMS support to SDK credentials.
Cleaned and standardized additional OCR field names.
Automatically calculate Video Liveness duration on upload.
Included Video Liveness and Video Conference media files in process exports.
Added RTM event dispatch when maximum retries are reached.
Added ability to hide the copy‑link CTA.
Added feature for agents to copy the process ID.
Performed frontend and backend package audits and updates.
Removed filesystem license files and migrated configuration to environment variables.
Validated Base64 input fields to prevent injection attempts.

Bug Fixes¶

Fixed an issue preventing Joint Ownership flows from being created.
Resolved inconsistencies in Document Validation, including Change Device scenarios.

[3.3.0] – 2025-12-23¶

New Features¶

Accessibility Mode: Enhanced accessibility features for improved user experience
Logs OpenSearch: Advanced logging and search capabilities with OpenSearch integration
Face06 Liveness Detection: New Face06 liveness on compare3d2d with enhanced security
Flow Builder Enhancements: Control liveness and compare3d2d of Face06 directly in Flow Builder
Trigger System Improvements: New trigger finish rejected and ability to choose main finish
Auto-Approved Condition Trigger: Automated approval triggers based on configurable conditions
Video Liveness Non-Mandatory Tasks: Support for approving video liveness non-mandatory tasks
Document Verification Retries: New retries tab for document verification tracking

Improvements¶

Flow builder finish improvements with better workflow management
Enhanced flow builder colors and visual design
Improved date field configuration with past, future, and present options
Role organization in tabs for member list
Customizable instructions for VideoLiveness
Updated Liveness screen interface
Mobile SDK licensing improvements
Enhanced rule validation and adjustment system
Improved flow analytics with action data dashboard
Country multi-select for triggers
Enhanced dashboard with improved 'Last 20 Processes' card and title length handling
Better overview graph scaling on dashboard
Improved analytics sidebar
Enhanced triggers system with better finish handling
Trigger translation for Proof of Address
Multi-value selection from string fields
Improved flow following order (followed flows first)
Better provider customization display (only current provider)
OCR defaults configuration
Condition result visibility improvements
Warnings display in details tab
Document Sign country defaults and payload improvements
Warning when DocSign signature position is not selected
Face Compare 06 autopayload configuration
Account customization value restoration
Code quality improvements in components and processes
Video liveness configuration enhancements
VL encryption handling in update step
Video liveness filter improvements to ignore rejected/deleted processes
Enhanced error handling with proper ID not found management

Bug Fixes¶

Fixed Firefox field drag functionality
Resolved Flow Builder zoom in/out and step menu issues
Fixed long trigger names overlapping adjacent elements
Corrected request review and request edit modal behavior
Fixed visual problems in HTML fields customization
Resolved phone retrieval issues on document sign
Fixed repeated updated step on step finish page
Corrected users camera permission handling
Fixed inability to clear URL field in Applications
Resolved filter inserting incorrect date in process search
Fixed customization labels issues
Corrected impersonate access to all roles
Fixed processes date filter functionality
Resolved processes ID search bar issues
Fixed base64 visibility in OCR provider logs
Resolved step paths disappearing when selecting end type during field editing
Fixed positive/negative end translations being lost when collapsing and expanding
Corrected automatic translation errors in some fields
Fixed Document Validation of VideoLiveness requesting front and back of passports
Resolved inability to identify end type in process analysis
Fixed Video Liveness editing on process flow
Corrected Face 01 encryption issues

[3.2.5] – 2025-11-10¶

New Features¶

Notifications System: Comprehensive notification system for real-time updates and alerts
Document Sign Improvements: New signature position, details and report file
Vision Proof of Address: Enhanced address verification with visual document analysis
Video Liveness Improvements: Advanced video liveness detection with improved accuracy
Process History & Detail Tracking: Complete process lifecycle tracking and detailed audit trails
Auto-Approve System: Configurable auto-approval with customizable day thresholds and evidence generation
Auto-Following Process: Automated process following and tracking

Improvements¶

New dependency management system in Flow Builder
Basic authentication support for secure webhook endpoints
Comprehensive device fingerprinting and metadata collection
Enhanced step configuration options in Flow Builder
Improved step intro screen settings
Better flow import payload handling
Read-only flow interaction improvements
Copy tokens functionality for easier credential management
Skeleton loaders for better loading states on dashboard and tables
Improved responsive design across all screen sizes
Enhanced form field list design and layout
Better sidebar behavior and language-aware updates
Action filter support in Flow Analytics
Tooltips for better data understanding in Flow Analytics
Outcome updates for triggers
Performance optimizations for high-volume processes
New status for invalid processes by retry count
Process status tracking with originating step information
Improved finish status information display
Enhanced process state management
Improved routing when leaving account forms
Support for empty fields in update step forms
Better phone and zip code handling in agent edit steps
User account active status validation
Account security form improvements
Impersonate functionality restricted to non-owned accounts
Role-based member list filtering
Inactive accounts removed from member requests
Default values for retry configuration
Risk score default settings
SMTP configuration enhancements
hasPhone/hasEmail attributes on OTP and Sign-OTP steps
Improved canceled and clean emails with flow group support
Enhanced email template handling
Comprehensive audit and update of all dependency packages

Bug Fixes¶

Fixed responsive layout breaking on mobile devices
Corrected overview dropdown menu behavior in dashboard
Resolved flows card display issues
Fixed select elements appearing behind cards
Corrected incorrect created_at timestamps
Fixed date range filtering in dashboard
Resolved date filtering inconsistencies
Fixed trigger empty date yearsOld validation
Fixed trigger configuration issues in Flow Builder
Corrected step tooltip display problems
Resolved flow list options menu behavior
Fixed form action label disabled state
Corrected trigger format with phone numbers
Resolved template creation issues with payloads
Fixed create/edit template with newly created steps and fields
Resolved MFA account change issues
Fixed child account creation errors
Corrected role list display in member updates
Fixed mobile autocapture functionality
Resolved force camera and microphone permission issues
Corrected video liveness review playback problems
Fixed date filter in call center view
Resolved OCR03 text validation issues
Fixed error BIOTMPSE007 on tax_number and social_security_number fields
Improved PDF generation for document signing with OTP

[3.2.4] – 2025-09-16¶

New Features¶

Enhanced flow analytics and monitoring capabilities
Improved process status tracking and validation
Advanced account management and member creation flows

Improvements¶

Optimized process performance and reliability
Enhanced email delivery and notification systems
Improved data validation and error handling
Better integration with third-party services
Enhanced account permission management

Bug Fixes¶

Resolved issues with process creation and validation
Fixed edge cases in account member management
Corrected problems with email notifications
Resolved flow analytics data accuracy issues
Fixed various stability and performance issues
Addressed network connectivity edge cases

[3.2.3] – 2025-07-16¶

New Features¶

Enhanced process and request review system
Advanced SMTP configuration with improved email delivery

Improvements¶

Performance optimizations across core endpoints
Enhanced error handling and validation
Enhanced Spanish document OCR processing with tax and document number review
Process data trigger functionality for step navigation
Billing system integration for OCR03 error handling
Changed errorFields to integrity status for better clarity
Enhanced process decryption for invalid processes
Improved trigger validation to prevent duplicate field usage
Updated clean process task functionality

Bug Fixes¶

Resolved minor stability issues
Fixed edge cases in authentication flow
Fixed log service request body handling issues
Resolved step back navigation with multiple equal stepId
Fixed RTM socket disconnect issues in multi-pod environments
Corrected flow preview breaking on rejected/finish triggers

[3.2.2] – 2025-05-26¶

Improvements¶

Optimized API response times
Improved logging and monitoring capabilities
Enhanced security validations
Comprehensive audit and update of all dependency packages

Bug Fixes¶

Fixed minor issues with error responses
Resolved edge cases in data validation

[3.2.1] – 2025-05-06¶

New Features¶

Completely redesigned Backoffice interface with modern UI/UX

New Features¶

Advanced account throttling mechanisms for better resource management
Comprehensive account customization options
Enhanced videoconference task functionality with better reliability
Improved navigation and workflow management

Bug Fixes¶

Resolved issues with session management
Fixed minor display issues in dashboard

[3.2.0] – 2025-04-14¶

New Features¶

Advanced risk score configuration system
Implementation of additional security layer for process validation
Enhanced threat detection and prevention
New comprehensive process status tracking
Improved workflow state management

Bug Fixes¶

Resolved critical issues with process state transitions
Fixed minor API response inconsistencies

[3.1.0] – 2024-10-24¶

Improvements¶

Comprehensive risk score analysis and reporting
Machine learning-enhanced fraud detection
Full-featured call center integration with videoconference scheduling
Advanced appointment management system
Advanced flow customization capabilities in SDK
Public encryption support for enhanced security
Improved developer experience with better documentation

Bug Fixes¶

Resolved integration issues with third-party services
Fixed minor SDK compatibility issues

[3.0.0] – 2024-07-31¶

Major Release¶

First stable release of the 3.0 architecture
Complete API redesign with improved performance and security
Enhanced developer experience with comprehensive documentation
Breaking changes from 2.x versions