tip

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

Changelog

Version 7.1.0 (18 September 2025)

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

Version 7.0.1 (25 August 2025)

• 🎉 New:
  • Added new optional parameter documentPreviewImageSizeLimit to createPageWithImageBytes, iOS only.
  • Added new property storageImagePreviewSize to ScanbotSdkConfig, Android only.
  • Added new property documentPreviewImageSizeLimit to DocumentClassicScannerConfiguration, iOS only.
  • Added new property documentPreviewImageSizeLimit to Page class, iOS only.
• 🐞 Bug Fixes:
  • Document Scanner:
    • Fixed a bug with the page counter's visibility in the RTU-UI v2 Document Scanner.
    • Fixed a bug in RTU-UI v2 Document Scanner where the document could not be captured in auto snap mode, when enabledInAutoSnappingMode was set to false in ShutterButton.
  • DocumentScannerCamera:
    • Fixed false positive display of textHintOrientationMismatch in DocumentScannerCamera.
  • iOS: Fixed handler for createTIFFFromImages.
• 🚙 Under the hood:
  • Upgraded the native Scanbot Android SDK to v7.0.4.
  • Upgraded the native Scanbot iOS SDK to v7.0.6.

Version 7.0.0 (30 June 2025)

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

Version 6.1.2 (16 January 2025)

• 🐞 Bug fixes:
  • Android: Resolved an issue with detected polygon display for Document Classic UI Component.
• 🚙 Under the hood:
  • Downgraded the kotlin_version to v1.8.20.

Version 6.1.1 (16 December 2024)

• 🐞 Bug fixes:
  • Android: Resolved a crash with legacy startDocumentScanner when documentImageSizeLimit is set in DocumentScannerConfiguration.

Version 6.1.0 (12 December 2024)

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

Version 5.1.3 (5 November 2024)

• 🚀 Improvements:
  • iOS:
    • Added widgetFadeAnimationDurationiOS to ScanbotCroppingWidget to customize the animation duration.
• 🐞 Bug Fixes:
  • Android:
    • Fixed an issue where polygon detection didn't work after switching the page inside ScanbotCroppingWidget.
  • iOS:
    • Resolved a blink issue that caused brief redraws during page changes inside ScanbotCroppingWidget.

Version 5.1.2 (25 October 2024)

• 🐞 Bug fixes:
  • iOS:
    • Fixed the image processing and editing flow in ScanbotCroppingWidget.

Version 5.1.1 (21 October 2024)

• 🚀 Improvements:
  • Updated visibility of ScanbotCameraWidgetState to allow access to channelName.
• 🐞 Bug fixes:
  • Android:
    • Fixed transitive resources issue for proper references across modules.

Version 5.1.0 (20 September 2024)

• 🎉 New:
  • Introduced the redesigned RTU-UI version 2.0 for enhanced Barcode scanning, featuring advanced agile configuration options.
  • Added support for the Micro PDF 417 barcode format.
  • Added support for parsing AAMVA Certificate of Title for motor vehicle barcodes.
  • Added a new field shouldReturnCroppedImage in BarcodeClassicScannerConfiguration for the BarcodeScannerCamera Classic UI. When set to true, the result will be returned in the barcodeImageBase64 field of the BarcodeItem model.
  • Added new RTU components:
    • VIN Scanner: The startVinScanner component is designed to accurately scan and decode Vehicle Identification Numbers (VINs). This scanner is optimized to handle VINs from a variety of sources, including vehicle dashboards and registration documents, providing precise extraction and decoding of this critical vehicle information.
    • Check Scanner: With the startCheckScanner component, you can scan and recognize various check formats. This scanner processes checks to extract key data fields, enabling streamlined check processing and verification.
    • Text Data Scanner: The startTextDataScanner component extracts text data from documents using Optical Character Recognition (OCR). It is particularly useful for capturing and digitizing text from forms, invoices, and other text-heavy documents, facilitating efficient data entry and management.
    • Medical Certificate Scanner: The startMedicalCertificateScanner component is tailored for scanning and recognizing medical certificates. It supports various medical document formats, extracting essential information such as patient details, diagnoses, and treatment data, which is crucial for healthcare documentation and management.
  • Added new ParametricFilter APIs:
    • ScanbotBinarizationFilter
    • CustomBinarizationFilter
    • ColorDocumentFilter
    • BrightnessFilter
    • ContrastFilter
    • GrayscaleFilter
    • WhiteBlackPointFilter
    • LegacyFilter
  • Added support for German residence permits (2011 and 2019 formats) in GenericDocumentRecognizer.
  • PdfRenderingOptions now allows setting the jpegQuality for image encoding. Additional fields include pageFitMode, dpi, and resample.
  • Introduced a new class ScanbotSdkRecognizeOperations with operations:
    • recognizeMrzOnImage
    • recognizeMedicalCertificateOnImage
    • recognizeHealthInsuranceCardOnImage
    • recognizeGenericDocumentOnImage
    • recognizeCheckOnImage
