Document Scanner changelog – MAUI SDK

tip

For additional details about the API, refer to our API reference documentation.

MAUI - Version 9.0.1 (23 Jul 2026)

• 🐞 Bug fixes:
  • PDF Generation:
    • iOS: Fixed an issue where PDF generation produced an invalid file when the license key did not include the OCR feature, even though no OcrConfiguration was provided.
• 🚙 Under the hood:
  • Updated the .NET bindings to .NET SDK 9.0.1 (see our .NET changelog for more under the hood changes).
  • Upgraded the native Scanbot iOS SDK to v9.0.2.

MAUI - Version 9.0.0 (7 Jul 2026)

• 📖 Release notes:
  • Explore the release highlights and key improvements here.
• 🎉 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.
    • ImageRef: optimize flag added to SaveImage and EncodeImage functions. 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 FitIn mode in RTU UI screens.
  • Document Scanner:
    • Added IScanbotDocumentEnhancer API with StraightenImageAsync method that removes 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 OkButAlreadyCropped 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.
    • Custom UI Component:
      • Android: Added property CameraPreviewAspectRatio to DocumentScannerView to support different preview aspect ratios in FitIn mode.
  • 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 HighEffort and can be set to LowEffort for very low-power devices requiring higher frame rates.
    • Custom UI Component:
      • Added property TouchToFocusEnabled to BarcodeScannerView and BarcodeScanAndCountView that allows users to focus the camera on a specific area by tapping on the screen.
      • Added barcode item mapping functionality for AR overlay, which helps to configure each BarcodeItem individually, based on its OverlayConfiguration configuration. See OverlayPolygonConfiguration.StyleForBarcodeItem and OverlayTextConfiguration.StyleForBarcodeItem in the SelectionOverlayConfiguration class.
• 🚀 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 ErrorPartiallyVisible 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.
    • Custom UI Component:
      • iOS: The TouchToFocusEnabled property in DocumentScannerView, previously supported on Android only, is now supported on iOS.
  • 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.
  • 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 HighEffort 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.
    • Custom UI Component: Optimized the barcode mapping time from native to MAUI objects, improving performance while processing the barcode results.
    • Android: Added RTU UI barcode results mapping on a separate task for improved performance, avoiding UI thread blocking when processing bulk results.
    • Android: Fixed a memory leak in barcode scanning that was causing performance degradation.
• 🐞 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 FitIn.
    • 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.
  • Cropping Screen:
    • Fixed a cancellation issue on the Cropping RTU UI screen.
  • 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.
    • iOS: Fixed a bug where the camera permission screen would not show when the user denied the camera access.
    • Custom UI Component:
      • iOS: Fixed an issue where scanning stopped when a popover controller was presented on top while the scanner was active.
• ⚠️ 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.
    • Removed OcrConfiguration class and updated all affected APIs, including PDF generation and OCR recognition.
    • Android: Removed Tesseract features to decrease the Scanbot SDK size.
  • 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.
  • Image Processing:
    • Replaced the parameterless ColorDocument factory property with a configurable ColorDocument factory method.
  • 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.
  • Barcode Scanner:
    • Custom UI Component: Divided the SelectionOverlayConfiguration class into two classes, OverlayTextConfiguration and OverlayPolygonConfiguration.
• ⚠️ 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:
  • Updated the .NET bindings to .NET SDK 9.0.0 (see our .NET changelog for more under the hood changes).
  • Upgraded the native Scanbot Android SDK to v9.0.1.
  • Upgraded the native Scanbot iOS SDK to v9.0.1.
  • Added a new barcode decoding model, increasing SDK size by approximately 650 KB.
  • Android: Increased the minimum SDK version to API 23 (Android 6.0, Marshmallow). This allows use of more modern APIs and improves overall camera performance. Apps targeting lower SDK versions must update their minSdkVersion to 23 or higher.
  • 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 dependency Xamarin.Google.Guava.
  • Android: Net9: Updated package Xamarin.AndroidX.Activity.Compose from version 1.10.0 to 1.10.1.1.
  • Android: Net9: Updated package Xamarin.AndroidX.Activity.Ktx from version 1.10.0 to 1.10.1.1.
  • Android: Net9: Updated package Xamarin.AndroidX.Collection.Ktx from version 1.4.5.2 to 1.5.0.1.
  • Android: Net9: Updated package Xamarin.AndroidX.Navigation.Compose from version 2.8.7 to 2.8.9.1.
  • Android: Net10: Updated package Xamarin.AndroidX.Activity.Compose from version 1.10.1 to 1.10.1.3.
  • Android: Improved the lifecycle mechanism for the Custom UI Components.
  • 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.

MAUI - Version 8.0.0 (18 Mar 2026)

• 🎉 New:
  • General:
    • Added support for .NET 10 TargetFramework.
    • The SDK now supports a new license key format, which does not contain special characters or line breaks.
    • Introduced IScanbotPdfImageExtractor, a new API for extracting images from a PDF.
    • Added a new class SdkConfiguration to replace the previous ScanbotSdkConfiguration type for SDK initialization.
    • Added a new image input option ImageRef to all the scan from image features and also other APIs accepting image as input. E.g, the Barcode API has changed from DetectBarcodesAsync(PlatformImage image) to ScanFromImageAsync(ImageRef image, ...). Similar updates have been applied to other scanners.
    • Added a configuration option ProcessingMode to optimize processing for either single or multiple images in barcode scanning. See BarcodeScannerScreenConfiguration.ScannerConfiguration.
    • ImageRef now supports HEIC images.
    • iOS: The KeepScreenOn property for all RTU-UI screens now also supports iOS. It prevents the system from going idle or entering the lock screen while scanning.
    • Added property CameraLiveScannerResolution to all the RTU-UI v2 screens to control the camera live scanning resolution. See CameraConfiguration in all the scanner configurations. E.g., DocumentScanningFlow#.Screens.Camera.CameraConfiguration.CameraLiveScannerResolution.
    • Added a new RTU-UI function ForceCloseScannerAsync() to all the available scanners. This function force closes the existing scanning session.
  • Document Scanner:
    • Introduced the IScanbotDocument API that encapsulates and manages all functionalities related to document scanning.
    • Added a new result class DocumentScanningResult to provide detailed information about scanning a document from an image.
    • The DocumentDetectionResult now includes a DisplacementVector and a DocumentDisplacement type 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. See DocumentScanningFlow#.Screens.Camera.BottomBar.BottomBarMode.
    • Added a new type literal TextWithBadgeButtonMode to PreviewButton for preview mode in the RTU-UI scanner.
    • Two new DocumentDetectionStatus values have been introduced: ErrorPartiallyVisible and ErrorPartiallyVisibleTooClose.
    • Classic Component - DocumentScannerView:
      • iOS: Added a new property HardwareButtonEnabled that controls whether the hardware volume buttons and the new hardware camera control button should snap or not. See DocumentScannerView.
      • Added a new property DetectDocumentAfterSnap that allows enabling/disabling document detection after snapping a document. Useful when captured image is required before detection(crop) is performed.
      • Added a new OnDocumentScanningError callback to handle errors, providing more detailed error information for better debugging and user feedback.
  • Image Processing:
    • Introduced the IScanbotImageProcessor API that encapsulates and manages all 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 PathImageLoadOptions and BufferImageLoadOptions for applying color conversion during image loading.
    • Added a new property CanvasColor to PathImageLoadOptions and BufferImageLoadOptions for setting image conversion when converting images with alpha channel to images without alpha channel.
    • Now accepts inputs of type ImageRef.
  • PDF Generator:
    • Introduced the IScanbotPdfGenerator API that encapsulates and manages all functionalities related to creating PDF files.
  • TIFF Generator:
    • Introduced the IScanbotTiffGenerator API that encapsulates and manages all functionalities related to creating TIFF files.
  • OCR Engine:
    • Introduced the IScanbotOcrEngine API that encapsulates and manages all functionalities related to optical character recognition.
    • Introduced a new API RecognizeOnDocumentAsync that performs OCR on a provided IScannedDocument object retrieved from a document id.
    • Added a new class PerformOcrResult to replace the previous OcrResult type for OCR results.
    • Now accepts inputs of type ImageRef and ImageSource.
  • 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 the OrientationConfidence property to DocumentQualityAnalyzerResult.
    • Now accepts inputs of type ImageRef and ImageSource.
  • MRZ Scanner:
    • Introduced the IScanbotMrz API that encapsulates and manages all functionalities related to scanning MRZ.
  • Text Pattern Scanner:
    • Introduced the IScanbotTextPattern API that encapsulates and manages all 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 IScanbotVin API that encapsulates and manages all functionalities related to VIN scanning.
    • Added a new property OptimizeSingleLine to VinScannerConfiguration for improved single line VIN scanning.
  • Document Data Extractor:
    • Introduced the IScanbotDocumentDataExtractor API that encapsulates and manages all 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 PersonalId in CommonFieldType.
  • Check Scanner:
    • Introduced the IScanbotCheck API that encapsulates and manages all functionalities related to check scanning.
    • Support a wider range of USA check formats.
  • Credit Card Scanner:
    • Introduced the IScanbotCreditCard API that encapsulates and manages all functionalities related to credit card scanning.
  • Barcode Scanner:
    • Added a new API IScanbotBarcode.ParseDocumentAsync(...) for parsing barcode documents from raw text values.
    • Added a new API IScanbotBarcode.ScanFromPdfAsync(...) 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 NextGenMaxDistance, which is optimized for scanning from far distances on very high-power devices with a 4K video stream.
    • Barcode configurations for 1D barcode types have a new field MinimumNumberOfRequiredFramesWithEqualRecognitionResult that requires this number of frames on which the barcode has to be detected. See BarcodeFormatCommonOneDConfiguration.
    • All 1D barcode formats can be configured with a new OneDConfirmationMode which is OneDConfirmationMode.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 the new Result wrapper for all the existing APIs. See Result and Result<T>. This improves handling not only successful results, but all errors thrown internally during the process.
    • Classic Component - BarcodeScannerView and BarcodeScanAndCountView:
      • Added a new function OnBarcodeScanningError that passes the error occurred while scanning, to provide more detailed error information for better debugging and user feedback.. See BarcodeScannerView.OnBarcodeScanningError().
      • Added 2 new properties KeepScreenOn and FpsLimit.
