scanbot_sdk changelog and release notes

9.0.07 Jul 2026Breaking

qualityLevelThresholds and qualityLevelIndices are deprecated (see Breaking changes).

🎉 New:
- General:
  - Added property hibernationDirectory to SdkConfiguration to specify a custom directory for storing image reference hibernation data.
  - Added accessibilityState and activeAccessibilityState properties for flash and flip camera buttons in the RTU UI Barcode Scanner and Data Capture screens.
  - Added the forceClose API for all RTU UI screens to immediately stop the UI and release all resources used by the camera and scanners.
  - ImageRef: optimize property added to SaveImageOptions and EncodeImageOptions for saveImage and encodeImage methods. When set to true, the encoder spends additional time to improve JPEG output quality.
  - Android: Added property cameraPreviewAspectRatio to CameraConfiguration to support different preview aspect ratios in FIT_IN mode in RTU UI screens.
  - iOS: SPM integration is available for iOS.
- Document Scanner:
  - Added ScanbotDocumentEnhancer API with straightenImageRef and straightenImageFileUri methods that remove crinkles, creases, folds, and curl from document photos. It is enabled by default in the RTU UI and automatically applied in auto-cropping flows. See the Document Enhancer documentation for details.
  - Added parameter straighteningParameters to the DocumentScannerOutputSettings to configure the behavior of the Document Enhancer in the RTU UI Document Scanner.
  - Added parameter straighteningParameters to ModifyPageOptions, AddPageOptions, and CreateDocumentOptions to allow post processing of pages using the Document Enhancer.
  - Support for recognizing cropped documents. DocumentScannerParameters now includes alreadyCroppedScoreThreshold, and DocumentDetectionScores now includes alreadyCroppedScore. In single-shot mode, if no document is detected and the score exceeds this threshold, a new DocumentDetectionStatus value OK_BUT_ALREADY_CROPPED is returned, along with a quad (points) corresponding to the image corners. This feature is supported by all downstream components of the Document Scanner (Check Scanner, Credit Card Scanner, and Document Data Extractor).
  - Added background property to TextButtonMode and TextWithBadgeButtonMode to configure the background style for the preview button in the RTU UI Document Scanner.
  - Added straighteningParameters to PageData to allow storing Document Enhancer configuration in the Page.
  - iOS: Added accessibilityDescriptionDocumentImagePreview property to ReviewScreenConfiguration to configure the accessibility description of the document image preview.
  - DocumentScannerCamera:
    - Added property touchToFocusEnabled to DocumentCameraConfiguration that allows users to focus the camera on a specific area by tapping on the screen.
- Image Processing:
  - New ColorDocumentShadowRemovalFilter capable of removing shadows from documents without damaging text, barcodes, or images.
- Document Quality Analyzer:
  - A new Document Quality Analyzer algorithm was introduced. The result object's quality property can now be ACCEPTABLE, UNACCEPTABLE, or UNCERTAIN, indicating whether a user-provided document image meets the required quality standard. Advanced configuration is available using the qualityAnalysisModel parameter, which allows the Document Quality Analyzer to be fine-tuned for specific use cases using an external script. This capability is currently in closed beta. To request access and obtain the script, sign up here.
  - Added the inputScales property to run the model at multiple resolutions and automatically select the best result.
  - Added the threshold property qualityAcceptableUncertainThreshold for categorizing documents into three classes: ACCEPTABLE, UNACCEPTABLE, and UNCERTAIN.
  - Added the inputScaleThresholdToProcessEntireImage property to run the Document Quality Analyzer on the entire image, even when minProcessedFraction and maxProcessedFraction are not equal to 1 for small input scales.
  - The resulting bestInputScale is now included in the DocumentQualityAnalyzerResult output.
  - Added compatibilityMode property to DocumentQualityAnalyzerConfiguration to allow running the legacy (v8) document quality analysis engine.
- Document Data Extractor:
  - Added support for Romanian, Italian, Turkish, and Polish ID cards.
- Check Scanner:
  - Added support for more USA check formats. Newly supported formats: (TT)xxx(TT)xxxx(UU)xxx(UU), and the ones enumerated in the MICR line identification documentation.
  - Added support for xxx-xxx-x account number format for Canadian checks.
- Barcode Scanner:
  - Added a TwoDDecodingMode to the barcode configuration. It defaults to HIGH_EFFORT and can be set to LOW_EFFORT for very low-power devices requiring higher frame rates.
  - BarcodeScannerCamera:
    - Added property touchToFocusEnabled to BarcodeCameraConfiguration that allows users to focus the camera on a specific area by tapping on the screen.
🚀 Improvements:
- General:
  - Improved memory usage when extracting and processing PDF pages.
  - Enhanced accessibility of the zoom button in the RTU UI Barcode Scanner and Data Capture screens.
  - iOS: The touchToFocusEnabled property in RTU UI scanner configurations, previously supported on Android only, is now supported on iOS.
  - iOS: Optimized still image capturing by switching to the 420YCbCr format internally.
- Document Scanner:
  - Updated document detector models with improved accuracy.
  - Partially visible documents are now supported in all processing modes. Auto and single-shot modes now return the ERROR_PARTIALLY_VISIBLE document status when only 1–3 document corners are visible in the input image and the scanner is configured with allowPartiallyVisibleDocuments = true.
  - Android: Improved the behavior when the page limit was reached in the RTU UI single-page mode.
  - Android: Improved the behavior of the Acknowledge Screen for more precise error hints control.
- Cropping Screen:
  - Android: Added support for navigation on polygon corners with keyboard.
- Document Quality Analyzer:
  - Increased the default threshold for minRequiredOrientationConfidence to 0.9, reducing false positives in orientation estimation.
  - Orientation detection now considers text at any angle, not just within ±10° of 0°, 90°, 180°, or 270°. For orientation estimation, text at any angle is rounded to the nearest multiple of 90° — for example, a 30° angle yields a predicted orientation of 0°.
  - Improved performance on very bright or very dark images.
- OCR Engine:
  - New model with better performance for German diacritics and ß/ẞ recognition.
  - Added support for Turkish, Polish, Italian, and Romanian alphabets.
  - Increased accuracy without increasing inference time.
- VIN Scanner:
  - Live or single-shot mode, derived from the input image, is now propagated to the internal barcode scanner.
- Document Data Extractor:
  - Reduced the likelihood of reading incorrect values for eye color on German ID cards (e.g., GRUN instead of GRÜN).
  - Document types are now classified using an ML model, resulting in higher quality and faster recognition.
  - verifyDocument can be called outside an autorelease pool. The method now manages its own autorelease pool internally, preventing potential memory issues.
- Check Scanner:
  - For Canadian checks, the scanner now allows more whitespace characters in the MICR line.
- Credit Card Scanner:
  - Various improvements to check digit validation and aspect ratio handling.
- Barcode Scanner:
  - Clean barcodes (QR Code, DataMatrix, and all 1D formats) are detected faster in single-shot mode and can be detected without a quiet zone.
  - Significantly improved decoding performance for truncated PDF417 barcodes.
  - Reduced the false positive rate for barcode formats EAN-8, EAN-13, and UPC-A when enableOneDBlurScanner is enabled (now the default).
  - Improved recall and precision for barcode formats EAN-8, EAN-13, UPC-A, and UPC-E when ink spread is present.
  - Data Matrix codes can now be scanned under harsher conditions. With HIGH_EFFORT enabled, scanning works even on curved surfaces or when the code is partially occluded.
  - Reduced the number of false-positive Codabar barcodes when scanning in live mode and the barcode is only partially visible.
🐞 Bug fixes:
- General:
  - Android: Fixed a crash with ImageRef.saveImage when default Android encryption was enabled.
  - Android: Fixed RTU UI top bars behavior with hidden back buttons.
  - Android: Fixed incorrect viewfinder aspect ratio calculations when cameraPreviewMode was set to FIT_IN.
  - iOS: Fixed a crash on iPhone SE when switching to the front camera in the Barcode Scanner or Check Scanner.
  - iOS: Fixed the viewfinder's initial position when launched in landscape orientation in all RTU UI Data Capture screens.
- Document Scanner:
  - Android: Fixed a bug with incorrect page number badge behavior in the RTU UI Document Scanner.
  - Android: Fixed SnapButton click in TalkBack mode in RTU UI scanner screen.
  - Android: Fixed reduced preview image quality when zoomed in on the Review Screen.
  - iOS: Fixed a bug where the CreateDocumentOptions were not properly applied when creating a document from a PDF.
  - iOS: Fixed an iPad layout issue with the RTU UI Acknowledge Screen.
  - iOS: Fixed an issue where the auto-rotation feature would incorrectly rotate certain kinds of images by 180 degrees.
  - iOS: Fixed an issue in the RTU UI Document Scanner where the user could become stuck on the camera screen when the pageCountLimit was set to 1.
- PDF & TIFF Generation:
  - iOS: Fixed an issue where JPEG compression was applied twice to images being rendered to a PDF.
- Document Quality Analyzer:
  - Fixed ProcessByTileConfiguration.enabled being ignored regardless of its value.
- VIN Scanner:
  - iOS: Fixed a bug where the result was not displayed properly in the VIN Scanner RTU UI when confirmationAlertDialogEnabled was enabled.