• 🚀 Improvements:
  • The Health Insurance Card Recognizer now implements the new Scanbot OCR engine. The recognition is faster and more accurate than before.
  • Improved speed and quality of scanning for Generic Document.
  • Improved detection of UPC/EAN barcode extensions in live mode.
  • Improved speed and image quality of still image capturing.
• 🐞 Bug Fixes
  • Fixed issue with misaligned barcode polygons on devices with horizontal orientation.
  • Fixed a crash with BarcodeFormat.PDF_417 due to an uncovered cluster generation case.
  • Fixed error handling in storage cleanup and page loading.
• ⚠️ Breaking Changes:
  • Deprecated the Ready-to-Use UI v1.0 barcode scanners. Adoption of the RTU UI v2 scanner API is strongly recommended.
  • Transitioned barcode result structures from record classes to GenericDocument, affecting RTU UI v1 but standardizing across RTU UI v1 and v2.
  • Renamed BarcodeFormat.RSS_14 to BarcodeFormat.DATABAR and BarcodeFormat.RSS_EXPANDED to BarcodeFormat.DATABAR_EXPANDED.
  • Eliminated the LiveDetector and CameraController classes. Their functionalities are now integrated within the widgets.
  • Updated widgets to automatically adjust to configuration changes received by the camera widget constructors.
  • Updated BarcodeScannerCamera Classic UI Component:
    • Previous Structure:
      • Used ScanbotCameraController for camera control and barcode detection, with cameraDetector and onWidgetReady for initialization.
    • New Structure:
      • Simplified to use direct callbacks: barcodeListener for handling scanning results, errorListener for error handling, and onCameraPreviewStarted for setup after the camera preview starts. ScanbotCameraController and cameraDetector are no longer needed.
  • Updated DocumentScannerCamera Classic UI Component:
    • Previous Structure:
      • Relied on DocumentCameraLiveDetector for document scanning and separate listeners for results, errors, and document contours. Required ScanbotCameraController for control and initialization.
    • New Structure:
      • Consolidated functionality into the DocumentScannerCamera widget. Uses snapListener for handling scanned pages, errorListener for errors, documentContourListener for document contours, and onCameraPreviewStarted for setup after the preview starts.
  • Updated MedicalCertificateScannerCamera Classic UI Component:
    • Previous Structure:
      • Used MedicalCertificateCameraLiveDetector and ScanbotCameraController for control and initialization. Included finder and onWidgetReady for UI setup.
    • New Structure:
      • Integrated all functionality into the MedicalCertificateScannerCamera widget. Now uses mcListener for medical certificate results, errorListener for error handling, and onCameraPreviewStarted for setup. Enhanced finder configuration includes new UI options.
  • Removed Legacy Components:
    • Removed DocumentCameraLiveDetector and ScanbotCameraController in favor of a streamlined approach.
    • Removed MedicalCertificateCameraLiveDetector; its functionality is now integrated directly into the MedicalCertificateScannerCamera widget.
    • Removed the LiveDetector and CameraController classes. Their functionality is now integrated directly into the BarcodeScannerCamera widget.
• 🚙 Under the Hood:
  • Updated the native Scanbot iOS SDK to v5.1.3 (cf. changelog).
  • Updated the native Scanbot Android SDK to v5.1.2 (cf. changelog).
  • Android:
    • Updated Kotlin to version 1.8.22 and set jvmTarget to "17".
    • Updated 3rd-party libraries:
      • libjpeg-turbo to 2.1.5.1
      • libpng to 1.6.40
      • libtiff to 4.6.0
      • Added zlib library
  • iOS:
    • Updated 3rd-party libraries:
      • zlib to 1.3.1
      • libtiff to 4.6.0
      • libjpeg-turbo to 2.1.5.1
      • libpng to 1.6.40

