Release notes

6.8.1 (April 29, 2025)

🛠 Improvements/Fixes

SDK analytics architecture refactoring

Fixed analytics data transmission by removing external analytics library dependencies and migrating to a more reliable and direct communication system.

6.7.3 (March 31, 2025)

🛠 Improvements/Fixes

Upload mode stability

Fixed an issue where document upload mode would incorrectly trigger camera-specific operations, potentially causing unexpected behavior. This improvement ensures that the SDK correctly handles different capture modes with appropriate functionality.

6.7.2 (March 20, 2025)

🛠 Improvements/Fixes

Image capture reliability in social media WebViews

Fixed an issue where document captures within Instagram WebViews would occasionally result in blurry or invalid images.

6.7.1 (March 13, 2025)

🛠 Improvements/Fixes

Camera stream autoplay in mobile WebView

Fixed an issue where the camera stream wasn't playing automatically when initializing the SDK inside a mobile WebView.

6.7.0 (March 10, 2025)

🚀 Performance Improvement

Faster SDK loading time

• Simplified the camera initialization process, reducing unnecessary operations and improving efficiency.

🛠 Improvements/Fixes

Removal of camera switching options

The following appearance options have been removed:

• hideCameraSwitchButton

• cameraSwitchButtonIconSize

• cameraSwitchButtonIconColor

• cameraSwitchButtonIcon

Fixes for screen rotation issues

• Fixed issues where the interface was not correctly rendered when switching between portrait and landscape mode on Android and iOS devices.

• Improved the consistency of the modal display when changing screen orientation.

6.6.1 (February 26, 2025)

🛠 Improvements/Fixes

Modal display issues on iOS and during screen orientation changes

• Fixed an issue on iOS devices where the SDK modal was not displayed correctly when starting the capture process in portrait mode.

• Fixed issues on some devices where the SDK modal was not displayed correctly when the screen orientation was changed.

• Improved event listener management to prevent unexpected behavior and memory leaks.

6.5.2 (February 04, 2025)

🐛 Bug fix

Add upload error invalid document title and details. More details can be found here.

6.5.1 (January 31, 2025)

🐛 Bug fix

Improve camera choice on iPhone

6.5.0 (January 30, 2025)

🚨 Breaking change

Removal of permissions initialization method

The method initPermissions has been removed in this version. The SDK now automatically initializes the required permissions when the SDK is initialized.

🆕 New feature

⛔ Prevent camera access requests in upload mode

The SDK now prevents unnecessary camera access requests during the upload mode. The camera access request is only triggered when the user starts the capture on "automatic" or "manual" mode.

🛠 Improvements/Fixes

• Enhanced SDK UI behavior with animations and better handling of modal states.

• Fixed bugs related to camera initialization, UI behavior, and error handling.

6.4.0 (January 29, 2025)

Important Notice: Experimental Feature This version introduces an experimental feature flag that may undergo changes in the future. When using this flag, it is important to be prepared for code updates in future versions.

🆕 New feature

Auto-detect file extension during upload

The feature flag uploadMimeDetection enables the SDK to automatically detect the file extension of the uploaded document. This feature is disabled by default.

For this feature to work, the expectedDocument must be RG_FULL or CNH_FULL. When enabled, the SDK will apply the following validations:

• If the uploaded document is a PDF, it must contain both the front and back sides in the same file.

• If the uploaded document is an image, you must upload two separate images: the first with the front and the second with the back of the document.

This feature allows users to upload RG_FULL and CNH_FULL documents without manually specifying the file extension.

6.3.0 (December 26, 2024)

🆕 New features

📷 Framing Analyzer Toggle

Added a new option to enable or disable the AI-guided framing analysis. This AI guides the user to correctly position the document in the camera, and it is enabled by default. More details can be found here.

6.2.0 (December 16, 2024)

Important Notice: Breaking Changes Ahead This version includes significant breaking changes that will impact how you use the SDK. We highly recommend reviewing the full release notes and the updated documentation before upgrading to this version.

🚨 Breaking changes

🛠 SDK instanciation/builder

The SDK class DocumentDetectorSdk has been renamed to DocumentDetector.

The following parameters have been removed from the options object:

• analyticsSettings (use analytics instead)

• environmentSettings.disableDesktopExecution (use blockExecutionOnDesktops instead)

• capturerSettings.disableAdvancedCapturing

• appearanceSettings (use appearance instead)

• textSettings (use messages instead)

📷 Capture method

The following parameters have been removed from the capture method:

• container (now the SDK will be displayed as a modal)

• stages

Now, the capture method only takes a single parameter: captureOptions.

The method output has also changed. The following properties have been removed:

• imageUrl (use image.url instead)

• imageKey (use image.storageInfo.key instead)

• blob (use image.blob instead)

• documentType (use detectedDocument.type instead)

• documentSide (use detectedDocument.side instead)

The method now returns a CaptureResult object.

🆕 New features

🖼️ New UI

The SDK now displays a new UI that improves the user experience and the document capture process. Instead of displaying the SDK in a container, the SDK is now displayed as a modal that covers the entire screen, making it easier for the user to capture the document.

🧠 New AI model

The SDK now uses a new AI model to help the user to correctly position the document in the camera. This new model increases the percentage of successful captures and the OCR accuracy.

📊 Analytics options

Added debug mode to the SDK. This mode will display additional information in the console. To enable it, set the analytics.enableDebugMode option to true when creating the SDK instance.

🎨 Appearance options

• Added an option to customize the icon color of the SDK close button. Use the appearance.general.closeButtonIconColor option to set the color.

• Added an object to customize the appearance of the SDK on "upload" mode. Use the appearance.upload option to set the appearance. More details for each property can be found here.

📨 Customize messages

• Added more options to customize the messages displayed by the SDK. Use the messages option to define the SDK messages. More details for each property can be found here.

• Added an object to customize the messages displayed by the SDK on "upload" mode. Use the messages.upload option to define the messages. More details for each property can be found here.

📷 Capture process

• Added an option for the "upload" mode to define which document types are accepted. Use the captureOptions.upload.uploadFileType option to set the accepted document types. More details can be found here.

• Added an option to pass an identifier of the user that is capturing the document. Use the captureOptions.personID option to set the user identifier. More details can be found here.

• Added a property to the capture output to indicate if the capture is valid. Use the CaptureResult.isCaptureValid property to check if the capture was successful. More details can be found here.

🔓 Init permissions method

Added a new method to initialize the permissions required to use the SDK. More details can be found here.

🤖 Load AI model method

Added a new method to load the AI model used by the SDK. More details can be found here.

🖥️ Browser support checker

Added a new method to check if the current browser is supported by the SDK. More details can be found here.

❓ SDK initialization checker

Added a new method to check if the SDK is correctly initialized. More details can be found here.

🛠 Improvements/Fixes

• Added a mechanism to force the SDK capture mode to "manual" when the user device is not performing well with the "automatic" mode.

• Fixed an issue where the SDK would not display the whole camera view to the user, causing the captured image to be different from what is displayed.

• Removed incorrect constraints causing slowness during the capture process, particularly in two-sided document captures.

• Improved the frame analysis process to avoid being performed concurrently, which caused performance issues on some cases.

• Fixed an issue where the frame captured was not the same as the one analyzed by the AI model, which could cause incorrect results.