- Document Data Extractor:
  - Fixed an issue where documents containing Cyrillic text were sometimes classified incorrectly.
- Check Scanner:
  - Fixed missing support for longer check number fields on Canadian checks.
- Barcode Scanner:
  - Fixed an arithmetic exception occurring when processing images with very small heights (lower than 5 px) in single-shot mode.
  - Fixed the orientation of quads for barcode formats DataBar and DataBar Expanded with multiple stacks.
  - Fixed a rare issue with the DataBar barcode format, which could lead to a crash.
  - iOS: Fixed an issue in the RTU UI Barcode Scanner screen where the confirmation alert would reappear upon tapping the submit button while in Find & Pick mode.
⚠️ Breaking changes:
- General:
  - The Scanbot SDK now requires Android Gradle plugin 8.9.1 or higher. Update your AGP version to prevent build errors.
  - All APIs that receive or return normalized coordinates of points assume that normalization is performed by dividing image coordinates by (width - 1, height - 1) instead of (width, height). This ensures that rotation operations that are performed on the normalized coordinates are mathematically correct. Callers that call functions that receive normalized coordinates or process results with normalized points and perform conversion on their own should adjust their implementations.
  - Android: Decreased the Scanbot SDK size by extracting Tesseract logic to a separate optional library io.scanbot:sdk-ocr-tesseract. Add this new dependency to your project to use Tesseract OCR features.
- Document Scanner:
  - Removed AcknowledgementScreenConfiguration.minimumQuality parameter. Use DoQA configuration to change document acceptance levels.
  - Updated the Acknowledge Screen logic in the RTU UI Document Scanner to properly handle document quality scenarios. The unacceptableQuality acknowledgment mode now shows the Acknowledge Screen for "document not found" cases when documentNotFoundWarning.visible is configured to true. This may change the behavior for applications relying on the previous logic where "document not found" cases were always bypassed in unacceptableQuality mode.
  - Improved the button visibility logic on the Acknowledge Screen. The proceed anyway button visibility now correctly considers both the specific button configuration and the global proceedAnywayButton.visible setting. This may affect existing configurations that rely on the previous behavior. By default, when the image is unacceptable, the proceed anyway button is no longer shown unless explicitly configured to be visible (see screens.camera.acknowledgement.bottomBar.proceedAnywayButton.unacceptableQuality).
  - Removed AcknowledgementScreenConfiguration.badImageHint parameter. Use documentNotFoundWarning, uncertainQualityWarning, and unacceptableQualityWarning parameters to control the hints shown in the Acknowledge Screen.
  - Strings were introduced for the Acknowledge Screen in the RTU UI Document Scanner to support the new document quality scenarios. Update custom translations for the Acknowledge Screen to include these strings: proceedAnywayButtonDocumentNotFound, proceedAnywayButtonUnacceptableQuality, proceedAnywayButtonUncertainQuality, acknowledgementWarningDocumentNotFound, acknowledgementWarningUnacceptableQuality, and acknowledgementWarningUncertainQuality.
  - Renamed the style field to title in TextWithBadgeButtonMode and the text field to title in TextButtonMode.
- PDF & TIFF Generation:
  - When adding a PNG file to a PDF, the image is now always re-encoded as JPEG. Previously, this occurred only in specific situations.
- Document Quality Analyzer:
  - The configuration properties qualityThresholds and qualityIndices have been renamed to qualityLevelThresholds and qualityLevelIndices. The renamed properties are now deprecated; use the new qualityAnalysisModel property instead.
  - The detectOrientation option has been removed. Orientation detection now always runs.
  - The inspectSmallText option has been removed.
- Document Data Extractor:
  - When initialized with no accepted document types, or only invalid ones, and with MRZ fallback disabled, an InvalidArgument error is now thrown.
- Check Scanner:
  - Leading and trailing whitespace for all USA check fields is now trimmed.
  - A group of numbers in the Canadian check account number section preceding the first dash is now treated as a designation number only if its length is 4. Previously, a sequence of any length was treated as a designation number. Dashes present in the MICR line are preserved in the Account Number parsed field.
⚠️ Deprecations:
- Document Quality Analyzer:
  - The DocumentQuality enum and result object property are deprecated; use DocumentQualityAssessment instead.
  - The DocumentQualityAnalyzerResult.documentFound property is now deprecated. This deprecated property indicates if too few characters are detected. The new DocumentQualityAssessment will be reported as UNCERTAIN in this situation. If this is not suitable for your use case, consider using the Document Scanner instead to determine if an image contains a document. In the RTU UI Document Scanner, the documentNotFoundWarning case is now based on the Document Scanner output.
  - qualityLevelThresholds and qualityLevelIndices are deprecated (see Breaking changes).
🚙 Under the hood:
- Upgraded the native Scanbot Android SDK to v9.0.1.
- Upgraded the native Scanbot iOS SDK to v9.0.1.
- Updated magic_enum to version 0.9.7.
- Added a new barcode decoding model, increasing SDK size by approximately 650 KB.
- Android: Increased the minimum SDK version to 23. This allows use of more modern APIs and improves overall camera performance.
- Android: Updated the CameraX library to version 1.6.0 for improved camera performance and compatibility. Update to this version to prevent potential crashes on Android 17 devices.
- Android: Added org.jetbrains.kotlinx:kotlinx-coroutines-guava:1.7.3 dependency (a stub library for resolving the CameraX dependency with Guava).
- Android: Improved lifecycle handling with ScanbotCameraX.
- Android: Removed androidx.legacy:legacy-support-v4 and androidx.fragment:fragment-ktx from the Scanbot SDK dependencies.
- Android: Document Scanner RTU UI now includes an additional asset dependency io.scanbot:sdk-document-enhancer-assets by default.

8.0.024 Mar 2026Breaking

Removed ScanbotSdkUiV2 and ScanbotImageOperations classes. Please check the breaking changes below to find corresponding methods.

🎉 New:
- General:
  - The SDK now supports a new license key format, which does not contain special characters or line breaks.
  - The ScanbotSdk class now includes barcode, check, creditCard, document, documentDataExtractor, imageProcessor, legacyPage, mrz, ocrEngine, pdfGenerator, pdfImageExtractor, textPattern, tiffGenerator, and vin properties, providing access to the corresponding features.
  - Introduced the ScanbotPdfImageExtractor object to encapsulate and manage all SDK functionalities related to extracting images from a PDF.
  - Introduced the ScanbotLegacyPage object to encapsulate and manage all SDK functionalities related to the legacy Page object.
  - Added a new class SdkConfiguration to replace the previous ScanbotSdkConfig type for SDK initialization.
  - Added a new class LicenseInfo to replace the previous SdkLicenseStatus type for license information retrieval.
  - Added a new property processingMode to all scanner configuration types to enhance processing flexibility.
  - Added a new property cameraLiveScannerResolution to CameraConfiguration for configuring live scanner resolution in all RTU-UI scanners.
  - Added a new property cameraLiveScannerResolution to BarcodeCameraConfiguration and DocumentCameraConfiguration for classic components (Android only).
  - Added methods toColor and fromColor to ScanbotColor.
  - Added a new callback onError for all classic components that is triggered when an error occurs while using the component.
  - ImageRef now supports HEIC images.
- Document Scanner:
  - Added a new API scanFromImageRef for scanning documents from ImageRef.
  - Added a new API analyzeQualityOnImageRef to analyze quality on ImageRef.
  - Added a new API addPagesFromImageRefs to add new pages from ImageRef.
  - Added a new API createDocumentFromImageRefs to create a document from ImageRef.
  - Updated a result class DocumentScanningResult to provide detailed information about scanning a document from an image.
  - The DocumentDetectionResult now includes displacementVector and displacement properties to indicate the direction towards the center of a partially visible document.
  - Added a new property partiallyVisibleDocumentConfiguration to DocumentScannerConfiguration for better handling of partially visible documents.
  - Added a new property bottomBarMode to CameraConfiguration for customizing the bottom bar appearance in the RTU-UI scanner.
  - Added a new type TextWithBadgeButtonMode for preview mode in the RTU-UI scanner.
  - Two new DocumentDetectionStatus values have been introduced: ERROR_PARTIALLY_VISIBLE and ERROR_PARTIALLY_VISIBLE_TOO_CLOSE.
  - Introduced a DocumentScannerCameraController, which includes a snapDocument({bool acquireFocus = false}) method for the DocumentScannerCamera classic component.
  - The DocumentScannerCamera now has an optional property controller for setting the DocumentScannerCameraController, as well as a onSnappedDocumentResult: (ImageRef originalImage, ImageRef? documentImage, DocumentDetectionResult? detectionResult) async { ... } callback to handle the document snapping event.
  - Legacy Page:
    - Introduced the ScanbotLegacyPage object to encapsulate and manage all SDK functionalities related to legacy pages.
    - Added a new API removeAllPages to remove all legacy pages from the storage.
- Image Processing:
  - Introduced the ScanbotImageProcessor object to encapsulate and manage all SDK functionalities related to image processing.
  - Added new capabilities to resize and crop images.
  - The color document filter now has parameters controlling contrast, color, and paper enhancement.
  - Added a new property colorConversion to CPathImageLoadOptions and CBufferImageLoadOptions for applying color conversion during image loading.
  - Added a new property canvasColor to CPathImageLoadOptions and CBufferImageLoadOptions for setting image conversion when converting images with alpha channel to images without alpha channel.