Version 4.2.3 (26 August 2024)

• 🐞 Bug fixes:
  • Android:
    • Resolved a build failure in the CameraDisplayOwner class that occurred due to incorrect implementation of the LifecycleOwner interface.

Version 4.2.2 (12 April 2024)

• 🐞 Bug fixes:
  • iOS:
    • Changed privacy manifest to comply with the latest Apple specs.
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 4.2.2 (cf. changelog)

Version 4.2.1 (5 February 2024)

• 🐞 Bug fixes:
  • Android:
    • Fixed an unhandled exception when closing the Document Scanner classic component.

Version 4.2.0 (12 January 2024)

• 🎉 New:
  • Added support for new barcode type BarcodeFormat.GS1_COMPOSITE.
  • Added analyzer image size limit property for Document Quality Analyzer analyzeQualityOfDocument(Page page, Size? analyzerImageSizeLimit). If analyzerImageSizeLimit not set, the image will be downscaled to 2500 px.
  • Added support for Kuwait ID cards in the MRZ scanner.
• 🚀 Improvements:
  • Added more control over how to handle GS1 messages in barcodes. See BarcodeScannerAdditionalConfig.setGs1HandlingMode.
• ⚠️ Breaking Changes:
  • Replaced BarcodeScannerConfiguration.gs1DecodingEnabled with BarcodeScannerConfiguration.gs1DecodingMode in the RTU-UI Barcode Scanner and Batch Barcode Scanner.
• 🐞 Bug fixes:
  • Android:
    • Fixed the Camera Preview blinking after capturing a picture.
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 4.2.0 (cf. changelog)
  • Updated the native Android Scanbot SDK to 4.2.0 (cf. changelog)

Version 4.1.0 (15 December 2023)

• 🎉 New:
  • Added a new Optical Character Recognition engine based on machine learning algorithms that is usually much faster and less error prone. This new OCR engine currently supports all languages with latin letters, there is no need to specify the languages for it. The legacy engine, based on Tesseract, can still be used for non latin-based languages.
  • New PDF renderer for simple PDFs and "sandwiched" PDFs generation.
    • Added support for custom PDF metadata.
    • Added support for portrait, landscape and auto locks for the page orientation.
    • Extended the list of supported page sizes (A3, A5, B4, B5, etc.)
  • Added new Document Quality Analyzer. Use ScanbotSdk.analyzeQualityOfDocument.
  • Added new barcode types: AUSTRALIA_POST, JAPAN_POST, ROYAL_MAIL, ROYAL_TNT_POST, USPS_INTELLIGENT_MAIL, DATABAR_LIMITED.
  • Added touchToFocusEnabled to the RTU-UI scanner configs.
  • Added CameraModule.BACK_WIDEST to the cameraModule config.
• 🚀 Improvements:
  • Improved the document detector with better performance and less memory consumption.
• 🐞 Bug fixes:
  • Fixed the behavior of the Barcode Scanner when an empty array is set. Now it scans all barcode types for iOS.
• ⚠️ Breaking Changes:
  • photoQualityPrioritization parameter spelling was fixed in the Document Scanner.
  • Removed autoCancelTimeout parameter from the MRZ Scanner.
  • Removed ScanbotSdk.estimateBlurOnPage method. Use the new ScanbotSdk.analyzeQualityOfDocument method instead.
  • Removed PdfRenderSize enum in favor of PageSize class.
  • The default OCR engine has changed from TESSERACT to SCANBOT_OCR. Please use TESSERACT if you need to recognize non-Latin language texts.
• 🚙 Under the hood:
  • Changed the behavior of classic components cameraZoomFactor parameter. Now 0..1 maps to the real zoom value in the range 1.0..12.0x on both Android and iOS.
  • Changed the behavior of the barcode data mapper callback.
  • Updated the native iOS Scanbot SDK to 4.1.0 (cf. changelog)
  • Updated the native android Scanbot SDK to 4.1.1 (cf. changelog)

Version 2.13.6 (24 October 2023)

• 🐞 Bug fixes:
  • Fixed a bug where documentContourListener was not correctly returning DetectionStatus.OK when ignoreBadAspectRatio: true was set.

Version 2.13.5 (16 October 2023)

• 🐞 Bug fixes:
  • Fixed ScanbotCroppingWidget not showing the image when encryptionEnabled mode is set.

Version 2.13.4 (13 October 2023)