• 🚀 Improvements:
  • General:
    • All APIs can now return more complete errors with error messages.
    • The new Result and Result<T> wrapper classes now return more complete errors (as Exception objects) caught from the APIs.
    • 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.
    • When creating an ImageRef from a .png file containing an alpha channel, they are blended with a user specified canvas color instead of simply discarding the alpha channel. It is possible to select whether to use a White or Black background in BasicImageLoadOptions, RawImageLoadOptions, PathImageLoadOptions, and BufferImageLoadOptions.
    • ImageRef: If a global or custom encrypter is set when an image is created from a file, it will be automatically detected if the image is encrypted or not. Note that now EncryptionMode is NOT ignored if a custom encrypter/decrypter is used.
    • 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.
    • Android: Optimized memory usage of Scanbot Camera components.
    • Android: Improved RTU UI components padding behavior for finder view and action bars.
  • Document Scanner:
    • Added/moved a few Document related CRUD operations to IScanbotDocument from IScannedDocument and IScanbotOperations:
      • CreateDocumentFromImagesAsync(...)
      • CreateDocumentFromPdfAsync(...)
      • CreateDocumentFromLegacyPagesAsync(...)
      • StoredDocumentUuids(...)
      • DocumentExists(...)
      • StoredDocumentUuids(...)
      • DeleteAllDocumentsAsync(...)
      • DeleteDocumentAsync(...)
    • Aspect ratio scores are now symmetrical, and low scores are more consistent.
  • 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:
    • The color document filter now preserves colors better by default.
    • Removed unused image filter models, saving about 2+ MB from binaries.
    • Added extension to convert ImageRef to ImageSource and vice-versa.
  • 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.
    • Also accepts Document Identifier to create a PDF by retrieving the document.
    • Accepts a list of ImageRef and ImageSource inputs.
  • TIFF Generation:
    • Also accepts Document Identifier to create a TIFF by retrieving the document.
    • Accepts a list of ImageRef and ImageSource inputs.
  • 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:
    • Also accepts Document Identifier to perform OCR by retrieving the document.
    • Accepts a list of ImageRef and ImageSource inputs.
    • 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:
    • ImageRef: If ImageRef was saved to an already existing location, in some cases it could return an error instead of overwriting the existing file.
    • ImageRef: Fixed possibility of ImageRef to be saved as an invalid JPEG (when only part of the image was actually saved).
    • 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.
    • 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 IScannedDocument.IPage images.
  • Document Scanner:
    • Now correctly returns ErrorTooDark 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 IScanbotDocument.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 birthdate being parsed from the MRZ date, when the birthdate 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 bug which prevented the recognition of mixed letters in the address field of some ID cards.
    • Speed up verification of DeResidencePermitFront by using interpolation-verification for the "Remarks" field.
    • 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:
    • iOS: Fixed a bug in Barcode RTU-UI v2 Multiple Scanning Mode where the count of the sheet button was not updated properly.
    • Android: Fixed an issue where the use case could not find Upc and Ean barcodes with extensions in the RTU-UI screen.
• ⚠️ Breaking changes:
  • General:
    • Removed support for .NET 8 TargetFramework. Now the SDK supports .NET 9 and .NET 10 TargetFrameworks.
    • SDK initialization process:
      • Removed SBSDKInitializer class that was used for Initializing the SDK. Please use ScanbotSDKMain.Initialize(...) instead.
      • Renamed the SBSDKConfiguration class to SdkConfiguration. Used while initializing the Scanbot SDK.
      • The licenseKey parameter was moved from the Initialize(...) method to the SdkConfiguration class.
      • Another overload of Initialize(MauiAppBuilder builder, string licenseKey, SBSDKConfiguration configuration) has been replaced by Initialize(SdkConfiguration configuration, MauiAppBuilder builder).
    • API Updates:
      • Removed ScanbotSDKMain.CommonOperations, ScanbotSDKMain.Rtu, and ScanbotSDKMain.Detector. Moved the features to a flat hierarchy, i.e., directly under ScanbotSDKMain.
        • Additionally, The Detector and Rtu features are merged into a Single API per scanner. Some document specific features are also moved inside IScanbotDocument. E.g., AnalyzeQualityOnImageAsync(..).
        • Removed ScanbotSDKMain.CommonOperations.Analytics API instance and added the analytics function directly to ScanbotSDKMain.SetAnalyticsSubscriber(...);
      • Renamed all the RTU UI APIs from LaunchAsync(...) to StartScannerAsync(...).
      • Renamed all the Detect#ScannerName#Async(...) to ScanFromImageAsync(...).
      • All the APIs accepting PlatformImage input are replaced by ImageSource.
        • Though you can still use PlatformImage native representation to easily create an ImageRef. Please see ImageRef.FromNative(...). ImageRef is Scanbot SDKs class for efficiently handling and managing Images.
    • Mock Camera:
      • Moved ScanbotSDKMain.CommonOperations.ConfigureMockCamera(...) to ScanbotSDKMain.MockCamera(...).
      • Updated the method signature of ConfigureMockCamera(MockCameraConfiguration configuration) to Result MockCamera(string imageFileUri, string captureFileUri = null, bool refreshOnEachFrame = false).
    • Result wrapper for all the RTU UI scanners is updated to a new structure for handling the results, that provides an Exception object when errors occur during the operation.
    • All the operations are wrapped under the new Result wrapper. See ScanbotSDK.MAUI.Common.Result and ScanbotSDK.MAUI.Common.Result<T>.
    • Removed Clone() method from ImageRef.
    • Removed ImageRefProfiler class. Moved the make snapshot method to ImageRef class.
  • Feature removal:
    • Removed all RTU-UI v1 scanners and related types. All RTU-UI scanners have been upgraded to RTU-UI v2.
    • Removed the deprecated legacy IScannedPage APIs: SetFilterAsync(...), GetFilteredDocumentPreviewAsync(...), ResizeAsync(...), RotateAsync(...), and DetectDocumentAsync(...).
    • 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:
    • Removed IDocumentDetector, ICroppingScreen, and IDocumentScanner interfaces and moved all the APIs to a single IScanbotDocument API.
    • All the Legacy IScannedPage accessing APIs are moved from IScanbotOperations to IScanbotLegacyPage. See ScanbotSDKMain.LegacyPage.
    • All the related IScannedDocument and IPage APIs with identifier type Guid are replaced with type string.
    • Classic Component - DocumentScannerView:
      • Renamed the events OnSnappedDocumentImageResult and OnUpdateDetectionStatus to OnSnappedDocumentResult and OnFrameDetectionResult. Similarly renamed the custom EventAgs for both the events to match with the event name.
  • Image Processing:
    • Moved all the Image processing APIs from ScanbotSDKMain.CommonOperations to a new dedicated API IScanbotImageProcessor.
    • All APIs now accept ImageRef instead of PlatformImage. Note: You may also create ImageRef from Native as well as ImageSource object.
    • ImageRef: Replaced type literal IfAvailable with Auto in EncryptionMode enum.
    • ImageRef: Renamed Roi to CropRect in PathImageLoadOptions, RawImageLoadOptions, BufferImageLoadOptions, and BasicImageLoadOptions.
  • PDF Generator:
    • Moved all the PDF APIs from ScanbotSDKMain.CommonOperations to a new dedicated API IScanbotPdfGenerator.
    • PDF generation now accepts a list of ImageSource and ImageRef inputs. Previously, only FileImageSource was supported.
  • TIFF Generator:
    • Moved the TIFF API from ScanbotSDKMain.CommonOperations to a new dedicated API IScanbotTiffGenerator.
    • TIFF generation now accepts a list of ImageSource and ImageRef inputs. Previously, only FileImageSource was supported.
  • OCR Engine:
    • Moved the OCR API from ScanbotSDKMain.CommonOperations to a new dedicated API IScanbotOcrEngine.
    • OCR generation now accepts a list of ImageSource and ImageRef inputs. Previously, only FileImageSource was supported.
  • Document Quality Analyzer:
    • Moved the API from ScanbotSDKMain.CommonOperations to IScanbotDocument.
    • Now accepts ImageRef and ImageSource instead of PlatformImage.
  • MRZ Scanner:
    • Removed IMrzDetector and IMrzScanner interfaces and moved all the APIs to a single IScanbotMrz API.
    • Now accepts ImageRef and ImageSource instead of PlatformImage.
  • Text Pattern Scanner:
    • Renamed ITextPatternScanner to IScanbotTextPattern API.
  • VIN Scanner:
    • Renamed IVinScanner to IScanbotVin API.
  • Document Data Extractor:
    • Removed IDocumentDataExtractor and IDocumentDataDetector interfaces and moved all the APIs to a single IScanbotDocumentDataExtractor API.
    • Updated the namespace from ScanbotSDK.MAUI.DocumentDataExtractor to ScanbotSDK.MAUI.DocumentData.
    • The ScanFromImage accepts ImageRef and ImageSource instead of PlatformImage.
  • Check Scanner:
    • Removed ICheckDetector and ICheckScanner interfaces and moved all the APIs to a single IScanbotCheck API.
    • Now accepts ImageRef and ImageSource instead of PlatformImage.
  • Credit Card Scanner:
    • Removed ICreditCardDetector and ICreditCardScanner interfaces and moved all the APIs to a single IScanbotCreditCard API.
    • Now accepts ImageRef and ImageSource instead of PlatformImage.
  • Barcode Scanner:
    • Renamed IBarcodeScanner to IScanbotBarcode and the API object from ScanbotSDKMain.BarcodeScanner to ScanbotSDKMain.Barcode.
    • Changed the type of the ScannerConfiguration property in BarcodeScannerScreenConfiguration from CommonBarcodeScannerConfiguration to BarcodeScannerConfiguration.
    • The MicroQr barcode format has been removed from the list of common barcode formats.