- PDF Generator:
  - Introduced the ScanbotPdfGenerator object to encapsulate and manage all SDK functionalities related to creating PDF files.
  - Added a new API generateFromImageRefs to create a PDF from ImageRef.
- TIFF Generator:
  - Introduced the ScanbotTiffGenerator object to encapsulate and manage all SDK functionalities related to creating TIFF files.
  - Added a new API generateFromImageRefs to create a TIFF from ImageRef.
- OCR Engine:
  - Introduced the ScanbotOcrEngine object to encapsulate and manage all SDK functionalities related to optical character recognition.
  - Introduced a new API recognizeOnDocument that performs OCR on a provided DocumentData object.
  - Added a new API recognizeOnImageRefs to perform OCR on ImageRef.
- Document Quality Analyzer:
  - Added a new property processByTileConfiguration to DocumentQualityAnalyzerConfiguration to explicitly enable/disable by tile processing.
  - Added cumulativeContrastHistogram and cumulativeTextSizeHistogram properties for text contrast and size estimation in DocumentQualityAnalyzerResult.
  - Added a new property orientationConfidence to DocumentQualityAnalyzerResult.
- MRZ Scanner:
  - Introduced the ScanbotMrz object to encapsulate and manage all SDK functionalities related to scanning MRZ.
  - Added a new API scanFromImageRef for scanning MRZ from ImageRef.
- Text Pattern Scanner:
  - Introduced the ScanbotTextPattern object to encapsulate and manage all SDK functionalities related to text pattern scanning.
  - Added a new property optimizeSingleLine to TextPatternScannerConfiguration. Enable this option when scanning a single line or a single word that is hard to scan reliably. Disabled by default.
- VIN Scanner:
  - Introduced the ScanbotVin object to encapsulate and manage all SDK functionalities related to VIN scanning.
  - Added a new property optimizeSingleLine to VinScannerConfiguration for improved single line VIN scanning.
- Document Data Extractor:
  - Introduced the ScanbotDocumentDataExtractor object to encapsulate and manage all SDK functionalities related to extracting data from documents.
  - Added a new metadata child document to all supported formats.
  - Added a new countryCode property to all supported formats.
  - Added a new type literal PERSONAL_ID in CommonFieldType.
  - Added a new API extractFromImageRef to extract data from ImageRef.
- Check Scanner:
  - Introduced the ScanbotCheck object to encapsulate and manage all SDK functionalities related to check scanning.
  - Support a wider range of USA check formats.
  - Added a new API scanFromImageRef for scanning checks from ImageRef.
- Credit Card Scanner:
  - Introduced the ScanbotCreditCard object to encapsulate and manage all SDK functionalities related to credit card scanning.
  - Added a new API scanFromImageRef for scanning credit cards from ImageRef.
- Barcode Scanner:
  - Introduced the ScanbotBarcode object to encapsulate and manage all SDK functionalities related to barcode scanning.
  - Added a new API scanFromImageRef for scanning barcodes from ImageRef.
  - Added a new API parseDocument for parsing barcode documents from raw text values.
  - Added a new API scanFromPdf for scanning barcodes from PDF documents.
  - New supported document parser for British Columbia driver licenses PDF417 codes.
  - Introduced a new algorithm for recognizing 1D symbologies (except EAN and UPC), enhancing performance with blurred and distant barcodes. This feature is enabled by default but can be turned off using the enableOneDBlurScanner property in barcode format configurations on low-power devices if necessary.
  - Added a new barcode scanner engine mode called NEXT_GEN_MAX_DISTANCE, which is optimized for scanning from far distances on very high-power devices with a 4K video stream.
  - All 1D barcode formats can be configured with a new oneDConfirmationMode which is THOROUGH by default. Setting it to MINIMAL or NONE could lead to higher recall in difficult scenarios, but could also cause more false positives.
  - Introduced a BarcodeScannerCameraController, which includes a takePicture({bool requestFocus = false}) method for the BarcodeScannerCamera classic component.
  - The BarcodeScannerCamera now has an optional property controller for setting the BarcodeScannerCameraController, as well as a onPictureTaken: (ImageRef image) async { ... } callback to handle the picture taking event.
🚀 Improvements:
- General:
  - All APIs can now return more complete errors with error messages.
  - All OCR-based features now benefit from new OCR models that are optimized for speed and accuracy.
  - The "Created TensorFlow Lite XNNPACK delegate for CPU." log is no longer an output in production builds.
  - Classic components now work with the ImageRef class instead of the legacy Page class.
  - Android: Optimized memory usage of Scanbot Camera components.
  - Android: Improved RTU UI components padding behavior for finder view and action bars.
  - iOS: Camera sessions no longer show a black screen in case of license error. Instead, the camera runs but the detection fails with appropriate license error.
  - iOS: Implemented keepScreenOn property for all RTU-UI screens to prevent the system from going idle or entering the lockscreen while scanning.
- Document Scanner:
  - Aspect ratio scores are now symmetrical, and low scores are more consistent.
  - Android: The Document API now returns cached document objects. This means if you load a DocumentData once, it will remain in memory during the app session and be returned when loaded from another location.
  - Android: Fixed an issue with double compression for document images during rotation or filtering operations that significantly increased the size of the original and other PageData images.
- Cropping Screen:
  - iOS: Added support for selecting and moving individual corners in the cropping screen using a hardware keyboard. Press the tab key to cycle through the corner and edge handles. Use the arrow keys to move the selected corner or edge handle. Hold shift while pressing the arrow keys to move faster.
  - iOS: Improved cropping handle movement, preventing irregular polygons and glitches.
- Image Processing:
  - All image processing methods now accept both image file URIs and ImageRef objects as inputs. If working with image file URIs, the ability to overwrite the original image file is now supported via the overwrite parameter.
  - The color document filter now preserves colors better by default.
  - Removed unused image filter models, saving about 2.4MB from binaries.
- PDF Generation:
  - PDF generation now supports binarized images. Binarized images are stored in the PDF with an optimized compression algorithm, resulting in extremely small file sizes.
- Document Quality Analyzer:
  - Improved performance.
  - If provided configuration is invalid, an error will be returned instead of changing invalid fields to default values.
- OCR Engine:
  - Improved detection of text, specifically for lines that are close together.
- Document Data Extractor:
  - Improved FrameAccumulation logic.
  - Increased accuracy, specifically fewer false positives.
  - General speed improvements.
  - Glare detection now works more reliably, especially on iOS.
- Credit Card Scanner:
  - Higher recall for expiry date detection.
  - Improved FrameAccumulation logic.
- Barcode Scanner:
  - Improved quiet zone checks for the barcode format PharmaCode to reduce the false positive rate.
  - Reduced the false positive rate of blurred barcodes in live mode when the barcode is only partially visible.
🐞 Bug fixes:
- General:
  - Android: Fixed issues related to edge-to-edge warnings in Google Play Store for RTU-UI screens.
  - Android: Fixed dependencies clash related to material icons in RTU-UI screens.
- Document Scanner:
  - Now correctly returns ERROR_TOO_DARK when nothing is detected and the image brightness is below the threshold.
  - iOS: Fixed a bug that left a temporary copy of captured images on disk when scanning with the RTU-UI document scanner. These images can be cleaned up using the ScanbotLegacyPage.removeAllPages API. Note that this will remove all legacy pages. If needed, make sure to migrate to the new document objects using the ScanbotDocument.createDocumentFromLegacyPages API before removing all legacy pages.
  - Android: Fixed the title counter update in the review step for the RTU-UI screen.
  - Android: Fix a rare issue with a bug that occurred on Xiaomi that breaks the image import feature.
  - Android: Fixed an issue where the source property had an incorrect value after migrating from the legacy Page object to the new PageData object.
- Document Quality Analyzer:
  - Fixed a bug that could lead to incorrect results. This bug affected documents with text lines that were not strictly vertical or horizontal.
- MRZ Scanner:
  - Fixed a rare crash with inverted text.
  - Fixed an issue with an incorrect birth date being parsed from the MRZ date, when the birth date could be returned from the future.
- VIN Scanner:
  - Fixed a bug when scanning VINs that could have discarded valid results.
- Document Data Extractor:
  - Fixed a rare case where an EHIC card could be returned with an excluded country.
- Credit Card Scanner:
  - An invalid status will now be correctly returned if the frame accumulator confirms a field that is invalid.
- Barcode Scanner:
  - Fixed an issue where the use case could not find UPC and EAN barcodes with extensions in the RTU-UI screen.
  - Fixed a bug in Barcode RTU-UI Multiple Scanning Mode where the count of the sheet button was not updated properly.