• 🚀 Improvements:
  • Optimized preview image quality in ScanbotCroppingWidget in Android.
  • Optimized behavior of DocumentScannerCamera. When scanning with ignoreBadAspectRatio: true, the documentContourListener won't return DetectionStatus.OK_BUT_BAD_ASPECT_RATIO.

Version 2.13.3 (4 October 2023)

• 🐞 Bug fixes:
  • Fixed a focusing issue with the new iPhone 15 Pro and 15 Pro Max.
  • Fixed an issue that prevented the Batch Barcode screen from starting.

Version 2.13.2 (26 September 2023)

• 🎉 New:
  • Added named parameters originalImageSizeLimit and documentImageSizeLimit to ScanbotSdk.createPage, ScanbotSdk.createPageFromBytes and DocumentClassicScannerConfiguration that limits page images size to this value. If the image size exceeds the limit, the image will be downscaled to fit the limit. Cropped images will never be bigger than the original images.
  • Added ContourConfiguration.showPolygonInManualMode to DocumentScannerConfiguration that allows to show/hide polygon contour when auto-snapping is disabled.
• 🚀 Improvements:
  • Improved behavior of DocumentScannerCamera. Now it automatically reacts to the changes of DocumentClassicScannerConfiguration.autoSnapEnabled parameter. Hence, you can change this parameter and don't need to call liveDetector.setAutoSnappingEnabled when changing this state by pressing a button.
  • Improved behavior of CroppingController.rotateCw() and CroppingController.rotateCCW(). Now the call can be awaited so you can block UI elements during the rotation animation.
• 🐞 Bug fixes:
  • Fixed a bug with encryption where EncryptionParameters.password had a default empty value which is not correct. Now password is a required parameter to encrypt the data.
  • Fixed documentation for acceptedAngleScore and acceptedSizeScore in DocumentClassicScannerConfiguration. The range changed to 0-100 in percentage values.
  • Fixed behavior of document contour in DocumentScannerCamera. Now it's the same for both platforms.
  • Fixed DocumentCameraLiveDetector.documentContourListener callback. Now it always returns the detection status on iOS.
  • Fixed crash in iOS when partially filled sub-objects of RTU-UI configurations were set.

Version 2.13.1 (20 September 2023)

• 🐞 Bug fixes:
  • Fixed a bug in the RTU-UI Document Scanner due to an issue with config parsing.

Version 2.13.0 (15 August 2023)

• 🎉 New:
  • Added MICRO_QR_CODE barcode format to BarcodeFormat.
  • Added onCameraPreviewStarted callback to custom components to get notified when the camera preview is started. It also runs each time the preview restarts after the picture is taken (Android).
  • Changed behavior of onWidgetReady callback in custom camera components. It is now called when the camera widget is initialized and ready to use. This happens not only once when the widget is created but also when the app returns to the foreground and the user pops to the camera page from another page, if ScanbotCamera.scanbotSdkRouteObserver is registered.
  • Added barcode scanning classic component AR overlay feature.
  • Added BarcodeCameraConfiguration.overlayConfiguration to configure the barcode scanning classic component AR overlay.
• 🚀 Improvements:
  • Refactored behavior colors. The colors in RTU-UI screens that should be displayed as semi-transparent should be used with alpha as follows: fillColor: Colors.red.withAlpha(150).
• 🐞 Bug fixes:
  • Fixed bug with ScanbotSdk.refreshImageUris method on Android. Now it renews uris properly.
  • ScanbotCroppingWidget now properly reacts to the Page object changes. If you reassign a new page to the page property (with a new id), it will reset its content and cropping state to the new state.
  • Fixed a bug when the camera is disabled, the document scanner screen could crash on iOS.
• ⚠️ Breaking Changes:
  • Refactored the structure of ALL RTU-UI scanners configuration classes. Please check example app and documentation for more details.
  • Refactored the way we process and return the data for the Generic Document Scanner and MRZ Scanner. The structure of the result classes for the both scanners are changed to support the GenericDocument structure. Same as the native SDKs. Please check example app and documentation for more details.
  • Refactored imports structure inside scanbot_sdk. Please replace all scanbot_sdk related imports to import 'package:scanbot_sdk/scanbot_sdk.dart'; in your code. For imports with the prefixes please use import 'package:scanbot_sdk/scanbot_sdk.dart' as ScanbotSdk;. Please check example app and documentation for more details.