• 🚙 Under the hood:
  • Updated the .NET bindings to .NET SDK 8.0.0 (see our NET changelog for more under the hood changes).
  • Upgraded the native Scanbot iOS SDK to v8.0.4 and Android SDK to v8.0.1.
  • 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.

MAUI - Version 7.1.1 (29 Oct 2025)

• 🎉 New:
  • Barcode Scanner:
    • Barcode configurations for 1D barcode types have a new field MinimumNumberOfRequiredFramesWithEqualRecognitionResult that requires this number of frames on which the barcode has to be detected.
  • Check Scanner:
    • We now extract the field after the account number on US checks. The name in the result is CheckNumber. Note that this name is only based on common usage and not on any enforced standard.
• 🚀 Improvements:
  • Check Scanner:
    • Updated the documentation for US check field.
    • Improved the handling of scanning results when the detection mode DetectAndCropDocument is set.
• 🐞 Bug fixes:
  • Document Scanner:
    • iOS: Fixed a bug in RTU-UI that did not always crop images from the photo library.
    • Android: Fixed an issue with an empty DocumentQuality when AcknowledgementMode was set to BadQuality.
    • Android: Fixed a bug where the usage guidance wouldn't display properly on screen startup.
    • Android: Fixed the image size on the review screen when in horizontal layout.
  • Check Scanner:
    • Fixed a bug in the implementation of the US check standard which lead to rejection of valid checks.
  • General:
    • iOS: Fixed a bug in the RTU-UI that prevented the proper display of the view finder in landscape mode.
    • Android: Fixed 16 KB page size support for the TFLite native library.
    • Android: Fixed an issue where PdfUri was returned instead of TiffUri in ScannedDocument.CreateTiffAsync(...).
• ⚠️ Breaking changes:
  • Barcode Scanner:
    • The field MinConfirmationsStandaloneEAN in BarcodeAccumulationConfiguration was moved and renamed to the field MinimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless in BarcodeFormatUpcEanConfiguration.
• 🚙 Under the hood:
  • Updated ScanbotSDK.NET to 7.1.1.
  • Updated the native Android SDK to Android Document SDK 7.1.2.
  • Updated the native iOS SDK to iOS Document SDK 7.1.4.

MAUI - Version 7.1.0 (11 Sep 2025)