⚠️ Breaking changes:
- General:
  - Updated the minimum supported Flutter version to 3.27.0.
  - All async APIs now return a Result object. Check Result API for examples.
  - Removed rtu_ui_barcode.dart, rtu_data_capture.dart, rtu_ui_document.dart, rtu_ui_common.dart, classic_components.dart, core.dart, document_api.dart, scanbot_sdk_ui_v2.dart, and scanbot_sdk_ui.dart imports. All types, constants, and functions previously imported from these paths should now be accessed via scanbot_sdk.dart. Update your imports and usage accordingly.
  - Removed ScanbotSdkUiV2 and ScanbotImageOperations classes. Please check the breaking changes below to find corresponding methods.
  - Removed the ScanbotSdkConfig type. The initialize method now requires an instance of the SdkConfiguration class. Update your initialization code accordingly.
  - Removed SdkLicenseStatus in favor of the new LicenseInfo class. Update your code to use the LicenseInfo class for license information retrieval.
  - Removed the property scanningMode from scanner configurations where processingMode property was added.
  - Replaced type literal IF_AVAILABLE with AUTO in EncryptionMode.
  - Renamed property roi to cropRect in all image load options types for better clarity.
  - Renamed initScanbotSdk to initialize and getLicenseStatus to getLicenseInfo in ScanbotSdk.
  - Renamed extractImagesFromPdf to extractImageFiles in ScanbotPdfImageExtractor. The method signature and result were also changed.
  - Renamed class VCardCategories to VCardCategory.
  - Renamed class VCardLanguages to VCardLanguage.
  - Renamed class OcrOptions to OcrConfiguration.
  - Renamed widget ShutterButton to ShutterButtonView.
  - Removed clone() method from ImageRef.
  - Renamed makeImageRefsSnapshot to makeSnapshot and moved it to ImageRef.
  - Updated mockCamera input parameters: replaced MockCameraParams with String imageFileUri and an optional bool? refreshOnEachFrame parameter
  - Replaced property int rotationTimesCw with ImageRotation imageRotation in CroppingPolygon.
- Feature removal:
  - Removed all RTU-UI v1 scanners and related types. All RTU-UI scanners have been upgraded to RTU-UI v2.
  - Removed the following deprecated legacy Page methods: detectDocument, createPdf, createTiff, createPage, createPageWithImageBytes, rotatePageClockwise, cropAndRotatePage, applyImageFilter, performOcr, and createDocumentFromLegacyPages.
  - Removed the Medical Certificate processing features and all related types.
  - Removed the dedicated EHIC processing APIs and all related types. EHIC cards can now be scanned using Document Data Extractor.
- Document Scanner:
  - In the classic component, errorListener has been replaced with onError callback, which receives a general error object.
  - Renamed documentContourListener to onFrameDetectionResult in DocumentScannerCamera.
  - Renamed snapListener to onSnappedDocumentResult in DocumentScannerCamera. The onSnappedDocumentResult signature has changed to return ImageRef originalImage, ImageRef? documentImage, DocumentDetectionResult? detectionResult.
  - Removed DocumentSnapTrigger. Please check a DocumentScannerCameraController, which includes a snapDocument({bool acquireFocus = false}) method for snapping a document.
  - Renamed startDocumentScanner to startScanner and moved it to ScanbotDocument.
  - Moved the method startCroppingScreen to ScanbotDocument.
  - Renamed detectDocument to scanFromImageFileUri in ScanbotDocument. The method now returns a DocumentScanningResult object instead of DocumentDetectionResult.
  - Renamed createDocument to createDocumentFromImageFileUris in ScanbotDocument. The method signature has changed to accept a list of image file UIRs.
  - Renamed addPage to addPagesFromImageFileUris in ScanbotDocument. The method signature has changed to accept a list of image file URIs.
  - Replaced removePage and removePagesByID methods with removePages in ScanbotDocument.
  - Renamed storedDocumentIDs to getStoredDocumentUuids in ScanbotDocument.
  - Renamed createDocumentFromPDF to createDocumentFromPdf in ScanbotDocument. It now also accepts an optional parameter CreateDocumentOptions? options.
  - Restructured function signatures and parameters in several ScanbotDocument methods for improved usability.
  - Legacy Page:
    - Renamed deletePage to removePage and moved it to ScanbotLegacyPage.
    - Moved analyzeQualityOfDocument to ScanbotLegacyPage.
    - Moved refreshImageUris to ScanbotLegacyPage.
- Image Processing:
  - The ColorDocumentFilter now works slightly differently by default. To get the previous behavior, set paperWhitening=0 and paperWhiteningBias=64.
  - The behavior of the LegacyImageFilter was changed to be a no-op. The class is kept only for migration purposes. It is now required to migrate to the other parametric filters.
  - Renamed getDecryptedDataFromFile to readImageData and moved it to ScanbotImageProcessor.
  - Renamed rotateImage to rotateImageFile and moved it to ScanbotImageProcessor. The method signature and result were also changed.
  - Renamed applyFiltersOnImage to applyFiltersOnImageFile and moved it to ScanbotImageProcessor. The method signature and result were also changed.
- PDF Generator:
  - Renamed createPDFFromImages to generateFromImageFileUris and moved it to the ScanbotPdfGenerator object. The method signature and result were also changed.
  - Renamed createPDFForDocument to generateFromDocument and moved it to the ScanbotPdfGenerator object. The method signature and result were also changed.
  - generateFromImageFileUris and generateFromDocument now return the PDF file URI as a result instead of CreatePDFResult.
- TIFF Generator:
  - Renamed createTIFFFromImages to generateFromImageFileUris and moved it to the ScanbotTiffGenerator object. The method signature and result were also changed.
  - Renamed createTIFFForDocument to generateFromDocument and moved it to the ScanbotTiffGenerator object. The method signature and result were also changed.
  - generateFromImageFileUris and generateFromDocument now return the TIFF file URI as a result instead of WriteTIFFResult.
- Document Quality Analyzer:
  - Renamed analyzeDocumentQuality to analyzeQualityOnImageFileUri and moved it to ScanbotDocument.
- OCR Engine:
  - recognizeOnImageFileUris and recognizeOnDocument methods in ScanbotOcrEngine now return an instance of the PerformOcrResult class instead of the PerformOCRResult type.
- MRZ Scanner:
  - Renamed recognizeMrzOnImage to scanFromImageFileUri and moved it to ScanbotMrz.
  - Renamed startMrzScanner to startScanner and moved it to ScanbotMrz.
- Document Data Extractor:
  - No longer returns crops by default. This can be re-enabled in the configuration.
  - Renamed extractDocumentDataFromImage to extractFromImageFileUri and moved it to ScanbotDocumentDataExtractor.
  - Renamed startDocumentDataExtractor to startExtractorScreen and moved it to ScanbotDocumentDataExtractor.
  - Replaced DocumentDataExtractionStatus type literals SUCCESS, INCOMPLETE_VALIDATION, and ERROR_STILL_FOCUSSING with OK, OK_BUT_INVALID_DOCUMENT, OK_BUT_NOT_CONFIRMED, and SCANNING_IN_PROGRESS_STILL_FOCUSING.
  - Moved the method verifyDocument to ScanbotDocumentDataExtractor. It now only accepts documentParts as a parameter.
- Text Pattern:
  - Renamed startTextPatternScanner to startScanner and moved it to ScanbotTextPattern.
- VIN:
  - Renamed startVINScanner to startScanner and moved it to ScanbotVin.
- Check Scanner:
  - Renamed recognizeCheckOnImage to scanFromImageFileUri and moved it to ScanbotCheck.
  - Renamed startCheckScanner to startScanner and moved it to ScanbotCheck.
- Credit Card Scanner:
  - Renamed recognizeCreditCardOnImage to scanFromImageFileUri in ScanbotCreditCard.
  - Renamed startCreditCardScanner to startScanner and moved it to ScanbotCreditCard.
- Barcode Scanner:
  - In the classic component, errorListener has been replaced with onError callback, which receives a general error object.
  - In the classic component, removed onHeavyOperationProcessing callback.
  - Renamed startBarcodeScanner to startScanner and moved it to ScanbotBarcode.
  - Renamed detectBarcodesOnImage to scanFromImageFileUri and moved it to ScanbotBarcode. It now accepts parameter of type String instead of Uri for imageFileUri.
  - Changed the type of the scannerConfiguration property in BarcodeScannerScreenConfiguration from CommonBarcodeScannerConfiguration to BarcodeScannerConfiguration.
  - Changed barcodeFormats to barcodeFormatConfigurations in BarcodeScannerConfiguration, requiring a new structure for specifying barcode formats.
  - The MICRO_QR_CODE barcode format has been removed from the list of common barcode formats.
🚙 Under the hood:
- Upgraded the native Scanbot Android SDK to v8.0.1.
- Upgraded the native Scanbot iOS SDK to v8.0.4.
- Upgraded libzueci lib dependency to 1.0.1.
- Added snowflake-arctic-embed-xs lib dependency to eadfba3b.
- Android: libittnotify is no longer linked.
- Android: Fixed NoClassDefFoundError: LocalBroadcastManager missing that happened during dependency tree resolving when final app used newer version of androidx dependencies.
- Android: Dropped SharedPreferences usage for the License Key storing.
- Android: The SDK Project has been switched to compileSdk = 36.
- Android: The SDK Project has been switched to AGP 8.10.1.
- Android: The SDK Project has been switched to Kotlin 2.1.21.
- Android: Upgraded Dagger lib dependency to 2.56.2.
- Android: Upgraded Kotlin Standard Library dependency to 2.1.21.