• 🚙 Under the hood:
  • Default set of params applied for all RTU-UI scanner configs if not specified explicitly.
  • Added dart library dart:collections v.1.17.1 to the internal usage of scanbot_sdk, json_annotation dependency updated to 4.8.1, environment:sdk tool to >=2.17.0 <4.0.0.
  • Updated the native iOS Scanbot SDK to 2.3.1-Beta4 (cf. changelog)
  • Updated the native android Scanbot SDK to 2.3.0 (cf. changelog)

Version 2.12.1 (9 June 2023)

• 🐞 Bug fixes:
  • Fixed a crash in the iOS Classic components for when the scanners were closed multiple times.

Version 2.12.0 (8 May 2023)

• 🎉 New:
  • Added IATA_2_OF_5, INDUSTRIAL_2_OF_5 and CODE_25 barcode formats to BarcodeFormat.
  • Added property recognitionConfidenceValue to McPatientInfoField.
• 🚀 Improvements:
  • Improved behavior of Classic UI components for asynchronous communication with the native SDK.
• ⚠️ Breaking Changes:
  • Changed structure of MedicalCertificateRecognizerResult:
    • McInfoBoxSubType renamed to MedicalCertificateCheckBoxType.
    • McPatientInfoFieldType renamed to MedicalCertificatePatientInfoFieldType.
    • MedicalCertificateInfoBox type split into MedicalCertificatePatientInfoField and MedicalCertificateCheckBox.
    • MedicalCertificateInfoBox.patientInfoFields property now available as MedicalCertificateInfoBox.patientInfoBox.patientInfoFields.
    • DateRecord.validationConfidenceValue removed.
  • Removed parameter decodeStacks1D. The decoding of stacked barcodes is now handled automatically.
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 2.2.0 (cf. changelog)
  • Updated the native Android Scanbot SDK to 2.2.0 (cf. changelog)

Version 2.11.0 (27 March 2023)

• 🎉 New:
  • Introduced Classical Components for the Medical Certificate Scanner that allow you to build your own flexible and fully customizable UI for Scanning German Medical Certificates. Use the classes MedicalCertificateScannerCamera and ScanbotCameraController to build a custom document scanner UI.
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 2.0.0 (cf. changelog)
  • Updated the native Android Scanbot SDK to 2.0.0 (cf. changelog)

Version 2.10.1 (20 January 2023)

• 🎉 New:
  • Introduced Classical Components for Cropping Page that allow you to build your own flexible and fully customizable UI for cropping Page Objects. Use the classes ScanbotCroppingWidget and CroppingController to build a custom cropping UI.
• ⚠️ Breaking Changes:
  • Renamed DetectionResult to DetectionStatus
  • Renamed FinderInsets to Insets
• 🐞 Bug fixes:
  • Fixed enableCameraButtonTitle and enableCameraExplanationText in EHIC and MRZ Scanners
  • Fixed image saving for classical document scanner on android

Version 2.10.0 (17 November 2022)

• 🎉 New:
  • Introduced Classical Components for Document Scanning that allow you to build your own flexible and fully customizable UI for the document scanner. Use the classes DocumentScannerCamera, DocumentCameraLiveDetector, and ScanbotCameraController to build a custom document scanner UI.
  • Added GS1 barcode document to BarcodeDocumentFormat.
• ⚠️ Breaking Changes:
  • Changed file location of Barcode Scanner and Batch Barcode Scanner related classes.
  • Renamed AcceptedDocumentFormat to BarcodeDocumentFormat
  • Renamed CameraOrientationMode to OrientationLockMode
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 1.29.0 (cf. changelog)
  • Updated the native Android Scanbot SDK to 1.96.0 (cf. changelog)

Version 2.9.1 (28 September 2022)

• 🐞 Bug fixes:
  • Fixed compatibility issues with Xcode 14 (build error)
  • Fixed compatibility issues with Kotlin 1.7.10 (build error)

Version 2.9.0 (22 June 2022)

• 🎉 New:
  • Introduced Classical Components for Barcode Scanning that allow you to build your own flexible and fully customizable UI for the barcode scanner. Use the classes BarcodeScannerCamera, BarcodeCameraLiveDetector and ScanbotCameraController to build a custom scanner UI.
• 🚀 Improvements:
  • Improved 1D barcode recognition
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 1.27.1 (cf. changelog)
  • Updated the native Android Scanbot SDK to 1.94.0 (cf. changelog)

