DocumentDetector

Important Notice: Breaking Changes Ahead This release 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.

6.2.0 (December 16, 2024)

🚨 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.gVeneral.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.