Open source →

7.1.018 Sept 2025Deprecated

Marked startCheckScanner RTU UI v1 as deprecated. Please see the new RTU UI v2 Check Scanner.

🎉 New:
- Document Scanner:
  - Added property showReviewScreenOnStart to DocumentScanningFlow. If enabled, the scanner automatically navigates to the Review Screen when the flow starts.
  - Added property openReviewAfterEachScan to CameraScreenConfiguration. If enabled, the Review Screen is opened after each addition of a new page.
  - Added property showLastPageWhenAdding to ReviewScreenConfiguration. If enabled, the Review Screen will be opened showing the last page.
- VIN Scanner:
  - Introduced a new RTU-UI v2 VIN Scanner.
- Check Scanner:
  - Introduced a new RTU-UI v2 Check Scanner.
- Document Data Extractor:
  - Introduced a new RTU-UI v2 Document Data Extractor.
  - Introduced a Document Verification API including document semantics verification capabilities.
  - Added support for multiple new document types:
    - ID Cards from Brazil, Hong Kong, Macao, and China.
    - Chinese Entry and Exit Permits.
  - Now supports the front side of many more EU driver's licenses.
  - Added partial support for parsing of German addresses. For the respective ID cards, address parsing can be enabled via a new DeAddressParserConfiguration. If the parsing was successful, the parsed address is stored as a child document (similar to MRZ).
  - Returns the issuing series of German ID Cards as part of the returned document as the Series field.
- Barcode Scanner:
  - BarcodeItem has new properties:
    - extendedQuad and extendedQuadNormalized that represent extended quads for 1D barcodes.
    - rawBytesEncodings that contains the precise character encoding information of rawBytes.
    - structuredAppendInfo that contains the messages split across multiple barcodes.
    - globalIndex to identify a barcode across multiple frames.
  - BarcodeScannerUiResult has a new property selectedZoomFactor that contains the value that the user used to scan the barcode.
  - BarcodeScannerConfiguration has a new property accumulationConfig that allows the accumulation of barcodes over multiple frames in live mode.
- General:
  - Added a new analytics API. Subscription to events is now available, and events can be redirected to an external analytics system. See this example.
  - Added a new mock camera API that allows injecting an image to simulate a video stream to the scanner camera session for UI testing. See this example.
  - CameraConfiguration has new properties:
    - fpsLimit to limit the rate of detections per second in normal performance mode.
    - iOS: hardwareButtonsEnabled to enable zooming using the camera control button (iPhone 16 series).
  - Android: Added new property performanceHintApi in ScanbotSdkConfig. If enabled, performance is increased due to increased use of top CPU cores.
🚀 Improvements:
- Document Scanner:
  - Increased performance for Document Scanner algorithms.
  - iOS: Improved landscape-orientation layout of RTU-UI v2 screens.
  - iOS: The zoomed page view in the RTU-UI v2 Review Screen now closes when you finish zooming while being below the minimum zoom value.
  - iOS: Rebalanced the internally used photo capture settings to better match the photo quality prioritization modes. The mode SPEED is now significantly faster, the mode BALANCED is a bit faster, and the mode QUALITY is a bit slower with the best possible image quality.
  - Android: Don't rotate images if they are initially detected as rotated by 180 degrees.
- OCR Engine:
  - Improved performance of the Scanbot OCR engine by improving handling of special characters like umlauts when frame accumulation is used.
- Document Quality Analyzer:
  - Improved performance. Document quality scores may slightly change for the same input images when compared to the previous version of the DoQA.
- MRZ Scanner:
  - On US border crossing permits, the document number is now returned in the correct field.
  - Dates in MRZ now also support parsedData correctly
- Text Pattern Scanner:
  - General speed improvements.
  - Now supports XNNPACK for faster inference
- Document Data Extractor:
  - General speed improvements.
  - Now detects whether a document is in focus and only starts the heavy recognition pipeline when image quality is suitable.
  - Can now detect glare in images. Fields obstructed by glare will be returned with a validation status of OBSTRUCTED.
  - Classification for documents with MRZ is more stable.
  - More consistent usage of common field types.
  - Improved maiden name processing for DePassport and DeIdCard.
  - Now also supports the new German ID card format issued starting 2024.
- Check Scanner:
  - If image cropping is enabled and is successful, check recognition is performed on the crop instead of the original image.
- Credit Card Scanner:
  - Support for credit cards with an expiry date above the card number.
  - Support for credit cards with a name written on two lines.
- Medical Certificate Scanner:
  - Date recognition in Medical Certificate forms is now based on the Scanbot OCR Engine and shows significant quality improvements.
- Barcode Scanner:
  - All Barcode AR overlays are now based on extendedQuads.
  - Boarding pass document parser now supports up to version 8 of the IATA-BCBP standard.
  - vCard document parser was improved.
  - Android: Improved handling of back action with multiple dialogs and bottom sheets.
  - BarcodeScannerCamera: Added support for individual barcode overlay customization via barcodeItemOverlayViewBinder callback.
  - BarcodeScannerCamera: Enhanced onBarcodeTap callback to include a highlighted parameter.
  - BarcodeScannerCamera: loadingText can now be customized when barcodeItemOverlayViewBinder is not null. This parameter is part of the SelectionOverlayScannerConfiguration.
- General:
  - Android: Improved the algorithm of high performance cores computation as the old one didn't work correctly on some devices (e.g. Pixel 9 Pro).
  - Android: Integrated Android Performance Hint Session. This significantly improves multithreading performance for some scanners (e.g. Credit Card Scanner and Barcode Scanner) on devices that support the Hint Session (e.g. Pixel 9 Pro and Samsung S24 Ultra).
  - Android: Added more debug level logging to ScanbotCameraXView events.
🐞 Bug fixes:
- Document Scanner:
  - Fixed a bug in RTU-UI v2 Document Scanner where autorotation was applied if no document was detected.
  - iOS: Fixed an issue on simulators where the shutter button was missing in the RTU-UI Document Scanner.
  - iOS: Fixed a bug in RTU-UI v2 Document Scanner where the document could not be captured in auto snap mode when enabledInAutoSnappingMode was set to false in ShutterButton.
  - Android: Fixed an issue in RTU-UI v2 where the last scanned page's preview would not update on a specific layout configuration.
  - Android: Fixed an issue in RTU-UI v2 where the start of the activity without initializing the Scanbot SDK was leading to an application crash.
  - Android: Fixed insets in RTU-UI v1 for the shutter button when the app is built with target_sdk >= 35.
  - Android: Document Scanner RTU UI v2: fixed the screen behavior on multiple manual snaps in "single page" mode.
  - Android: Document Scanner RTU UI v2: fixed an issue where autofocus failed during the autosnap event.
- PDF Image Extractor:
  - iOS: Fixed wrong orientation of extracted images when the PDF page had a transform applied.
- Document Quality Analyzer:
  - iOS: Fixed quality estimation for rotated images.
- MRZ Scanner:
  - Fixed an issue causing null to be returned as a confidence of empty fields.
  - Android: MRZ Scanner RTU UI v1: fixed kotlin compatibility issue.
- Credit Card Scanner:
  - Returns the correct scanning status if no fields are recognized.
  - Setting the confirmation method to interpolate when scanning credit cards no longer results in unsuccessful recognitions if all data was extracted and verified.
  - iOS: Fixed a crash if document detection was not successful due to an OK_BAD_ASPECT_RATIO status.
  - Android: Fixed an issue where an invalid status was not being returned when the frame accumulator confirmed an invalid field.
- Document Data Extractor:
  - When IssuerNumber is excluded on European health insurance cards, this no longer leads to the IssuerName being incorrectly excluded.
  - MRZ fallback now also works when no accepted document types are selected.
  - Fixed a bug where the INCOMPLETE_VALIDATION status was incorrectly returned in the Document Data Extractor (RTU-UI v2).
- Barcode Scanner:
  - The carrier identifier for MaxiCode mode 3 might be encoded by using different codewords. Now all possible codewords are checked that encode the carrier identifier.
  - vCard document parser now correctly processes the FN key as FormattedName.
  - Android: Fixed an issue where the extractedDocument was not being generated for Gs1Handling DECODE_STRUCTURE and DECODE_FULL.
  - Android: Barcode Scanner RTU UI v2: fixed an issue where the back button navigation did not work.
- Check Scanner:
  - iOS: Fixed a bug where the "no check" dialog was displayed when camera permission was denied in the Check Scanner (RTU-UI v2).
- Storage Crypting:
  - iOS: Fixed data corruption issues in AES encryption/decryption that could result in corrupted or partially corrupted files.
- General:
  - Fix incorrect CANCEL status value in RTU UI scanner's result.
  - Fixed a rare division by zero crash in Credit Card Scanner, Document Data Extractor, and MRZ Scanner.
  - Android: RTU-UI v2: Fixed handling of the back actions for modal dialogs.
  - iOS: Fixed a bug with scanned documents cloning when using per-file encryption.