Version 2.8.3 (31 May 2022)

• 🚀 Improvements:
  • Updated README

Version 2.8.2 (31 May 2022)

• 🐞 Bug fixes:
  • Fixed compatibility issues with Flutter v3.0.1+

Versions 2.8.1 (16 March 2022)

• 🐞 Bug fixes:
  • Fixed LicenseExpirationDate: Invalid date format.

Version 2.8.0 (8 March 2022)

• 🎉 New:
  • Introduced the Generic Document Recognizer, providing the ability to scan various types of documents, including German ID cards, German passports and German driver's licenses
  • Added detectBarcodesOnImages in ScanbotSdk for detecting barcodes on multiple still images.
  • Android: Added useCameraX in ScanbotSdkConfig. You can now enable CameraX under the hood.
  • Android: Added allowXnnpackAcceleration in ScanbotSdkConfig which allows controlling whether the XNN pack optimizations should be used.
  • Android: Added allowGpuAcceleration in ScanbotSdkConfig which enables GPU acceleration for TensorFlow ML models.
  • Added the ability to disable auto-focus by locking the lens at the specified lens position. See minFocusDistance in BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration
• 🚀 Improvements:
  • Improved Aztec barcode recognition.
  • Improved PDF417 recognition performance on single photos.
  • Improved barcode detection on large documents.
  • Improved GS-1 databar recognition in the next-gen barcode scanner.
• 🐞 Bug fixes:
  • Fixed LicenseExpirationDate returning the incorrect time.
• ⚠️ Breaking Changes:
  • Renamed detectBarcodeFromImageFile parameter to detectBarcodesOnImage
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 1.24.1 (cf. changelog)
  • Updated the native Android Scanbot SDK to 1.91.0 (cf. changelog)

Version 2.7.0 (3 Dec 2021)

• 🎉 New:
  • Added createPageFromBytes function to create a page object without storing a temporary image object outside the SDK
  • Added support for AcceptedDocumentFormats in BarcodeScannerConfiguration, BatchBarcodeScannerConfiguration and detectBarcodeFromImageFile
• 🚀 Improvements:
  • Significant performance improvements for all scanners
• 🚙 Under the hood
  • Updated the native iOS Scanbot SDK to 1.21.2 (cf. changelog)
  • Updated the native Android Scanbot SDK to 1.89.1 (cf. changelog)
• 🐞 Bug fixes:
  • Fixed CroppingResult.error() return for CroppingResult object in the page cropping component

Version 2.6.0 (23 Jul 2021)

• 🎉 New:
  • Brand new "Next Generation" machine-learning-based barcode scanning engine with improved reliability and much faster performance
  • API changes for the new barcode engine: added engineMode property of type EngineMode on barcode scanning APIs - BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration to switch between the legacy barcode engine and the new Next Generation barcode engine. By default, the new engine is used.
  • Added the new cameraZoomFactor property in BarcodeScannerConfiguration for configuring the zoom level of the camera.
  • Added support for MSI Plessey barcodes.
• 🚙 Under the hood
  • Updated the native iOS Scanbot SDK to 1.19.3 (cf. changelog)
  • Updated the native Android Scanbot SDK to 1.85.1 (cf. changelog)
• ⚠️ Breaking Changes:
  • Removed enableHighSensitivityMode property on BarcodeScanner, because it is no longer needed

Version 2.5.0 (2 Jun 2021)

• 🎉 New:
  • Added NFC Passport Reader.
  • Add License Plate scanner for the EU cars license plates.
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 1.15.1 (cf. changelog)
  • Updated the native Android Scanbot SDK to 1.83.0 (cf. changelog)

Version 2.4.1 (1 Apr 2021)

• 🐞 Bug fixes:
  • iOS: Fixed a mapping issue of the config parameter flashButtonHidden in the Document Scanner.

Version 2.4.0 (30 Mar 2021)

• 🎉 New:
  • Add null safety support for the SDK.
• ⚠️ Breaking Changes:
  • Due to null safety support update please follow compilation issues and warnings from 'flutter analyze' command
  • Updated minimum dart sdk to 2.12.0-0 and flutter to 2.0.1

Version 2.3.0 (11 Mar 2021)

• 🎉 New:
  • Encryption for images, PDF, and TIFF files, generated by the SDK. For more details please check out the section Storage Encryption.
  • Blur estimation feature. See the new API function estimateBlurOnPage.