• 🎉 New:
  • Document Scanner:
    • RTU-UI v2: Added an auto-rotate document option. The document will now be automatically rotated based on the text orientation detected by the Document Quality Analyzer. See CameraScreenConfiguration.AutoRotateImages (objDocumentScanningFlow.Screens.Camera.AutoRotateImages). Enabled by default.
    • Classic Component: Added new DocumentScannerView classic component.
    • Introduced advanced generation settings for PDFs and TIFFs.
    • Added a new document detection status OkButTooDark.
    • Added the ability to show custom images in the Intro Screen for Document Scanner RTU-UI v2.
    • RTU-UI v2: Added parameter DocumentScanningFlow.ShowReviewScreenOnStart that allows showing the Review Screen immediately if the scanner is opened with an existent document ID. E.g. document edit mode.
    • RTU-UI v2: Added an option to automatically navigate to the Review Screen after each scan. Use DocumentScanningFlow.Screens.Camera.OpenReviewAfterEachScan = true.
    • RTU-UI v2: Added an option to open either the first or the last page when the Review Screen is opened. Use DocumentScanningFlow.Screens.Review.ShowLastPageWhenAdding = true.
  • Document Quality Analyzer (DoQA):
    • Can now return the orientation of the document. Enabled by DocumentQualityAnalyzerConfiguration.DetectOrientation.
    • Optionally returns a QualityHeatmap property in the result.
    • Added support for an advanced on-image scanning configuration ScanbotSDKMain.CommonOperations.DetectDocumentQualityAsync(...) call.
  • Credit Card Scanner:
    • Added new Credit Card Scanner feature with Ready-to-Use UI (RTU-UI v2). See ScanbotSDKMain.Rtu.CreditCard.LaunchAsync(...).
    • It can also be used with Scan from Image approach. See ScanbotSDKMain.Detector.CreditCard.DetectOnImageAsync(...).
  • MRZ Scanner:
    • New RTU-UI v2 is now available for MRZ Scanner. See ScanbotSDKMain.Rtu.MrzScanner.LaunchAsync(...).
    • 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 ScanbotSDKMain.Rtu.TextPatternScanner.LaunchAsync(...).
  • Check Scanner:
    • New RTU-UI v2 is now available for Check Scanner. See ScanbotSDKMain.Rtu.CheckScanner.LaunchAsync(...). For legacy scanner, check the breaking changes.
  • VIN Scanner:
    • New RTU-UI v2 is now available for VIN Scanner. See ScanbotSDKMain.Rtu.VinScanner.LaunchAsync(...). For legacy scanner, check the breaking changes.
    • Added a new property ExtractVINFromBarcode in VinScannerConfiguration that allows VIN data extraction from barcodes.
  • Document Data Extractor (DDE) (formerly Generic Document Recognizer):
    • New RTU-UI v2 is now available for DDE Scanner. See ScanbotSDKMain.Rtu.DocumentDataExtractor.LaunchAsync(...).
    • Now supports fallback to extraction of only the MRZ on unsupported documents.
    • Added support for German driver qualification card.
    • Document field validation now supports two additional statuses: Inferred and Ignored.
    • Generic document fields now support ParsedData attributes for standardized data (ISO 8601 dates, ISO 3166-1 countries, "Male"/"Female" gender).
    • Added support for multiple new document types:
      • ID Cards from Brazil, Hong Kong, Macao, and China.
      • Chinese Entry and Exit Permits.
    • Returns the issuing series of German ID Cards as part of the returned document as the Series field.
    • Now supports the front side of many more EU driver's licenses.
    • Partial support for parsing of German addresses. For respective ID cards, address parsing can be enabled via a new DeAddressParserConfiguration. Parsed addresses are stored as child documents.
  • 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 ScanbotSDKMain.Detector.Barcode.DetectBarcodesAsync(...) call.
    • Added support for an advanced scanning configuration for BarcodeScannerView classic component.
    • Added ability to configure common barcode properties via BarcodeFormatCommonConfiguration.
    • Added MinimumSizeScore to barcode configurations; barcodes with SizeScore < MinimumSizeScore are ignored.
    • Introduced StrictMode for certain barcode configurators (QR Code, Micro QR Code, rMQR Code, PDF417, MicroPDF417 and gs1Composite) to balance detection rate and false positives.
    • Classic Component: Added new properties, OnlyAcceptDocuments, EngineMode, ExtractedDocumentFormats and BarcodeFormatConfigurations in BarcodeScannerView and BarcodeScanAndCountView.
    • Added the ability to return the barcode image in the resulting object via BarcodeScannerConfiguration.ReturnBarcodeImage.
    • Introduced new barcode engine modes NextGen, NextGenLowPower, NextGenFarDistance and NextGenLowPowerFarDistance. See BarcodeScannerEngineMode.
      • NextGen is optimized for detecting multiple barcodes in live mode, in particular, bounding boxes of 1D barcodes are predicted as close as possible.
      • NextGenLowPower is optimized for scanning barcode batches on low-power devices.
      • NextGenFarDistance which is optimized for scanning from far distances.
      • NextGenLowPowerFarDistance that is optimized for scanning barcodes from far distances on low-power devices.
    • Barcode scanning results have been enhanced with more detailed information, including SizeScore. See BarcodeItem.
    • Added new predefined subsets of barcode formats (1D, 2D, Postal, Pharma, etc.). Old sets removed.
    • Android: CloseAsync() also supported on Android platform. See ScanbotSDKMain.Rtu.BarcodeScanner.CloseAsync().
    • Added ExtendedQuad and ExtendedQuadNormalized fields to the BarcodeItem class to represent extended quads for 1D barcodes.
    • BarcodeItem has a new field RawBytesEncodings that contains the precise character encoding information of RawBytes.
    • BarcodeItem has a new field StructuredAppendInfo for messages split across multiple barcodes.
    • BarcodeScannerConfiguration has a new field AccumulationConfig which allows the accumulation of barcodes over multiple frames in live mode. BarcodeItem has a new field GlobalIndex to identify a barcode across multiple frames.
    • RTU-UI v2: Added SelectedZoomFactor: Double metadata field in BarcodeScannerUiResult with the value that the user used to scan the barcode.
  • General:
    • .NET: Added support for .NET 9 SDK, in addition to .NET 8 SDK.
    • .NET: Added target frameworks .net8.0 and .net9.0 specifically.
    • Added support for an advanced on-image scanning configuration for below ScanbotSDKMain.Detector.<Scanner>.DetectOnImageAsync(...)
      • DocumentDataExtractor.DetectOnImageAsync(...)
      • Ehic.DetectOnImageAsync(...)
      • MedicalCertificate.DetectOnImageAsync(...)
      • Mrz.DetectOnImageAsync(...)
      • Check.DetectOnImageAsync(...)
      • CreditCard.DetectOnImageAsync(...)
    • Added analytics support for tracking and managing the SDK usage analytics. Please see ScanbotSDKMain.CommonOperations.Analytics service.
    • Cropped images returned as part of the scanner results are now represented as image references ImageRef that can be converted to base64 or saved to a path.
    • Added exported array constants for union type values to clearly list all available options. See BarcodeFormats.
    • Android: Added support for 16KB page size.
    • 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:
    • Improved the Document Scanner RTU-UI v2 acknowledgment's bad image quality hint by adding the ability to present up to 5 lines.
    • Increased performance for Document Scanner algorithms.
    • iOS: Improved performance when editing a page in RTU-UI v2 Document Scanner Review Screen.
    • 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.
    • iOS: RTU-UI v2: The ScannedDocument.Page.AddPage() function now has the ability to also detect the document while adding a new PlatformImage(as ScannedPage).
    • 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.
  • Document Quality Analyzer (DoQA):
    • Guarantee the same document quality score for 90 degrees rotated images.
    • Speed improvements. Note: document quality scores may slightly change for the same input images when compared to the previous version of the DoQA.
  • OCR Engine:
    • Improved handling of special characters like umlauts when frame accumulation is used.
  • Image Processing:
    • New Image Processor preset BinarizationFilterPreset.Preset5 for documents with barcodes.
  • PDF & TIFF Generation:
    • PDF Generator with OCR layer now handles non-ASCII characters correctly.
  • MRZ Scanner:
    • For pre-2022 Costa Rican passports, ID Number is returned as DocumentNumber and Sequence Number as PersonalNumber in MRZ fields.
    • 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:
    • Improved performance with the same quality.
    • Now supports XNNPACK for faster inference.
  • VIN Scanner:
    • Validation of VINs implements the full ISO 3779 standard, reducing false positives.
  • Check Scanner:
    • If image cropping is enabled and is successful, check recognition is performed on the crop instead of the original image.
  • Medical Certificate Scanner:
    • Date recognition in Medical Certificate forms is now based on the Scanbot OCR Engine and shows significant quality improvements.
  • Document Data Extractor (DDE):
    • Digits can no longer be recognized as part of given names or surnames.
    • Higher accuracy for document classification.
    • 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.
    • Added normalization before date recognition.
    • 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.
  • Barcode Scanner:
    • By default, Code 93 now includes check digits in the result. To disable this and restore the previous behavior, set StripCheckDigits = true.
    • Significant speed-up in live mode on very large input resolutions.
    • Improved barcode detection for various barcode types.
    • GS1 Composite codes are now processed faster when scanned from image.
    • More robust QR code recognition (timing patterns, alignment, artistic QR codes).
    • QR codes with non-square finder patterns and embedded in adversarial backgrounds can now be recognized.
    • 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.
    • Android: All Barcode AR overlays are now based on ExtendedQuads.
    • Android: Improved handling of back action with multiple dialogs and bottom sheets.
    • iOS - Classic Component: - Further improvements in memory management.