⚠️ Breaking Changes:
- Barcode Scanner:
  - Modified several properties in the BoardingPass and VCard models.
  - Default value for barcodeItemInfoPosition in ArOverlayGeneralConfiguration is changed to DISABLED.
  - BarcodeScannerCamera: Removed automaticSelectionEnabled property from SelectionOverlayScannerConfiguration.
  - BarcodeScannerCamera: Renamed onBarcodeClicked to onBarcodeTap.
- VIN Scanner:
  - Renamed RTU v1 VinScannerConfiguration to VinScannerScreenConfiguration.
- Check Scanner:
  - Moved acceptedCheckStandards configuration from the function signature into CheckScannerConfiguration object for recognizeCheckOnImage.
- Document Data Extractor:
  - Removed startDocumentDataExtractor RTU UI v1 and all associated types. See the newly added RTU UI v2 startDocumentDataExtractor.
  - By default, only German documents are now enabled for scanning. Previously, all supported documents were enabled.
  - Renamed DeDriverLicenseFrontDocumentType to EuropeanDriverLicenseFrontDocumentType. Associated types/interfaces are also renamed.
  - Renamed DeDriverLicenseBackDocumentType to EuropeanDriverLicenseBackDocumentType. Associated types/interfaces are also renamed.
- General:
  - Removed useCameraX property from ScanbotSdkConfig.
⚠️ Deprecations:
- Marked startCheckScanner RTU UI v1 as deprecated. Please see the new RTU UI v2 Check Scanner.
- Marked startVinScanner RTU UI v1 as deprecated. Please see the new RTU UI v2 VIN Scanner.
🚙 Under the hood:
- Upgraded the native Scanbot iOS SDK to v7.1.2.
- Upgraded the native Scanbot Android SDK to v7.1.1.
- Added flatbuffers 2.0.6.

Open source →

7.0.030 Jun 2025Deprecated

Deprecated ScanbotSdk.createPdf and ScanbotSdk.createTiff in favor of ScanbotDocument.createPDFForDocument and ScanbotDocument.createTIFFForDocument.

🎉 New:
- Document Scanner:
  - Added the ability to auto-rotate the document based on the text orientation detected by the Document Quality Analyzer in Document Scanner RTU-UI v2.
  - Added the ability to show custom images in the Intro Screen for Document Scanner RTU-UI v2.
  - Added a new document detection status OK_BUT_TOO_DARK.
  - RTU-UI v2: changed acceptedSizeScore and acceptedAngleScore range of values from 0..1 to 0..100.
  - RTU-UI v2: Configurable title for the acknowledge screen.
  - RTU-UI v2: Option to suppress auto-cropping on manual snaps (autoCropOnManualSnap in camera config).
  - RTU-UI v2 Cropping Screen: Support for magnetic line color (croppingPolygonMagneticLineColor).
- Image Processing:
  - Images are now represented as references using the ImageRef feature.
  - Added ScanbotSdk.makeSnapshot() API to take a snapshot of the ImageRef pool.
- PDF & TIFF Generation:
  - Introduced advanced generation settings for PDFs and TIFFs.
  - Added extractImagesFromPdf method.
- Document Quality Analyzer:
  - Introduced new API for an advanced on-image scanning configuration: analyzeDocumentQuality(String imageFileUri, DocumentQualityAnalyzerConfiguration config).
  - Can now return the orientation of the document, enabled by DocumentQualityAnalyzerConfiguration.detectOrientation.
  - Optionally possible to returnQualityHeatmap.
- MRZ Scanner:
  - New RTU-UI v2 is now available for MRZ Scanner. See startMRZScanner.
  - Advanced on-image scanning configuration.
  - Added support for non-ICAO conformant machine-readable zones on US border crossing cards.
- Text Pattern Scanner:
  - New RTU-UI v2 is now available for Text Pattern Scanner. See startTextPatternScanner.
  - Introduced PatternContentValidator and DefaultContentValidator for content validation.
- VIN Scanner:
  - Added a new property extractVINFromBarcode in VinScannerConfiguration that allows VIN data extraction from barcodes.
- Document Data Extractor:
  - Advanced on-image scanning configuration.
  - Now supports fallback to extraction of only the MRZ on unsupported documents.
  - Generic document fields now support parsedData attributes for standardized data (ISO 8601 dates, ISO 3166-1 countries, "Male"/"Female" gender).
  - Added support for German driver qualification card.
  - Document field validation now supports two additional statuses: INFERRED and IGNORED.
  - Added possibility of returning cropped document.
  - Field class enhanced with polygonInRoot, confidenceWeight, and image property.
  - Added PLACE_OF_ISSUE to CommonFieldType.
  - Added CARD_ACCESS_NUMBER to CommonFieldType.
- Health Insurance Card Scanner:
  - Advanced on-image scanning configuration.
- Check Scanner:
  - Advanced on-image scanning configuration.
  - Added possibility of returning cropped document.
- Credit Card Scanner:
  - Added new Credit Card Scanner feature with Ready-to-Use UI (RTU-UI v2). See startCreditCardScanner. It can also be used with Scan from Image approach. See recognizeCreditCardOnImage.
- Medical Certificate Scanner:
  - Advanced on-image scanning configuration.
- Barcode Scanner:
  - Added support for barcode types Pharma Code, Pharma Code Two Track and PZN (Pharmazentralnummer).
  - Added support for the HIBC barcode document format.
  - Added support for an advanced on-image scanning configuration for detectBarcodesOnImage call.
  - Added ability to configure common barcode properties via BarcodeFormatCommonConfiguration.
  - Added minimumSizeScore to barcode configurations; barcodes with sizeScore < minimumSizeScore are ignored.
  - Barcode scanning results have been enhanced with more detailed information, including sizeScore. See BarcodeItem.
  - Introduced strictMode for certain barcode configurators (QR_CODE, MICRO_QR_CODE, RMQR_CODE, PDF_417, MICRO_PDF417, and GS1_COMPOSITE) to balance detection rate and false positives.
  - Added the ability to return the barcode image in the resulting object via BarcodeScannerConfiguration.returnBarcodeImage.
  - Added new engine modes: NEXT_GEN_FAR_DISTANCE (optimized for scanning from far distances), NEXT_GEN_LOW_POWER_FAR_DISTANCE (optimized for scanning from far on low-power devices).
  - Added new predefined subsets of barcode formats (1D, 2D, Postal, Pharma, etc.). Old sets removed.
  - Added a flag addAdditionalQuietZone to BarcodeFormatConfigurationBase for Scan from Image.
  - Classic UI: Added new customization properties to SelectionOverlayScannerConfiguration: highlightedPolygonColor, highlightedStrokeColor, highlightedTextColor, highlightedTextContainerColor, and strokeColor for improved barcode overlay appearance.
- Cropped images returned as part of the scanner results are now represented as image references (ImageRef) that can be converted to Uint8List buffer or saved to a path.
- initScanbotSdk now returns a SdkLicenseStatus.
- Added removePagesByID method to ScanbotDocument.
- Introduced ScanbotImageRecognitionOperations class (consolidating ScanbotSdkRecognizeOperations).
- Introduced accessibilityDescription properties for buttons in TopBarConfiguration and ActionBarConfiguration.
- Android: Added a new property keepScreenOn in all RTU-UI v2 scanner screen configurations to keep the device screen awake while scanning.
🚀 Improvements:
- Document Scanner:
  - Added OK_BUT_ORIENTATION_MISMATCH status, returned when screen and document orientations don't match. Can be ignored via configuration.
  - Improved DocumentScannerUserGuidance by providing orientationMismatch as a part of UserGuidanceStates.
  - Improved the Document Scanner RTU-UI v2 acknowledgment's bad image quality hint by adding the ability to present up to 5 lines.
  - Android: Added basic support for landscape mode in RTU-UI v2.
  - Android: The Review Screen zoom button in RTU-UI v2 now allows its text to be hidden.
  - iOS: Improved performance when editing a page in RTU-UI v2 Document Scanner Review Screen.
  - iOS: Improved captured image quality.
  - iOS: Improved the accessibility handling in RTU-UI v2 Document Scanner. Accessibility for the document preview button is now activated only when scanned pages are available.
- Image Processing:
  - New Image Processor preset BinarizationFilterPreset.PRESET_5 for documents with barcodes.
- PDF & TIFF Generation:
  - PDF Generator with OCR layer now handles non-ASCII characters correctly.
- Document Quality Analyzer:
  - Guarantee the same document quality score for 90 degrees rotated images.
- OCR Engine:
  - Simplified OCR API: performOCR(PerformOCRArguments args).
- MRZ Scanner:
  - For pre-2022 Costa Rican passports, ID Number is returned as documentNumber and Sequence Number as personalNumber in MRZ fields.
- Text Pattern Scanner:
  - Improved performance with the same quality.
- VIN Scanner:
  - Validation of VINs implements the full ISO 3779 standard, reducing false positives.
- Document Data Extractor:
  - Higher accuracy for document classification.
  - Digits can no longer be recognized as part of given names or surnames.
  - No longer needs the additional data bundle with OCR languages.