• 🐞 Bug fixes:
  • iOS: Multiple UI fixes for barcode scanners.
• 🚙 Under the hood:
  • Updated the native iOS Scanbot SDK to 1.14.0 (cf. changelog)
  • Updated the native Android Scanbot SDK to 1.80.0 (cf. changelog)

Version 2.2.2 (16 Feb 2021)

• ⚠️ Breaking Changes:
  • Android compileSdkVersion is set to 30
  • Increase flutter min support version to 1.22.6
• 🐞 Bug fixes:
  • Fix compilation for compileSdkVersion 30 for android

Version 2.2.1 (12 Feb 2021)

• 🐞 Bug fixes:
  • Added missing permission text properties enableCameraButtonTitle and enableCameraExplanationText to DocumentScannerConfiguration

Version 2.2.0 (12 Feb 2021)

• 🎉 New:
  • Batch Barcode Scanner - a new RTU-UI screen component to scan multiple barcodes in a row. See the new API function startBatchBarcodeScanner.
  • Added barcode detection from still images, see detectBarcodeFromImageFile.
  • New result field BarcodeItem.rawBytes that contains the raw bytes from the scanned barcode.
• ⚠️ Breaking Changes:
  • Replaced finderAspectRatio parameter with finderWidth and finderHeight in BarcodeScannerConfiguration and MrzScannerConfiguration.
• 🚙 Under the hood:
  • Updated the native Android Scanbot SDK to 1.77.2 (cf. changelog)
  • Updated the native iOS Scanbot SDK to 1.13.0 (cf. changelog)

Version 2.1.0 (15 Dec 2020)

• 🐞 Bug fixes:
  • iOS: Introduced a new API method refreshImageUris(pages) to fix image file paths after app updates.
  • iOS: Fixed de-/serialization of the property Page.detectionStatus.

Version 2.0.1 (28 Nov 2020)

• 🚀 Improvements:
  • iOS: Swift 5 support

Version 2.0.0 (30 Oct 2020)

• 🎉 New:
  • A new Machine Learning based approach for document detection. See the new SDK initialization parameter documentDetectorMode.
  • Barcode Scanner: Added barcode data parsers for several document types. See the new result field BarcodeItem.formattedResult as well as the corresponding implementations of BarcodeFormattedResult.
• 🚀 Improvements:
  • Android: Some big improvements in the Document Scanner UI that make document scanning perform better and much smoother. Decreased start-up time of the camera preview. Faster saving of the snapped pages. Optimized performance of the image processing for simple operations (rotate, crop, resize).
  • Barcode Scanner: Multi-barcode scan support!
• ⚠️ Breaking Changes:
  • Android: Migrated to Android embedding v2
  • Android: Raised minSdkVersion to 21
  • iOS: Dropped support for iOS 9 and iOS 10!
• 🚙 Under the hood:
  • Upgraded the native Scanbot Android SDK to v1.74.0 (cf. changelog)
  • Upgraded the native Scanbot iOS SDK to v1.11.6 (cf. changelog)

Version 1.1.4 (29 Sep 2020)

• 🚀 Improvements:
  • iOS: Changed presenter logic for all Scanbot SDK RTU-UI screens.

Version 1.1.3 (27 Aug 2020)

• 🐞 Bug fixes:
  • iOS: Fixed a mapping issue of the config parameter doneButtonTitle in Cropping UI.

Version 1.1.2 (28 May 2020):

• 🚀 Improvements:
  • OperationResult.CANCELED when the user presses cancel in any Scanbot UI screen component

Version 1.1.1 (13 May 2020):

• 🐞 Bug fixes:
  • Android: Fixed a bug with mappings of OCR language data files (zh-Hans and zh-Hant to chi_sim.traineddata and chi_tra.traineddata).

Version 1.1.0 (9 Dec 2019):

• 🎉 New:
  • Added further TIFF options dpi and compression.
• 🚀 Improvements:
  • Improved OCR API. The OCR results now contain bounding boxes and values of recognized words, lines and paragraphs. See the API docs of OcrResult.pages for more details.
• 🐞 Bug fixes:
  • iOS: Fixed file URI handling in the native implementation of the createPage() method.

Version 1.0.0 (6 Nov 2019):

• 🎉 First release.

Want to scan longer than one minute?

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

Get your free Trial License

Was this helpful?