• 🐞 Bug Fixes:
  • Document Scanner:
    • RTU-UI v2: Fixed a memory leak issue from the Document Scanner when closing the scanner.
    • iOS: Fixed UI bug in Document Scanner RTU-UI v2 where the bar buttons weren't properly grayed out when disabled.
    • iOS: Fixed processing of still images of an indexed color space model in all scanners, DoQA, and PDF/TIFF generators.
    • iOS: Fixed an issue on simulators where the shutter button was missing in the RTU-UI Document Scanner.
    • Android: Cropping View: Fixed an issue with a broken layout after screen rotation without recreating the view.
    • Android: Fixed Document Scanner point sorting.
    • Android: Clamped parametric filters radius to 127.
    • Android: RTU-UI v2: Fixed an issue where the last scanned page's preview would not update on a specific layout configuration.
    • Android: RTU-UI v2: Fixed an issue where the start of the activity without initializing the Scanbot SDK was leading to an application crash.
    • Android: RTU-UI v1: Fixed insets for the shutter button when the app is built with target_sdk >= 35.
    • Android: In Document Scanner RTU-UI v2, PageSnapFeedbackNone() no longer prevents auto-transition to review screen at max pages limit.
    • Android: Removed accessibility container for user guidance image in Document Scanner RTU-UI v2.
    • Android: Fixed Document Scanner FillPolygonColor (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: 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: 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.
  • Document Data Extractor (DDE):(previously Generic Document Recognizer)
    • Fixed DDE bug determining validation status when fields excluded.
    • Fixed DDE bug for incorrect handling of Driver License expiry date validation.
    • Fixed DDE bug for merging of MaidenName and Surname on some German ID cards.
    • Resolved DDE high peak memory consumption issue.
  • Document Quality Analyzer (DoQA):
    • Fixed DoQA crash when MaxImageSize was 0.
    • Fixed DoQA patch size when MinFraction = 1.
  • Text Pattern Scanner:
    • Fixed Text Pattern Scanner incorrect output for Unicode symbols.
  • 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.
    • In Code 11 barcodes with 10 data digits, when Checksum is enabled and StripCheckDigits is true, scanner now correctly strips both check digits.
    • Classic Component: Fixed the OverlayConfiguration property not updating while barcode scanning was in progress.
    • iOS - Classic Component: Fixed an issue where rapid stopping and starting the camera session could lead to a crash or memory leak.
    • 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 in RTU-UI v2 where the introduction screen appeared automatically even when camera access was denied.
    • iOS: Fixed an issue where quickly stopping and starting the camera session of any scanner screen could lead to a crash or unpredictable behavior.
    • iOS: Fixed a crash in barcode scanner feature caused by camera access being restricted by system-wide settings (e.g. Parental Controls / Screen Time).
    • Android: FindAndPickScanningMode.SheetContent.BarcodeItemImageVisible in RTU-UI v2 now correctly applies visibility.
    • Android: Fixed an issue where the ExtractedDocument was not being generated for GS1 Handling DecodeStructure and DecodeFull.
    • Android: Barcode Scanner RTU UI v2: fixed an issue where the back button navigation did not work.
  • iOS: Fixed a bug with scanned documents cloning when using per-file encryption.
  • Android: Fixed screen insets for Android API 35 with forced edge-to-edge mode by opting out for RTU-UI v1 screens.
  • Android: In RTU-UI v2, modal dialog no longer appears below status bar.
  • Android: Accessibility content for action buttons in RTU-UI v2 now properly applied.
• ⚠️ Breaking changes:
  • Package Structure:
    • In v7.1.0, the packaging structure has changed. Unlike v6.1.0, your application project must now also reference the ScanbotSDK.MAUI package directly. Transitive references are no longer sufficient, because native Android and iOS SDK assets are delivered through a shared reference mechanism to avoid doubling package size.
  • General:
    • Targeting .NET 9 requires a minimum microsoft.net.sdk.ios workload id 18.5.9199, which depends on Xcode 16.4.
    • Removed the Image Picker service i.e. the ScanbotSDKMain.ImagePicker API.
    • RTU-UI v2: Replaced the ScannedDocument.Page.AddPage(PlatformImage) function with ScannedDocument.Page.AddPage(PlatformImage image, bool detectDocument, ParametricFilter[] filters = null, int index = -1);.
  • Legacy Scanners:
    • Check Scanner: ScanbotSDKMain.Rtu.CheckScanner returns the RTU-UI v2 Check Scanner. The legacy RTU-UI v1 Check Scanner was moved to ScanbotSDKMain.Rtu.Legacy.CheckScanner. Check related configurations and namespaces.
    • VIN Scanner: ScanbotSDKMain.Rtu.VinScanner returns the RTU-UI v2 VIN Scanner. The legacy RTU-UI v1 VIN Scanner was moved to ScanbotSDKMain.Rtu.Legacy.VinScanner. Check related configurations and namespaces.
  • Native Library Update:
    • iOS: The iOS SDK is now included as an .xcframework (previously provided as a .framework).
      • Note: Please remove the RuntimeIdentifier conditions for device(arm64) and simulator(x86) from the project(.csproj) file.
    • Android: The Android SDK is now packaged with multiple .aar files, split by module (previously provided as a single combined .aar).
      • Note: Please clear your project’s build cache completely when upgrading from a previous ScanbotSDK version to prevent potential conflicts.
  • RTU-UI v1 Removal:
    • Removed RTU-UI v1 scanner, please use the corresponding RTU-UI v2 methods, that were newly added:
      • Removed ScanbotSDKMain.RTU.MrzScanner.LaunchMrzScannerAsync(...). Use ScanbotSDKMain.Rtu.MrzScanner.LaunchAsync(...) instead.
      • Removed ScanbotSDKMain.RTU.TextDataScanner.LaunchTextDataScannerAsync(...). Use ScanbotSDKMain.Rtu.TextPatternScanner.LaunchAsync(...) instead.
      • Removed ScanbotSDKMain.RTU.Legacy.BarcodeScanner.LaunchBarcodeScannerAsync(...) and ...LaunchBatchBarcodeScannerAsync(...). Use ScanbotSDKMain.Rtu.BarcodeScanner.LaunchAsync(...) instead.
      • Removed ScanbotSDKMain.RTU.LicensePlateScanner.LaunchLicensePlateScannerAsync(...).
      • Removed ScanbotSDKMain.RTU.GenericDocumentRecognizer.LaunchGenericDocumentRecognizerAsync(...).
  • Feature Renaming (RTU-UI and Detectors):
    • Renamed GenericDocumentRecognizer to DocumentDataExtractor and related types as well.
    • Renamed CheckRecognizer to CheckScanner and related types as well.
    • Renamed MedicalCertificateRecognizer to MedicalCertificateScanner and related types as well.
    • Renamed TextDataScanner to TextPatternScanner and related types as well.
  • API changes:
    • Updated the RTU-UI APIs for the below scanners:
      • Renamed ScanbotSDKMain.RTU... to ScanbotSDKMain.Rtu....
      • Renamed ScanbotSDKMain.Detectors... to ScanbotSDKMain.Detector...
      • Renamed ScanbotSDKMain.RTU.MRZ... to ScanbotSDKMain.Rtu.Mrz...
      • Renamed ScanbotSDKMain.RTU.VIN... to ScanbotSDKMain.Rtu.Vin....
      • Renamed ScanbotSDKMain.RTU.TextData... to ScanbotSDKMain.Rtu.TextPattern....
      • Renamed ScanbotSDKMain.RTU.EHIC... to ScanbotSDKMain.Rtu.Ehic....
      • Replaced ScanbotSDKMain.RTU.GenericDocument... to ScanbotSDKMain.Rtu.DocumentDataExtractor....
    • Simplified the API naming by updating all the:
      • ScanbotSDKMain.Detector.<ScannerName>.Detect<ScannerName>OnImageAsync() to ScanbotSDKMain.Detector.<ScannerName>.DetectOnImageAsync(..).
      • ScanbotSDKMain.RTU.<ScannerName>.Launch<ScannerName>Async() to ScanbotSDKMain.Rtu.<ScannerName>.LaunchAsync().
      • ScanbotSDKMain.RTU.<ScannerName>.Close<ScannerName>Async() to ScanbotSDKMain.Rtu.<ScannerName>.CloseAsync().
      • Note: Not all the new RTU-UI v2 scanners contain the CloseAsync() feature(aka Force closing feature of the scanner).
    • IMPORTANT - Namespaces:
      • All the RTU-UI and the DetectOnImage APIs are under the ScanbotSDK.MAUI.<ScannerName>, e.g. ScanbotSDK.MAUI.Check.
      • All the configuration and result classes for the DetectOnImage feature are under the ScanbotSDK.MAUI.Core.<ScannerName>, e.g. ScanbotSDK.MAUI.Core.Check.
  • Result Type Changes:
    • For the RTU-UIs, Updated the result APIs to be wrapped under a generic type RtuResult<ScannerResultType> object. It will provide more information about the scanner result status, and error message.
    • The EHIC scanner RTU-UI now returns RtuResult<EuropeanHealthInsuranceCardRecognitionResult> and DetectOnImage returns EuropeanHealthInsuranceCardRecognitionResult result respectively.
    • The Medical Certificate scanner RTU-UI now returns RtuResult<MedicalCertificateScanningResult> and DetectOnImage returns MedicalCertificateScanningResult result respectively.
    • The Check Scanner RTU-UI(Legacy v1) now returns RtuResult<CheckScanningResult> and DetectOnImage returns CheckScanningResult result respectively.
    • The VIN Scanner RTU-UI(Legacy v1) now returns RtuResult<VinScannerResult> result.
    • The Document Scanner RTU-UI now returns RtuResult<ScannedDocument> result.
    • The Barcode Scanner RTU-UI now returns RtuResult<BarcodeScannerUiResult> and DetectBarcodesOnImage returns BarcodeScannerResult result respectively.
    • The ScanbotSDKMain.CommonOperations.DetectDocumentQualityAsync(...) now returns DocumentQualityAnalyzerResult, which returns more information.
  • Configuration Object Changes:
    • In SBSDKConfiguration replaced property DetectorType of type DocumentDetectorType with property EngineMode of type DocumentScannerEngineMode. The default behavior still remains the same, ML based.
    • Renamed enum DocumentDetectorMode to DocumentScannerEngineMode.
    • Replaced PDF PDFConfiguration with PdfConfiguration.
    • Replaced TIFF TiffOptions with TiffGeneratorParameters.
    • Renamed DocumentScannerConfiguration to DocumentScannerScreenConfiguration.
    • Renamed BarcodeScannerConfiguration to BarcodeScannerScreenConfiguration.
  • Document Scanner Configuration:
    • Removed properties (AcceptedAngleScore, AcceptedSizeScore, etc.) from DocumentScannerCameraConfiguration, moved to DocumentScannerParameters.
    • AcceptedSizeScore and AcceptedAngleScore range changed from 0..1 to 0..100.
    • Renamed IgnoreBadAspectRatio to IgnoreOrientationMismatch in DocumentScannerScreenConfiguration, DocumentScannerConfiguration and FinderDocumentScannerConfiguration.
    • iOS: Renamed DetectorMode to EngineMode in DocumentScannerConfiguration and FinderDocumentScannerConfiguration.
  • VIN Scanner Configuration:
    • Renamed MinimumNumberOfRequiredFramesWithEqualRecognitionResult to MinimumNumberOfRequiredFramesWithEqualScanningResult in VinScannerConfiguration.
  • Barcode Scanner:
    • Classic Component: IMPORTANT: Replaced the BarcodeFormats with BarcodeFormatConfigurations. Now we can set more advanced configuration for an individual barcode format. We can still use the enums, see the example project implementation.
  • Changed default text values for CameraPermission styled texts.
• 🚙 Under the hood:
  • Updated ScanbotSDK.NET to 7.1.0.
  • Updated the native Android SDK to Android Document SDK 7.1.1.
  • Updated the native iOS SDK to iOS Document SDK 7.1.2.

MAUI - Version 6.1.0 (29 Jan 2025)

• 🎉 New:
  • Implemented new Ready-To-Use Document Scanner screen with extended scanning and reviewing capabilities.
  • Implemented new ScannedDocument API to perform document creation and editing.
  • Added support for German Health Insurance Card front-side and European Health Insurance Card to IGenericDocumentRecognizer and IGenericDocumentDetector.
  • Added support for new barcode types Maxicode, rMQR code, Code 11 and Code 32.
  • Added properties AustraliaPostCustomerFormat, UseIata2Of5Checksum and UseCode11Checksum to BarcodeAdditionalParameters and BarcodeRecognizerConfiguration.
  • Added new property AddAdditionalQuietZone to BarcodeScannerAdditionalConfig.
  • 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 a new property AccessibilityDescription in RoundButton and ButtonConfiguration.
• 🚀 Improvements:
  • Each detector and UI feature is grouped more logically under ScanbotSDKMain.
    • RTU groups all of the Ready-to-Use UI scanners for each feature.
    • Detectors groups all of the image-based detectors for each feature.
  • All SDK interfaces available via ScanbotSDKMain are also registered for MAUI dependency injection when intializing the SDK with a MauiAppBuilder.
  • 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.
  • AR overlay is enabled by default for FindAndPickScanningMode in Barcode Scanner RTU UI v2 screen.
  • For Code128 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 IDocumentScanner by tweaking various timing related default values, such as InitialScanDelay and AutoSnappingDelay.
  • Android: Improved generic document recognition on static images.
• 🐞 Bug fixes:
  • Fixed KANJI mode for QR codes.
  • Added missing ParsedDocument to Barcode.RTU.v1.Barcode so that formatted barcode data can be parsed in IBarcodeDetector and our Barcode Classic Components.
  • Android: Minor fixes for appearance in RTU-UI v2 Barcode Scanner to make it consistent with its iOS counterpart.
  • Android: Fixed point sorting in ContourDetector.
  • Android: Fixed an issue with AR Overlay and barcode mapping in RTU UI v2, where the mapped image wasn't shown on the AR Overlay until the same barcode appeared in the list below.
  • Android: Fixed image preprocessing for Document Quality Analyzer.
  • Android: Fixed R8 obfuscation config for SDK logging classes.
  • iOS: Fixed a bug in RTU-UI v2 Barcode Scanner where extended barcodes were 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 the RTU-UI v2 Find & Pick scanner in button sheet mode where the counter badge was not visible.
  • iOS: Fixed a UI issue in RTU-UI v2 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.
  • iOS: Fixed a bug in the Barcode RTU v1 result where the Image property in BarcodeResultBundle object returned null even if the BarcodeScannerConfiguration.BarcodeImageGenerationType property was set to BarcodeImageGenerationType.CapturedImage.
• ⚠️ Breaking changes:
  • Dropped support for .NET 7.
  • Renamed ScanbotSDK class to ScanbotSDKMain.
  • Removed the IReadyToUseUIService and IDataDetectionService meta-interfaces as all of the individual RTU and detector interfaces are available via ScanbotSDKMain or dependency injection.
  • Removed IScreenMetrics as it was no longer in active use by the SDK.
  • Renamed IImagePickerService to IImagePicker.
  • Renamed IScanbotSDKService to IScanbotOperations.
  • Moved the RTU v1 Barcode Scanner and related code from ScanbotSDK.MAUI.RTU.v1 to ScanbotSDK.MAUI.Barcode.RTU.v1. This coincides with a change in the previous release to group features in their appropriate namespace.
  • Replaced usage of Barcode.RTU.v1.PolygonResultPoint and Common.PointF with System.Drawing.PointF.
  • The previous version of the Document Scanner RTU UI had it's interfaces and configurations moved to the ScanbotSDK.MAUI.Document.RTU.v1 namespace.
    • This includes RTU interfaces such as ICroppingScreen and IDocumentScanner as well as configurations such as CroppingScreenConfiguration, DocumentScannerConfiguration and FinderDocumentScannerConfiguration.
    • The RTU interfaces, Document.RTU.v1.IDocumentScanner and Document.RTU.v1.ICroppingScreen have been marked as [Obsolete].
  • Deprecated IScannedPage and moved it to the ScanbotSDK.MAUI.Document.Legacy namespace. The replacement is the new ScannedDocument and ScannedDocument.Page APIs.
  • Various existing detection and UI methods have been updated to use PlatformImage instead of ImageSource.
    • In most cases, extension methods are provided to allow ImageSource to still be used.
    • Methods using FileImageSource have been left alone but may be updated to System.Uri in the future (with appropriate compatibility extensions added).
    • Conversion to ImageSource may be needed in cases where it is used in a result type (for example CheckRecognizerResult, Barcode, etc).
  • Removed enum BarcodeDensity.
    • Removed property CodeDensity from BarcodeAdditionalParameters.
  • Renamed the values of the enum DocumentDetectionStatus.
  • Removed enum values Validate and Decode from GS1Handling and replaced them with DecodeStructure, DecodeFull, ValidateStructure and ValidateFull.
  • Removed property SharpnessAcceptanceFactor from GenericDocumentRecognizerConfiguration and GenericDocumentDetectorConfiguration.
  • Android: Changed BarcodesRegexFilter config behavior for Barcode Scanner RTU UI v2. Barcodes are accepted if the barcode data contains the part that matches the regex.
• 🚙 Under the hood:
  • iOS: For the iOS implementations of CreatePdfAsync and CreateSandwichPdfAsync, the updated SBSDKPDFRendererOptions is used to support PDF attributes instead of the now removed SBSDKPDFMetadataEditor.
  • Android: Added gs1-syntax-dictionary lib.
  • Updated the native Android SDK to Android Document SDK 6.1.2.
  • Updated the native iOS SDK to iOS Document SDK 6.1.1.

MAUI - Version 5.1.1 (4 Oct 2024)

• 🚀 Improvements:
  • Re-added support for the net-8 target framework to make it easier to use our configuration classes and interfaces for unit testing.
• 🐞 Bug fixes:
  • Fixed reference issues when using our MAUI package in more complex project structures.

MAUI - Version 5.1.0 (19 Sep 2024)

• 🎉 New:
  • Added new freshly designed RTU-UI version 2 for Barcode scanning with advanced agile configuration. Use ScanbotSDK.ReadyToUseUIService to leverage the new UI.
  • Added support for the Micro PDF 417 barcode format.
  • Added support for parsing of AAMVA Certificate of Title for motor vehicle barcodes.
  • Added support for Canadian and UAE Check standards.
  • Added new class-based image filters, ParametricFilter, for the ImageProcessor API:
    • ScanbotBinarizationFilter
    • CustomBinarizationFilter
    • ColorDocumentFilter
    • BrightnessFilter
    • ContrastFilter
    • GrayscaleFilter
    • WhiteBlackPointFilter
    • LegacyFilter (encapsulates the deprecated ImageFilter type filters).
  • Added support for German residence permits (2011 and 2019 formats) in the GenericDocumentRecognizer. Check property AcceptedDocumentTypes of type GenericDocumentRootType[] in the GenericDocumentRecognizerConfiguration class.
  • Added new class DocumentQualityAnalyzerConfiguration.
  • Added new properties to the PDFConfiguration class used while creating a PDF file.
  • Added new Data detection on still Image feature which can be accessed from ScanbotSDK.DataDetectionService API. It will allow input ImageSource and perform data detection for
    • Check
    • EHIC (European Health Insurance Card)
    • Generic Document
    • Medical Certificate
    • MRZ
  • Added UserDefinedFields in the class TiffOptions, used in the function ScanbotSDK.SDKService.WriteTiffAsync(...).
  • Added AcceptedBrightnessThreshold in the DocumentScannerConfiguration and FinderDocumentScannerConfiguration.
  • Added ReturnCroppedDocumentImage in the MedicalCertificateRecognizerConfiguration.
• 🚀 Improvements:
  • Optimized camera preview quality and processing speed for all scanners.
  • iOS:
    • IMPORTANT: Changed the default rear cameras on all scanners to the triple or dual camera. On some devices with triple camera this results in a different view port (more zoomed in). Please make sure to adapt your zoom ranges and factors.
    • Added support of haptic feedback on capable devices.
  • Android:
    • Changed the touch to focus square in the native camera view to a circle.
  • Added several missing, and mostly platform specific, properties to the RTU v1 scanner configurations:
    • For BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration, the following properties where exposed:
      • For Android only (accessible through #if ANDROID):
        • AutoCancelTimeout (This property is Android only for the BatchBarcodeScannerConfiguration.)
        • CameraPreviewMode
        • UseButtonsAllCaps
        • DelayAfterScan
        • TouchToFocusEnabled
        • MinFocusDistanceLock
      • For iOS only (accessible through #if iOS):
        • FocusLockEnabled
        • FocusLockPosition
        • DoubleTapToZoomEnabled
        • PinchToZoomEnabled
        • ShouldAnimateZooming
• 🐞 Bug fixes:
  • For BarcodeFormat.Pdf417, a single case to generate clusters was not covered, which led to a crash.
  • Fixed issue with misaligned barcode polygons on some devices with horizontal orientation.
• ⚠️ Breaking changes:
  • IMPORTANT - Classic Component: The MAUI Classic UI Components: BarcodeScannerView and BarcodeScanAndCountView must now be wrapped inside ScanbotClassicUIContainer.
  • IMPORTANT - Namespaces: There are namespace changes for almost every RTU UI configuration. Earlier all the RTU UI configurations were available in the ScanbotSDK.MAUI namespace. But now they are available in the specific module folders. For e.g:
    • ScanbotSDK.MAUI.DocumentScannerConfiguration is ScanbotSDK.MAUI.Document.DocumentScannerConfiguration
    • ScanbotSDK.MAUI.CheckRecognizerConfiguration is ScanbotSDK.MAUI.Check.CheckRecognizerConfiguration
    • For all the other class namespaces, please refer to the API references.
  • IMPORTANT - ImageFilter: Replaced all the properties and functions using ImageFilter enum with ParametricFilter object in the IScannedPage interface. This change can impact the data saved in the local storage, while migrating from the previous versions. Note: We can also set the ImageFilter to ParametricFilter directly. The SDK will implicitly convert the old type and return a ParametricFilter.
  • Replaced parameter ImageFilter with ParametricFilter in the ScanbotSDK.SDKService.ApplyImageFilterAsync(...) method.
  • IMPORTANT - BarcodeScanner: Our Ready to Use UI v1 barcode scanners are now deprecated and it is highly encouraged to use the new RTU UI v2 barcode scanner API. All RTU v1 code has been moved to the ScanbotSDK.MAUI.RTU.v1 namespace, with RTU v2 code existing under ScanbotSDK.MAUI. Also moved the Legacy Barcode Scanners from ScanbotSDK.ReadyToUseUIService to ScanbotSDK.LegacyBarcodeScanner.
  • The structure of barcode formatted results has been changed from record classes to using GenericDocument. This change affects RTU UI v1, however, the same structures are used across RTU UI v1 and RTU UI v2.
  • Renamed BarcodeFormat.Rss14 to BarcodeFormat.Databar and BarcodeFormat.RssExpanded to BarcodeFormat.DatabarExpanded.
  • Moved DetectDocumentAsync from ScanbotSDK.SDKService to ScanbotSDK.DataDetectionService, keeping all data detectors(from an ImageSource) in a single interface.
  • iOS:
    • MinFocusDistanceLock removed from BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration.
      • FocusLockEnabled and FocusLockPosition are exposed for iOS and these values give more control for camera focus.
    • IMPORTANT - Camera: Changed the default rear cameras on all scanners to the triple or dual camera.
• 🚙 Under the hood:
  • Updated the .NET bindings to .NET SDK 5.1.0 (see our .NET changelog for more under the hood changes).
  • Upgraded the native Scanbot Android SDK to v5.1.3 and Scanbot iOS SDK to v5.1.4 versions.

MAUI - Version 4.2.1 (6 May 2024)

• 🎉 New:
  • Added PDFConfiguration class which allows the user to set PDFSize, PDFOrientation, PDFAttributes for creating a PDF document. Please check ScanbotSDK.MAUI.SDKService.CreatePdfAsync(...). The PDFAttributes class allows the user to set the PDF metadata.
  • Added a new property ScanbotOCR and method Tesseract(...) in OcrConfig class. It simplifies the usage of OCR configuration engines.
  • Added a new method ScanbotSDK.MAUI.SDKService.CreateSandwichPdfAsync(...) which creates PDF document along with performing the OCR on it.
• 🐞 Bug fixes:
  • iOS: Fixed a bug in ScanbotSDK.MAUI.SDKService.CreatePdfAsync(...), it always used the OCR engine before. Now, there are 2 different functions for both usecases:
    • Creating a PDF document, See ScanbotSDK.MAUI.SDKService.CreatePdfAsync(...)
    • Creating a PDF including OCR (Sandwich PDF document). See ScanbotSDK.MAUI.SDKService.CreateSandwichPdfAsync(...)
• ⚠️ Breaking changes:
  • The OCRMode enum types ML and Legacy are renamed with ScanbotOCR and Tesseract respectively.
  • Replaced ScanbotSDK.MAUI.SDKService.CreatePdfAsync(IEnumerable<FileImageSource> files, PDFPageSize pageSize, PDFPageOrientation pdfPageOrientation, OcrConfig configuration) with ScanbotSDK.MAUI.SDKService.CreatePdfAsync(IEnumerable<FileImageSource> files, PDFConfiguration configuration).

MAUI - Version 4.2.0 (17 Apr 2024)

• 🎉 New:
  • Added new RTU UI components:
    • VIN (Vehicle identification number) Scanner
    • License Plate Scanner
    • Text Data Scanner
  • Introduced Document Quality Analyzer. It analyzes the text quality (legibility) on images. See ⚠️ Breaking changes for more information.
  • Added new supported barcode formats. Check BarcodeFormat enum for:
    • USPSIntelligentMail
    • RoyalMail
    • JapanPost
    • RoyalTNTPost
    • AustraliaPost
    • GS1Composite
    • DatabarLimited
  • Added support for Kuwait ID cards in the MRZ scanner.
  • Added support for Israelian checks to the check recognizer.
  • Added new type literals for PDFPageSize.
  • Added a new enum PDFPageOrientation which can be used while creating PDF in IScanbotService.CreatePdfAsync(...) method.
  • Formatted barcode documents are now exposed on barcodes via a new property called FormattedResult, which contains strongly typed records of the data contained within the barcode. The new record types include:
    • AAMVADocument
    • BoardingPassDocument
    • DEMedicalPlanDocument
    • Gs1Document
    • IDCardPDF417Document
    • MedicalCertificateDocument
    • SEPADocument
    • SwissQRDocument
    • VCardDocument
  • MRZ support for td1 long document standard.
  • Added CameraZoomRange in BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration.
  • Added ExtensionFilter in BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration. Added Extension property in Barcode result model to access the extension result.
  • Both Android and iOS:
    • New PDF renderer for simple PDF and "sandwiched" PDF generation.
      • Added support for custom PDF metadata. Check IO.Scanbot.Pdf.Model.PdfAttributes for Android and SBSDKPDFMetadataProcessor for iOS.
      • Added support for portrait, landscape and auto page orientation. Check IO.Scanbot.Pdf.Model.PageDirection in Android and SBSDKPDFRendererPageOrientation for iOS.
      • Extended list of supported page sizes (A3, A5, B4, B5, etc.). Check IO.Scanbot.Pdf.Model.PageSize for Android and SBSDKPDFRendererPageSize for iOS.
• 🚀 Improvements:
  • Improved the speed of barcode recognition for most barcode symbologies.
  • Enhanced control over how to handle GS1 messages in barcodes.
  • New overloads for SBSDKInitializer.Initialize to enable initialization directly from a MAUI application instead of platform specific application objects.
  • New improved document detector with better performance and less memory consumption.
  • Added new Optical Character Recognition engine based on machine learning algorithms. The new OCR engine currently supports all languages with latin letters, there is no need to specify the languages for it. The speed of text recognition has increased twofold. We can still use the legacy recognition by setting OCRMode enum type as Legacy in the OcrConfig class.
  • BatchBarcodeScannerConfiguration now supports the BarcodeFormats property for filtering barcodes.
  • Improved accuracy and detection speed of QrCode, Code39, and Code93 barcode types.
  • Improved contour lines detection with ML Based detection.
  • Android:
    • Stripped down the Android dynamic symbol table in native libraries. As a result, the size of the native shared libraries has decreased.
    • Optimized the size of native libraries integrated into the Scanbot SDK.
    • Enhanced error handling behavior when deleting SDK pages.
    • Improved quality and speed of the Document Contour detector.
    • Decreased size of Document Contour detector ML model.
• 🐞 Bug fixes:
  • Before, for certain invalid decoding of QR, an exception was thrown from ZXing. Now we rigorously treat this as a format error.
  • Before, we have returned CODE_25 results when INDUSTRIAL_2_OF_5 was enabled and CODE_25 was disabled. Now, we do not return the CODE_25 result for such decoding options.
  • Fixed the detection of a few false positive RSS Expanded codes in live mode.
  • IScanbotSDKService.WriteTiffAsync, IScanbotSDKService.PerformOcrAsync and IScanbotSDKService.CreatePdfAsync all receive IEnumerable<FileImageSource> instead of IEnumerable<ImageSource>. With the prior implementations, an invalid cast exception was thrown when a set of files wasn't provided because the internals do, in fact, require files. See also ⚠️ Breaking changes.
  • Android:
    • Fixed potential memory leak in all RTU-UI screens.
    • Fixed some OOM crashes on low to midrange devices.
    • Fixed false positives for CODE_39 and CODABAR barcodes.
    • Fixed colors not being applied to fields in GenericDocumentRecognizerConfiguration.
    • Fixed bug with invisible back button on Document Scanner RTU UI screens when no Camera permission was granted.
    • Fixed the logic in AutoSnapProgressEnabled and PolygonAutoSnapProgressEnabled methods in FinderDocumentScannerConfiguration and DocumentScannerConfiguration.
    • Corrected mapping of UserGuidanceStrings in CheckRecognizerConfiguration.
    • Fixed the TopBarButtonsColor option for the MrzScannerConfiguration and HealthInsuranceCardScannerConfiguration.
    • Fixed EnableCameraButtonTitle and EnableCameraExplanationText parameters on BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration.
  • iOS:
    • Fixed a crash when denying camera permission.
    • Fixed a bug with magnetic lines in CroppingScreen RTU UI.
    • Fixed a bug where the polygon should be mirrored when using the front camera in DocumentScannerResult.
    • Fixed a bug where AutomaticSelectionEnabled was not working properly in BarcodeScannerConfiguration.
    • Fixed a bug where FlashEnabled was not working properly in HealthInsuranceCardScannerConfiguration.
    • Fixed a bug with the iPad 5th generation where captured images were wrong.
    • Fixed a bug where the finder text hint was still showing when ViewFinderEnabled was disabled in BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration.
    • Fixed a wrong polygon color in RTU-UI barcode scanner tracking overlay.
    • Fixed a bug in SBSDKOpticalCharacterRecognizer where RecognizeText was unable to detect text on imageStorage when the encryption was enabled.
    • Fixed the issue when the top and bottom toolbars' background color in SBSDKUICroppingViewController didn't update on dark mode change, when set to UIColor.systemBackground.
• ⚠️ Breaking changes:
  • GS1 codes are now handled differently for various barcode types. Using the default option GS1Handling.Parse will give the same result as before for all barcode types, except for BarcodeFormat.RssExpanded. Previously, for RssExpanded, the result was inconsistently returned with parentheses. Now, to get results with parentheses for all barcode types, use the option GS1Handling.Decode.
  • IScannedPageService renamed to IScannedPage.
  • Major updates in IScanbotSDKService:
    • Replaced EstimateBlurriness with DetectDocumentQualityAsync.
    • Replaced OcrConfigs with DefaultOcrConfig which provides the default OCR configs from the native platforms.
    • Replaced public LicenseInfo GetLicenseInfo() with public LicenseInfo LicenseInfo { get; }.
    • Updated return value of ApplyImageFilterAsync from Task<ImageSource> to Task<FileImageSource>.
    • Replaced CreatePdfAsync(List<ImageSource> images, PDFPageSize pageSize) with CreatePdfAsync(IEnumerable<FileImageSource> files, PDFPageSize pageSize = PDFPageSize.Custom, PDFPageOrientation pdfPageOrientation = PDFPageOrientation.Auto, OcrConfig configuration = null).
    • Replaced PerformOcrAsync(IEnumerable<ImageSource> images, IEnumerable<string> languages, string pdfOutputPath = null) with Task<OcrResult> PerformOcrAsync(IEnumerable<FileImageSource> sources, OcrConfig configuration = null, string pdfOutputPath = null)
    • Replaced WriteTiffAsync(IEnumerable<ImageSource> images, TiffOptions options = null) with WriteTiffAsync(IEnumerable<FileImageSource> files, TiffOptions options = null).
  • Replaced property Gs1DecodingEnabled of type bool with Gs1HandlingMode of type GS1Handling enum in BarcodeScannerAdditionalParameters.
  • The DocumentSDK.MAUI.iOS and DocumentSDK.MAUI.Droid assemblies merged into one assembly named DocumentSDK.MAUI.
  • All types under the DocumentSDK and BarcodeSDK namespaces have been moved to the ScanbotSDK namespace.
  • The ScanbotSDK.NET package is no longer referenced as a dependency. All needed files and dependencies are included directly in the package.
  • Renamed all the extension methods to ToNative() and ToMaui(). The extension methods which are responsible for converting Maui class objects to Native(iOS/Android) class objects or vice versa. Same with the conversion of Maui enums to Native enums or vice versa.
• 🚙 Under the hood:
  • Upgraded the native Scanbot Android SDK to v4.2.0 and Scanbot iOS SDK to v4.2.2
  • Added "libharu" library to dependencies.
  • Android:
    • Blackview and Caterpillar brands are now excluded from GpuAcceleration-supported devices.
    • Removed "Android PDF Writer" library from dependencies.
    • Upgraded OpenCV version to 4.8.
    • Added "icu4c" library to dependencies.
    • Updated version of Nameof C++ library to v0.10.3.
    • Disabled GPU acceleration for Redmi 9 models, Samsung Galaxy Grand Prime and devices with Android older than 6.
  • iOS:
    • Added Privacy manifest file (PrivacyInfo.xcprivacy) to the SDK which complies with the latest Apple specs.
    • Added new static property MaximumRecommendedImageSize to SBSDKDeviceInformation.

MAUI - Version 2.3.1 (11 Oct 2023)

• 🐞 Bug fixes:
  • Fixed a focusing issue with the new iPhone 15 Pro and 15 Pro Max.

MAUI - Version 2.3.0 (15 Sep 2023)

• 🎉 New:
  • More supported barcode types:
    • Micro QR Code
  • An additional Ready-To-Use UI Component in the form of Finder Document Scanner.
  • Support for configuring a confirmation dialog for the Barcode Scanner Ready-To-Use UI Component.
• 🚀 Improvements:
  • Improved accuracy and detection speed of QR_CODE, Code39, and Code93 barcode types.
  • Added support for inverted PDF-417 barcodes.
• 🐞 Bug fixes:
  • Fixed NullReferenceException when using the FinderWidthRelativeToDeviceWidth or FinderHeightRelativeToDeviceWidth properties in DocumentSDK.MAUI.MrzScannerConfiguration.
  • DocumentSDK.MAUI.ScanbotSDK.LicenseInfo now returns the correct license status.
• ⚠️ Breaking changes:
  • For the DocumentSDK.MAUI.Constants.MedicalCertificateCheckboxType enum, changed RequiresCareYes to CareYes.
  • Renamed the BarcodeSDK.MAUI.Constants.OverlayFormat enum to BarcodeSDK.MAUI.Constants.BarcodeTextFormat.
    • Any types which use the enum have also been updated, such as BarcodeSDK.MAUI.Configurations.SelectionOverlayConfiguration.
  • If using named parameters for BarcodeSDK.MAUI.Configurations.SelectionOverlayConfiguration, the misspelled automaticSelectionEnaled parameter has been renamed to automaticSelectionEnabled.
• 🚙 Under the hood:
  • The native Scanbot Android SDK upgraded to v2.3.0.
  • The native Scanbot iOS SDK upgraded to v2.3.1.

MAUI - Version 2.2.0 (26 Jun 2023)

• 🎉 First release of the ScanbotSDK.MAUI NuGet package for MAUI.
• Provides Ready-To-Use UI Components - a set of easy to integrate and customize high-level MAUI components for the most common tasks in Scanbot SDK:
  • Document Scanner
  • Cropping UI & ImageFilters
  • Barcode & QR code Scanner
  • MRZ Scanner
  • Generic Document Recognizer
  • EHIC Scanner
  • Check Recognizer
• Provides additional SDK features based on image picked from the device photos application:
  • Detect Barcodes on Image
  • Detect Document on Image
• New unified Scanbot SDK API:
  • Idiomatic asynchronous design
  • MAUI-based unified API for Android & iOS
• Example App demonstrating the new functionality: scanbot-sdk-maui-example

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get free trial license

Scanbot SDK is part of the Apryse SDK product family

A mobile scan is just the start. With Apryse SDKs, you can expand mobile workflows into full cross‑platform document processing. Whether you need to edit PDFs, add secure digital signatures, or use a fast, customizable document viewer and editor, Apryse gives you the tools to build powerful features quickly.

Learn more

Was this helpful?