- Barcode Scanner:
  - GS1 Composite codes are now processed faster in Scan from Image mode.
  - By default, Code 93 now includes check digits in the result. To disable this and restore the previous behavior, set stripCheckDigits = true.
  - Improved barcode detection for various barcode types.
  - Significant speed-up in live mode on very large input resolutions.
  - More robust QR code recognition (timing patterns, alignment, artistic QR codes).
  - Improved quiet zone checks for ITF, CODE_11, MSI_PLESSEY, IATA_2_OF_5, INDUSTRIAL_2_OF_5, and CODE_25.
  - Improved the false positive rate for ITF barcodes.
  - Added the option to ignore barcodes that do not decode to one of the accepted document formats for Barcode Scanner RTU-UI v2 (BarcodeScannerConfiguration.onlyAcceptDocuments).
  - Added support for maximumTextLength constraint on CODE_11, CODE_39, CODE_93, CODE_128, and CODABAR barcode formats.
  - Improved performance when scanning four-state postal barcodes.
  - Added new accessibility descriptions for some buttons in BarcodeTextLocalization.
- Improved memory management, logging, and resource deallocation for the Classic UI components.
- Reorganized SDK into modular service-style components: ScanbotDocument, ScanbotImageOperations, ScanbotImageRecognitionOperations, and ScanbotSdk.
- Enhanced consistency across document-related methods with clearer return types.
- Added new accessibility descriptions for the buttons in ActionBarConfiguration.
- The camera permission screen will now appear if camera access is restricted in all RTU-UI screens.
- Android: Proguard rules needed for Scanbot SDK are embedded in the package. There is no need to manually specify them in your project.
- Android: Improved camera resolution selection strategies.
🐞 Bug Fixes:
- Document Scanner:
  - Fixed Document Scanner point sorting.
  - Fixed TIFF generator bug (JPEG-encoded colored TIFFs).
  - Android: Fixed content:// URI handling for PdfGenerator, TiffGenerator and OcrEngine.
  - Android: In Document Scanner RTU-UI v2, PageSnapFeedbackNone() no longer prevents auto-transition to review screen at max pages limit.
  - Android: Document Scanner RTU-UI v2: The horizontal layout camera bar now has a fixed width.
  - Android: Cropping Screen RTU-UI v2 status bar light/dark mode now correctly applied.
  - Android: Cropping Screen RTU-UI v2 now returns result instead of canceling if no changes were made.
  - Android: Fixed Document Scanner polygonColor (not filled by default) RTU-UI v1.
  - Android: Fixed Document Scanner/Finder User Guidance default background for RTU-UI v1.
  - Android: Fixed Document Scanner shutter button default color for RTU-UI v1.
  - Android: RTU-UI v2: Removed accessibility container for user guidance image.
  - iOS: Fixed UI bug in Document Scanner RTU-UI v2 where the bar buttons weren't properly grayed out when disabled.
  - iOS: Fixed UI bug in Document Scanner Classic UI where accepted document's fillColor wasn't removed with autoSnapProgressStrokeColor fillColor.
  - iOS: Fixed a layout bug in the RTU-UI v2 cropping screen's top bar.
  - iOS: Fixed layout when hiding the text of the close button on zooming in RTU-UI v2 Document Scanner.
  - iOS: Fixed a memory leak when dealing with grayscale images.
  - iOS: Fixed a bug in all cropping screens where the magnetic lines were missing.
  - iOS: Fixed an issue in RTU-UI v2 where the introduction screen appeared automatically even when camera access was denied.
- MRZ Scanner:
  - Android: Scanning from still images now correctly returns MrzScannerResult.success as true.
- Document Quality Analyzer:
  - Fixed crash when maxImageSize was 0.
  - Fixed patch size when minFraction was 1.
- Text Pattern Scanner:
  - Fixed incorrect output for Unicode symbols.
- Document Data Extractor:
  - Resolved high peak memory consumption issue.
  - Fixed bug determining validation status when fields excluded.
  - Fixed incorrect handling of Driver License expiry date validation.
  - Fixed merging of maidenName and surname on some German ID cards.
- Check Scanner:
  - Android: Fixed Check Scanner User Guidance default background (was absent) for RTU-UI v1.
- Medical Certificate Scanner:
  - Android: Fixed Medical Certificate Scanner User Guidance default background (was absent) for RTU-UI v1.
- Barcode Scanner:
  - Fixed returned results for all types of UpcEanExtensionBehavior.
  - Fixed checksum for CODE_39 barcode format.
  - Fixed an overflow when decoding MICRO_QR_CODE with wrong bits in numeric mode.
  - Fixed minimumTextLength for ITF barcode format (checked symbols instead of text length).
  - Fixed sorting of quad points for four-state/postal barcode types.
  - Fixed incorrect raw bytes returned for 2D barcode types.
  - In CODE_11 barcodes with 10 data digits, when checksum is enabled and stripCheckDigits is true, scanner now correctly strips both check digits.
  - Classic UI Android: Fixed the resolution strategy for the square preview.
  - Android: FindAndPickScanningMode.sheetContent.barcodeItemImageVisible in RTU-UI v2 now correctly applies visibility.
  - Android: Fixed potential issue during onDestroy when the AR overlay is displayed.
  - iOS: Fixed a bug in Barcode Scanner RTU-UI v2 where the flip camera button was not resetting to the widest available camera.
  - iOS: Fixed a UI bug in Barcode Scanner RTU-UI v2 where the sheet button overlapped the action bar.
  - iOS: Fixed a bug in AR Barcode Scan and Count where the scanner would get stuck if no barcode was detected.
  - iOS: Fixed an issue when scanning Code 93 barcodes with stripCheckDigits = false (default) and the check digit was an extension character.
  - iOS: Fixed a crash in the RTU-UI v2 Barcode Scanner when using FindAndPickScanningMode
- Android: Accessibility content for action buttons in RTU-UI v2 now properly applied.
- Android: In RTU-UI v2, modal dialog no longer appears below status bar.
- Android: Fixed nested views of camera components when readjusting parent view size.
- Android: Fixed screen insets for Android API 35 with forced edge-to-edge mode by opting out for RTU-UI v1 screens.
- iOS: Fixed an issue where quickly stopping and starting the camera session of any scanner screen could lead to a crash or unpredictable behavior.
⚠️ Breaking changes:
- General API structure:
  - ResultWrapper has been removed from all API responses, except those returned by RTU-UI.
  - In ResultWrapper<T>, renamed property value to data.
  - Renamed expirationDate to licenseExpirationDate and status to licenseStatus in SdkLicenseStatus.
  - Renamed enum Status to SdkLicenseStatus with PascalCase values.
  - Removed licenseErrorHandler from ScanbotSdkConfig.
- Feature renaming:
  - Renamed startGenericDocumentRecognizer to startDocumentDataExtractor and related types from GenericDocumentRecognizer to DocumentDataExtractor.
  - Renamed recognizeGenericDocumentOnImage to extractDocumentDataFromImage.
  - Renamed Text Data Scanner (also Generic Text Recognizer) to Text Pattern Scanner.
- Feature removal:
  - Removed RTU-UI v1 APIs: startMrzScanner, startTextDataScanner, startBarcodeScanner, startBatchBarcodeScanner, startLicensePlateScanner and related types. Use corresponding RTU-UI v2 methods.
  - Removed legacy classes: TextDataScanResult, TextDataScanResultField, TextDataScannerConfiguration. Replaced with TextPatternScannerResult and TextPatternScannerConfiguration.
- Configuration object changes:
  - Replaced Barcode Scanner recognizerConfiguration with scannerConfiguration.
  - Renamed DocumentScannerConfiguration to DocumentScannerScreenConfiguration.
  - Renamed BarcodeScannerConfiguration to BarcodeScannerScreenConfiguration.
  - Renamed documentDetectorMode to documentScannerEngineMode in ScanbotSdkConfig.
  - Changed default text values for CameraPermissionScreen styled texts.
  - Renamed CameraConfiguration to BaseCameraConfiguration.
  - Renamed Gs1HandlingMode to Gs1Handling, MSIPlesseyChecksumAlgorithm to MsiPlesseyChecksumAlgorithm.
- Result type changes:
  - startEHICScanner and recognizeHealthInsuranceCardOnImage now return EuropeanHealthInsuranceCardRecognitionResult.
  - startMedicalCertificateScanner and recognizeMedicalCertificateOnImage now return MedicalCertificateScanningResult.
  - startDocumentDataExtractor and extractDocumentDataFromImage now return DocumentDataExtractionResult.
  - startCheckScanner and recognizeCheckOnImage now return CheckScanningResult.
  - startBarcodeScanner (RTU-UI v2) now returns BarcodeScannerUiResult.
  - analyzeQualityOfDocument now returns DocumentQualityAnalyzerResult.
  - startVinScanner now returns VinScannerResult.
  - Removed MrzScanningResult and MrzGenericScanningResult models.
- Data model changes:
  - Removed NONE from CommonFieldType.
  - Renamed all CommonFieldType values to uppercase with underscores.
  - Renamed ValidationStatus to FieldValidationStatus and added INFERRED, IGNORED states.
  - Field.validationStatus default is now FieldValidationStatus.NONE (was null).
- Document Scanner:
  - Removed properties (e.g., acceptedAngleScore) from DocumentScannerCameraConfiguration, moved to DocumentScannerParameters.
  - Renamed detectorMode to engineMode and ignoreBadAspectRatio to ignoreOrientationMismatch in DocumentScannerScreenConfiguration and FinderDocumentScannerConfiguration.
  - Renamed DocumentDetectorMode to DocumentScannerEngineMode and updated the type literals.
- Barcode Scanner:
  - Removed additionalParameters from BarcodeScannerScreenConfiguration and the general BarcodeScannerConfiguration.
  - Classic UI: In BarcodeClassicScannerConfiguration, barcodeFormats changed to barcodeFormatConfigurations.
  - Classic UI: barcodeListener callback parameter is now BarcodeItem[].
- VIN Scanner:
  - Renamed minimumNumberOfRequiredFramesWithEqualRecognitionResult to minimumNumberOfRequiredFramesWithEqualScanningResult in VinScannerConfiguration.
⚠️ Deprecations:
- Deprecated ScanbotSdk.createPdf and ScanbotSdk.createTiff in favor of ScanbotDocument.createPDFForDocument and ScanbotDocument.createTIFFForDocument.
🚙 Under the hood:
- Upgraded the native Scanbot Android SDK to v7.0.2.
- Upgraded the native Scanbot iOS SDK to v7.0.3.
- Added ffi package for native interoperability.
- Upgraded nlohmann::json to 3.11.3.
- Upgraded xsimd to 13.2.
- Upgraded xtl to 0.8.
- Upgraded xtensor to 0.26.0-scanbot.
- Upgraded yaml-cpp to 0.8.
- Upgraded spdlog to 1.15.2.
- Upgraded Boost to 1.88.
- Android: Android Jetpack Compose updated to 1.7.8.
- Android: Updated Compile Sdk to 35.
- Android: Upgrade OpenCV to 4.10.
- Android: Updated androidx.camera:camera-camera2 to 1.4.1 with 16kb page support.

Open source →

6.1.012 Dec 2024Deprecated

Deprecated startDocumentScanner, startFinderDocumentScanner, startCroppingScreen and related configurations and result types. See RTU-UI v2 Document S…

🎉 New:
- Implemented new RTU-UI v2 Document Scanner screen with extended scanning and reviewing capabilities. Added startDocumentScanner and startCroppingScreen APIs that can be imported from package:scanbot_sdk/scanbot_sdk_ui_v2.dart. See full documentation here.
- Implemented new ImageOperations API for creating TIFFs, extracting images from PDFs, generating PDFs, rotating images, and applying filters on images.
- Implemented new Document API to perform document creation and editing.
- Moved all RTU-UI v2 scanners into ScanbotSdkUiV2.
- Added support for German health insurance cards (front side) and European health insurance cards to startGenericDocumentRecognizer and recognizeGenericDocumentOnImage. Added literals DE_HEALTH_INSURANCE_CARD_FRONT and EU_HEALTH_INSURANCE_CARD to GenericDocumentType. Added EuropeanHealthInsuranceCard and DeHealthInsuranceCardFront.
- Added support for new barcode types MAXI_CODE, RMQR_CODE, CODE_11 and CODE_32. Added literals that represent the new barcode types in BarcodeFormat.
- Added a new optional property recognizerParameters of type HealthInsuranceCardRecognizerParameters in HealthInsuranceCardScannerConfiguration to configure live detection parameters.
- Added a new property accessibilityDescription in RoundButton and ButtonConfiguration.
- Added a new property allowEmptySubmission in MultipleScanningMode to allow submission of an empty barcode list in the Multiple Barcodes use case in RTU-UI v2.
- Added new optional properties useIATA2OF5Checksum, useCode11Checksum and australiaPostCustomerFormat in BarcodeScannerConfiguration, BatchBarcodeScannerConfiguration and BarcodeRecognizerConfiguration.
- Added new optional property enableNativeLogging in ScanbotSdkConfig.
- iOS: Added new zoom control slider (controlled by the new camera control button) to all view controllers. Available on all the new iPhone 16 models.
- Android: Added support for 16KB page size (Android 15).
🚀 Improvements:
- Document detector:
  - Improved detection speed and robustness against orientation changes.
  - Improved robustness against picking up random contours.
  - Improved robustness against documents with colored corners, booklets, handheld documents, and cards, documents near edges of tables, and overlapping documents.
- Improved detection of UPC and EAN extensions.
- Added support for Extended Channel Interpretation (ECI) for Datamatrix and Aztec barcodes.
- Improved performance of documentQualityAnalyzer.
- For CODE_128 and ITF, we improved the recognition of barcodes generated by defective thermal printers that do not print certain black bars correctly.
- iOS: Improved sharpness of captured images in documentScanner by tweaking various timing related default values, such as autoSnappingDelay.
- Android: Improved generic document recognition on static images.
🐞 Bug fixes:
- Fixed KANJI mode for QR codes.
- iOS: Fixed a UI issue in the RTU-UI v2 Barcode Scanner FindAndPickScanningModeUseCase that never showed the expected barcodes title, but always the barcode value.
- iOS: Fixed a UI issue in the RTU-UI v2 Barcode Scanner FindAndPickScanningModeUseCase in button sheet mode where the counter badge was not visible.
- iOS: Fixed a UI issue on the RTU-UI v2 Barcode Scanner's sheet screen where the subtitle label was being vertically cut off.
- iOS: Fixed a UI issue on the RTU-UI v2 Barcode Scanner's confirmation sheet in the SingleScanningModeUseCase where the loading indicator was not centered when the loading message was hidden.
- iOS: Fixed a bug in RTU-UI v2 Barcode Scanner where extended barcodes are displayed along with their non-extended versions.
- iOS: Fixed a UI issue in the RTU-UI v2 Barcode Scanner where a title that was too long would cut off the cancel button.
- iOS: Fixed a UI issue in RTU-UI v2 Barcode Scanner's finder where the background color overlapped with the line color.
- iOS: Fixed a crash when zooming with invalid minZoom and maxZoom values.
- iOS: Fixed a bug that did not mirror the front camera as expected.
- Android: Fixed image preprocessing for documentQualityAnalyzer.
- Android: Fixed R8 obfuscation config for SDK logging classes.
- Android: Minor fixes for appearance in RTU-UI v2 Barcode Scanner to make it consistent with its iOS counterpart.
- Android: Fix point sorting in the contour detector.
- Android: Fixed an issue with AR Overlay and barcode mapping in RTU-UI v2 Barcode Scanner, where the mapped image wasn't shown on the AR Overlay until the same barcode appeared in the list below.
⚠️ Breaking Changes:
- Introduced new properties, fileEncryptionPassword and fileEncryptionMode, in ScanbotSdkConfig to replace the encryption parameters.
- Deprecated startDocumentScanner, startFinderDocumentScanner, startCroppingScreen and related configurations and result types. See RTU-UI v2 Document Scanner.
- Removed property codeDensity from BarcodeScannerConfiguration, BatchBarcodeScannerConfiguration and BarcodeRecognizerConfiguration.
- Removed property sharpnessAcceptanceFactor from GenericDocumentRecognizerConfiguration.
- Removed type literals VALIDATE and DECODE and replaced them with VALIDATE_STRUCTURE, DECODE_STRUCTURE, VALIDATE_FULL and DECODE_FULL in Gs1HandlingMode.
- Removed type literals SuccessFound and ErrorTooBlurry and added new ErrorUnknownDocument,ErrorUnacceptableDocument and IncompleteValidation in GenericDocumentRecognitionStatus.
- Removed scanbot_sdk_v2 and moved initialization of sdk into scanbot_sdk.
- Removed EncryptionParameters and encryptionParameters property from ScanbotSdkConfig.
- Removed OK_BARCODE type literal from DetectionStatus.
- Renamed property name engine to engineMode in OcrOptions.
- Changed property name imageFormat to storageImageFormat, and imageQuality to storageImageQuality in ScanbotSdkConfig.
- Changed default values for properties enableCameraButton and closeButton in CameraPermissionScreen.
- Changed default values for properties okButton, cancelButton and actionButton in ScanbotAlertDialog.
- Changed default value for property visible in ArOverlayFindAndPickConfiguration to true for FindAndPickScanningMode.
- ResultWrapper model changes:
  - Added a new OperationStatus enum and an extension method for parsing strings to OperationStatus.
- Document models changes:
  - Added property cardAccessNumber and removed property pin in DeIdCardFront and DeResidencePermitFront models.
  - pseudonym property now returns Field | undefined in DeIdCardBack model.
  - restrictions property now returns Field | undefined in DeDriverLicenseBack model.
  - Replaced m property of type DeDriverLicenseBack.Categories.M with am property of type DeDriverLicenseBack.Categories.AM.
  - Replaced standard and validationStatus fields with validationErrors in the GS1.Element class.
- Android: Changed barcodesRegexFilter behavior in BarcodeRecognizerConfiguration for BarcodeScannerConfiguration config for RTU-UI v2 Barcode Scanner. Barcodes are accepted if the barcode data contains the part that matches the regex.
- Android: Some newly created files, like PDF, TIFF, or temporary images, will have different paths than previously created files.
🚙 Under the hood:
- Upgraded the native Scanbot Android SDK to v6.1.2.
- Upgraded the native Scanbot iOS SDK to v6.1.1.
- Added gs1-syntax-dictionary lib.

Open source →

scanbot_sdk

Release timeline

Releases