Skip to main content

Changelog for the React Native Data Capture Modules

tip

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

Version 9.0.2 (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:
    • Upgraded the native Scanbot iOS SDK to v9.0.2.

Version 9.0.1 (20 Jul 2026)​

  • 🐞 Bug fixes:
    • Document Scanner:
      • ScanbotDocumentScannerView:
        • Android: Fixed an issue where a black screen was displayed after granting camera permission.
    • Barcode Scanner:
      • ScanbotBarcodeCameraView:
        • Android: Fixed an issue where a black screen was displayed after granting camera permission.

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

Version 8.0.0 (17 Mar 2026)​

  • πŸŽ‰ New:
    • General:
      • The SDK now supports a new license key format, which does not contain special characters or line breaks.
      • All of the API functions that accept an image file URI as an input, now accept both image file URI and ImageRef object.
      • Introduced the ScanbotPdfImageExtractor object to encapsulate and manage all SDK functionalities related to extracting images from a PDF.
      • Introduced the ScanbotLegacyPage object to encapsulate and manage all SDK functionalities related to the legacy Page object.
      • Added a new class SdkConfiguration to replace the previous ScanbotSdkConfiguration type for SDK initialization.
      • Added a new class LicenseInfo to replace the previous LicenseInfoResult type for license information retrieval.
      • Added a new property processingMode to all scanner configuration types to enhance processing flexibility.
      • Added a new property cameraLiveScannerResolution to CameraConfiguration for configuring live scanner resolution in all RTU-UI scanners.
      • ImageRef now supports HEIC images.
    • Document Scanner:
      • Introduced the ScanbotDocument object to encapsulate and manage all SDK 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.
      • Added a new type literal TextWithBadgeButtonMode to PreviewButton for preview mode in the RTU-UI scanner.
      • Two new DocumentDetectionStatus values have been introduced: ERROR_PARTIALLY_VISIBLE and ERROR_PARTIALLY_VISIBLE_TOO_CLOSE.
      • ScanbotDocumentScannerView:
        • Added a new property acceptedAspectRatioScore that defines the minimum score in percent (0 - 100) for accepting a detected document based on its aspect ratio.
        • Added a new property detectDocumentAfterSnap that allows enabling/disabling document detection after snapping a document.
        • Added a new property partiallyVisibleDocumentConfiguration that allows configuring the behavior of the scanner for partially visible documents.
        • Added a new onError callback to handle errors, providing more detailed error information for better debugging and user feedback.
    • Image Processing:
      • Introduced the ScanbotImageProcessor object to encapsulate and manage all SDK functionalities related to image processing.
      • Added new capabilities to resize and crop images.
      • The color document filter now has parameters controlling contrast, color, and paper enhancement.
      • Added a new property colorConversion to 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.
    • PDF Generator:
      • Introduced the ScanbotPdfGenerator object to encapsulate and manage all SDK functionalities related to creating PDF files.
    • TIFF Generator:
      • Introduced the ScanbotTiffGenerator object to encapsulate and manage all SDK functionalities related to creating TIFF files.
    • OCR Engine:
      • Introduced the ScanbotOcrEngine object to encapsulate and manage all SDK functionalities related to optical character recognition.
      • Introduced a new API recognizeOnDocument that performs OCR on a provided DocumentData object.
      • Added a new improved class PerformOCRResult to replace the previous PerformOCRResult type for OCR results.
    • 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.
    • MRZ Scanner:
      • Introduced the ScanbotMrz object to encapsulate and manage all SDK functionalities related to scanning MRZ.
    • Text Pattern Scanner:
      • Introduced the ScanbotTextPattern object to encapsulate and manage all SDK functionalities related to text pattern scanning.
      • Added a new property optimizeSingleLine to TextPatternScannerConfiguration. Enable this option when scanning a single line or a single word that is hard to scan reliably. Disabled by default.
    • VIN Scanner:
      • Introduced the ScanbotVin object to encapsulate and manage all SDK functionalities related to VIN scanning.
      • Added a new property optimizeSingleLine to VinScannerConfiguration for improved single line VIN scanning.
    • Document Data Extractor:
      • Introduced the ScanbotDocumentDataExtractor object to encapsulate and manage all SDK functionalities related to extracting data from documents.
      • Added a new metadata child document to all supported formats.
      • Added a new countryCode property to all supported formats.
      • Added a new type literal PERSONAL_ID in CommonFieldType.
    • Check Scanner:
      • Introduced the ScanbotCheck object to encapsulate and manage all SDK functionalities related to check scanning.
      • Support a wider range of USA check formats.
    • Credit Card Scanner:
      • Introduced the ScanbotCreditCard object to encapsulate and manage all SDK functionalities related to credit card scanning.
    • Barcode Scanner:
      • Introduced the ScanbotBarcode object to encapsulate and manage all SDK functionalities related to barcode scanning.
      • Added a new API parseDocument for parsing barcode documents from raw text values.
      • Added a new API scanFromPdf for scanning barcodes from PDF documents.
      • New supported document parser for British Columbia driver licenses PDF417 codes.
      • Introduced a new algorithm for recognizing 1D symbologies (except EAN and UPC), enhancing performance with blurred and distant barcodes. This feature is enabled by default but can be turned off using the enableOneDBlurScanner property in barcode format configurations on low-power devices if necessary.
      • Added a new barcode scanner engine mode called NEXT_GEN_MAX_DISTANCE, which is optimized for scanning from far distances on very high-power devices with a 4K video stream.
      • All 1D barcode formats can be configured with a new oneDConfirmationMode which is THOROUGH by default. Setting it to MINIMAL or NONE could lead to higher recall in difficult scenarios, but could also cause more false positives.
      • ScanbotBarcodeCameraView:
        • Introduced a new onError callback to handle errors, providing more detailed error information for better debugging and user feedback.
  • πŸš€ Improvements:
    • General:
      • All APIs can now return more complete errors with error messages.
      • All OCR-based features now benefit from new OCR models that are optimized for speed and accuracy.
      • The "Created TensorFlow Lite XNNPACK delegate for CPU." log is no longer an output in production builds.
      • Android: Optimized memory usage of Scanbot Camera components.
      • Android: Improved RTU UI components padding behavior for finder view and action bars.
      • iOS: Camera sessions no longer show a black screen in case of license error. Instead, the camera runs but the detection fails with appropriate license error.
      • iOS: Implemented keepScreenOn property for all RTU-UI screens to prevent the system from going idle or entering the lockscreen while scanning.
    • Document Scanner:
      • Aspect ratio scores are now symmetrical, and low scores are more consistent.
      • Now correctly returns ERROR_TOO_DARK when nothing is detected and the image brightness is below the threshold.
      • Android: The Document API now returns cached document objects. This means if you load a DocumentData once, it will remain in memory during the app session and be returned when loaded from another location.
      • Android: Fixed an issue with double compression for document images during rotation or filtering operations that significantly increased the size of the original and other PageData images.
    • Cropping Screen:
      • iOS: Added support for selecting and moving individual corners in the cropping screen using a hardware keyboard. Press the tab key to cycle through the corner and edge handles. Use the arrow keys to move the selected corner or edge handle. Hold shift while pressing the arrow keys to move faster.
      • iOS: Improved cropping handle movement, preventing irregular polygons and glitches.
      • ScanbotCroppingView:
        • Improved the onError callback to provide more detailed error information for better debugging and user feedback.
    • Image Processing:
      • All image processing methods now accept both image file URIs and ImageRef objects as inputs. If working with image file URIs, the ability to overwrite the original image file is now supported via the overwrite parameter.
      • The color document filter now preserves colors better by default.
      • Removed unused image filter models, saving about 2.4MB from binaries.
    • PDF Generation:
      • PDF generation now supports binarized images. Binarized images are stored in the PDF with an optimized compression algorithm, resulting in extremely small file sizes.
    • Document Quality Analyzer:
      • Improved performance.
      • If provided configuration is invalid, an error will be returned instead of changing invalid fields to default values.
    • OCR Engine:
      • Improved detection of text, specifically for lines that are close together.
    • Document Data Extractor:
      • Improved FrameAccumulation logic.
      • Increased accuracy, specifically fewer false positives.
      • General speed improvements.
      • Glare detection now works more reliably, especially on iOS.
    • Credit Card Scanner:
      • Higher recall for expiry date detection.
      • Improved FrameAccumulation logic.
    • Barcode Scanner:
      • Improved quiet zone checks for the barcode format PharmaCode to reduce the false positive rate.
      • Reduced the false positive rate of blurred barcodes in live mode when the barcode is only partially visible.
  • 🐞 Bug fixes:
    • General:
      • 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.
    • Document Scanner:
      • Now correctly returns ERROR_TOO_DARK when nothing is detected and the image brightness is below the threshold.
      • iOS: Fixed a bug that left a temporary copy of captured images on disk when scanning with the RTU-UI document scanner. These images can be cleaned up using the ScanbotLegacyPage.removeAllPages API. Note that this will remove all legacy pages. If needed, make sure to migrate to the new document objects using the ScanbotDocument.createDocumentFromLegacyPages API before removing all legacy pages.
      • Android: Fixed the title counter update in the review step for 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.
      • ScanbotDocumentScannerView:
        • Fixed default colors of the finder and polygon.
    • 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:
      • Fixed an issue where the use case could not find UPC and EAN barcodes with extensions in RTU-UI screen.
      • Fixed a bug in Barcode RTU-UI Multiple Scanning Mode where the count of the sheet button was not updated properly.
  • ⚠️ Breaking changes:
    • General:
      • Removed react-native-scanbot-sdk/ui_v2. All types, constants, and functions previously imported from this path should now be accessed via the new dedicated objects in react-native-scanbot-sdk (e.g., use ScanbotTextPattern.startScanner instead of startTextPatternScanner). Update your imports and usage accordingly.
      • Removed the ScanbotSdkConfiguration type. The initialize method now requires an instance of the SdkConfiguration class. Update your initialization code accordingly.
      • Removed LicenseInfoResult in favor of the new LicenseInfo class. Update your code to use the LicenseInfo class for license information retrieval.
      • Removed the property scanningMode from scanner configurations where processingMode property was added.
      • Replaced type literal IF_AVAILABLE with AUTO in EncryptionMode.
      • Renamed property roi to cropRect in all image load options types for better clarity.
      • Renamed initializeSDK to initialize, getOCRConfigs to getOcrConfigs, and cleanup to cleanupStorage in ScanbotSDK.
      • Renamed extractImagesFromPdf to extractImageFiles in ScanbotPdfImageExtractor. The method signature and result were also changed.
      • Renamed class Categories to Category.
      • Renamed class Languages to Language.
      • Moved globally exported constants for generic document fields and types into their respective classes to improve organization.
      • Removed clone() method from ImageRef.
    • Feature removal:
      • Removed all RTU-UI v1 scanners and related types. All RTU-UI scanners have been upgraded to RTU-UI v2.
      • Removed the following deprecated legacy Page operations: applyImageFiltersOnPage, createPage, rotatePage, detectDocumentOnPage, and extractPagesFromPdf.
      • 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:
      • Renamed detectDocument to scanFromImage in ScanbotDocument. The method now returns a DocumentScanningResult object instead of DocumentDetectionResult.
      • Renamed createDocument to createDocumentFromImages in ScanbotDocument. The function signature has changed to accept an array of image inputs.
      • Renamed addPage to addPages in ScanbotDocument. The function signature has changed to accept an array of image inputs.
      • Renamed removePage to removePages in ScanbotDocument. The function signature has changed to accept an array of page indices.
      • Renamed storedDocumentIDs to getStoredDocumentIDs in ScanbotDocument.
      • Removed result wrappers for the following ScanbotDocument methods: documentExists, getStoredDocumentIDs. These methods now return their results directly.
      • Restructured function signatures and parameters in several ScanbotDocument methods for improved usability.
      • ScanbotDocumentScannerView:
        • Replaced the onDetectionResult callback with the improved onFrameDetectionResult callback that provides more detailed information about the detected document.
        • Replaced the onDocumentScannerResult callback with the improved onSnappedDocumentResult callback that provides a result that includes the original image, the cropped image, and DocumentDetectionResult.
        • Renamed property requiredAspectRatios to aspectRatios.
    • Image Processing:
      • The ColorDocumentFilter now works slightly differently by default. To get the previous behavior, set paperWhitening=0 and paperWhiteningBias=64.
      • The behavior of the LegacyImageFilter was changed to be a no-op. The class is kept only for migration purposes. It is now required to migrate to the other parametric filters.
      • Renamed getImageData to readImageData in ScanbotImageProcessor.
      • Removed static method fromImageFilterType from LegacyFilter.
    • PDF Generator:
      • Renamed the method createPDF in ScanbotSDK to generateFromImages and moved it to the ScanbotPdfGenerator object.
      • Renamed the method createPDF in ScanbotSDK.Document to generateFromDocument and moved it to the ScanbotPdfGenerator object.
      • generateFromImages and generateFromDocument now return the PDF file URI as a result instead of CreatePDFResult.
    • TIFF Generator:
      • Renamed the method writeTIFF in ScanbotSDK to generateFromImages and moved it to the ScanbotTiffGenerator object.
      • Renamed the method createTIFF in ScanbotSDK.Document to generateFromDocument and moved it to the ScanbotTiffGenerator object.
      • generateFromImages and generateFromDocument now return the TIFF file URI as a result instead of WriteTIFFResult.
    • Document Quality Analyzer:
      • Renamed documentQualityAnalyzer to analyzeQualityOnImage.
    • OCR Engine:
      • recognizeOnImage and recognizeOnDocument methods in ScanbotOcrEngine now return an instance of the PerformOCRResult class instead of the PerformOCRResult type.
    • MRZ Scanner:
      • Renamed recognizeMrz to scanFromImage in ScanbotMrz.
    • Document Data Extractor:
      • No longer returns crops by default. This can be re-enabled in the configuration.
      • Renamed documentDataExtractor to extractFromImage in ScanbotDocumentDataExtractor.
      • Replaced DocumentDataExtractionStatus type literals SUCCESS, INCOMPLETE_VALIDATION, ERROR_STILL_FOCUSSING with OK, OK_BUT_INVALID_DOCUMENT, OK_BUT_NOT_CONFIRMED, SCANNING_IN_PROGRESS_STILL_FOCUSING.
    • Check Scanner:
      • Renamed recognizeCheck to scanFromImage in ScanbotCheck.
    • Credit Card Scanner:
      • Renamed recognizeCreditCard to scanFromImage in ScanbotCreditCard.
    • Barcode Scanner:
      • Renamed startBarcodeScanner to startScanner in ScanbotBarcode.
      • Renamed detectBarcodesOnImage to scanFromImage in ScanbotBarcode.
      • Changed the type of the scannerConfiguration property in BarcodeScannerScreenConfiguration from CommonBarcodeScannerConfiguration to BarcodeScannerConfiguration.
      • The MICRO_QR_CODE barcode format has been removed from the list of common barcode formats.
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v8.0.1.
    • Upgraded the native Scanbot iOS SDK to v8.0.4.
    • Upgraded libzueci lib dependency to 1.0.1.
    • Added snowflake-arctic-embed-xs lib dependency to eadfba3b.
    • Android: libittnotify is no longer linked.
    • Android: Reduced the size of the native Android SDK by approximately 2 MB by removing TESSERACT assets.
    • 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.

Version 7.1.1 (5 Nov 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 US check field documentation.
      • Improve handling of scanning result when detection mode DETECT_AND_CROP_DOCUMENT is set.
  • 🐞 Bug fixes:
    • Document Scanner:
      • Fix serialization of DocumentData class.
      • iOS: Fixed a bug in RTU-UI that did not always crop images from the photo library.
      • Android: Fixed issue with empty documentQuality when acknowledgementMode was set to BAD_QUALITY.
      • Android: Fixed a bug where the usage guidance wouldn't show properly on screen startup.
      • Android: Fixed image size on review screen when screen is in horizontal layout.
      • ScanbotDocumentScannerView:
      • Fixed an issue where snapDocument command did not work for old architecture on iOS.
    • 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 user interface that prevented the proper display of the view finder in landscape mode.
      • Android: Fixed 16 kb page size support for TFLite native library.
  • ⚠️ Breaking changes:
    • Barcode Scanner:
      • The field minConfirmationsStandaloneEAN in BarcodeAccumulationConfiguration was moved and renamed to the field minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless in BarcodeFormatUpcEanConfiguration.
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot iOS SDK to v7.1.4.
    • Upgraded the native Scanbot Android SDK to v7.1.2.

Version 7.1.0 (18 Sep 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:
    • 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.
      • ScanbotBarcodeCameraView:
        • Introduced a new optional callback onBarcodeTap which is triggered when the user taps on a barcode AR overlay.
        • Added a new property accumulationConfig in BarcodeCameraViewScannerConfiguration for configuring accumulated barcodes across multiple frames in live mode.
        • Added a new property optimizedForOverlays in BarcodeCameraViewScannerConfiguration that is used to produce more stable barcode outlines across frames.
    • General:
      • Added a new classic component, ScanbotCroppingView. Learn more about it here.
      • 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 ScanbotSdkConfiguration. 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.
      • ScanbotDocumentScannerView:
        • Introduced a boolean parameter to snapDocument to enable camera focus when set to true.
    • 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.
    • 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.
      • Android: Updated custom CameraX ConfigProvider logic for Kiron devices.
  • 🐞 Bug fixes:
    • Document Scanner:
      • Fixed a bug in RTU-UI v2 Document Scanner where auto rotation was applied if no document was detected.
      • 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.
      • iOS: Fixed an issue on simulators where the shutter button was missing in the RTU-UI Document Scanner.
      • iOS: Fixed an issue where documents were incorrectly rotated when using modifyPage.
      • Android: Fixed an issue in RTU-UI v2 where multiple manual snaps in "single page" mode caused invalid screen behavior.
      • Android: Fixed an issue in RTU-UI v2 where autofocus failed during the autosnap event.
      • 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.
      • ScanbotDocumentScannerView:
        • Fixed an issue where document capturing produced an invalid result when image orientation was provided.
    • 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.
    • 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.
    • 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 GS1 Handling DecodeStructure and DecodeFull.
      • Android: Barcode Scanner RTU UI v2: fixed an issue where the back button navigation did not work.
    • Storage Crypting:
      • iOS: Fixed data corruption issues in AES encryption/decryption that could result in corrupted or partially corrupted files.
    • General:
      • Fixed a rare division by zero crash in Credit Card Scanner, Document Data Extractor, and MRZ Scanner.
      • iOS: Fixed a bug with scanned documents cloning when using per-file encryption.
      • Android: Fixed handling of the back actions for modal dialogs in RTU-UI v2.
      • Android: Prevent throwing exception when /sys/devices/system/cpu/cpufreq doesn't exist.
      • Android: Fixed an issue with the black previews in classic components when the camera selected a square resolution on some Samsung and Xiaomi devices.
  • ⚠️ Breaking Changes:
    • Barcode Scanner:
      • ScanbotBarcodeCameraView:
        • Removed automaticSelectionEnabled property from SelectionOverlayConfig. Each scanned barcode is sent to the onBarcodeScannerResult callback.
    • VIN Scanner:
      • Renamed RTU v1 VinScannerConfiguration to VinScannerScreenConfiguration.
    • Check Scanner:
      • Moved acceptedCheckStandards configuration from the function signature into CheckScannerConfiguration object for recognizeCheck.
    • Document Data Extractor:
      • Removed startDocumentDataExtractor and closeDocumentDataExtractor 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 ScanbotSdkConfiguration.
  • ⚠️ Deprecations:
    • Marked startCheckScanner and closeCheckScanner RTU UI v1 as deprecated. Please see the new RTU UI v2 Check Scanner.
    • Marked startVinScanner and closeVinScanner RTU UI v1 as deprecated. Please see the new RTU UI v2 VIN Scanner.
    • Marked refreshImageUris, applyImageFiltersOnPage, createPage, rotatePage, removePage, setDocumentImage, detectDocumentOnPage and extractPagesFromPdf as deprecated.
  • πŸš™ 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 (27 Jun 2025)​

  • 🐞 Bug Fixes:
    • Document Scanner:
      • iOS: Fixed a memory leak when dealing with grayscale images.
  • πŸš™ Under the hood:
    • Support for RN 0.80.
    • Upgraded the native Scanbot iOS SDK to v7.0.3.

Version 7.0.0 (16 Jun 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. Enabled by default.
      • Introduced advanced generation settings for PDFs and TIFFs.
      • 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 β€” triggered when a document is detected under poor lighting conditions.
    • Document Quality Analyzer (DoQA):
      • Can now return the orientation of the document. Enabled by DocumentQualityAnalyzerConfiguration.detectOrientation.
      • Optionally returns a qualityHeatmap.
      • Added support for an advanced on-image scanning configuration documentQualityAnalyzer call.
    • Credit Card Scanner:
    • MRZ:
      • New RTU UI v2 is now available for MRZ Scanner. See startMRZScanner.
      • Added support for non-ICAO conformant machine-readable zones on US border crossing cards.
    • Text Pattern Scanner:
    • VIN Scanner:
      • Added a new property extractVINFromBarcode in VinScannerConfiguration that allows VIN data extraction from barcodes.
    • Document Data Extractor (DDE) (formerly Generic Document Recognizer):
      • 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 an advanced on-image scanning configuration for: documentDataExtractor, recognizeEHIC, recognizeMedicalCertificate, recognizeMrz, recognizeCheck.
    • 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.
      • 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) and NEXT_GEN_LOW_POWER_FAR_DISTANCE (optimized for scanning from far 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.
    • 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 (for ex, BarcodeFormatValues).
    • Android: Added a new property keepScreenOn in all RTU-UI v2 scanner screen configurations to keep the device screen awake while scanning.
    • ScanbotBarcodeCameraView: Added a new refreshRate property to BarcodeItemOverlayViewConfig.
    • ScanbotDocumentScannerView: Orientation mismatches on the document can now be ignored in the result.
  • πŸš€ Improvements:
    • Document Scanner:
      • Added OK_ORIENTATION_MISMATCH status, returned when screen and document orientations don't match. Can be ignored via configuration.
      • Improved DocumentScannerUserGuidance by providing orientationMismatch label.
      • Improved the Document Scanner RTU-UI v2 acknowledgment's bad image quality hint by adding the ability to present up to 5 lines.
      • 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.
    • Document Quality Analyzer (DoQA):
      • Guarantee the same document quality score for 90 degrees rotated images.
    • 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.
    • MRZ:
    • 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 (DDE):
      • Digits can no longer be recognized as part of given names or surnames.
      • Higher accuracy for document classification.
    • 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.
    • Added new accessibility descriptions for the buttons in ActionBarConfiguration.
  • 🐞 Bug Fixes:
    • Document Scanner and Data Capture modules:
      • Fixed Document Scanner point sorting.
      • Fixed Document Data Extractor bug determining validation status when fields excluded.
      • Fixed Document Data Extractor incorrect handling of Driver License expiry date validation.
      • Fixed DDE merging of maidenName and surname on some German ID cards.
      • Fixed DoQA crash when maxImageSize was 0.
      • Fixed DoQA patch size when minFraction = 1.
      • Resolved DDE high peak memory consumption issue.
      • Fixed Text Pattern Scanner incorrect output for Unicode symbols.
      • Clamped parametric filters radius to 127.
      • 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 autoSnapProgress fillColor.
      • iOS: Fixed processing of still images of an indexed color space model in all scanners, DoQA, and PDF/TIFF generators.
      • iOS: Fixed an issue where the result status returned "OK" even when the screen was canceled. The status now correctly returns "CANCELED".
      • 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: 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 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: Fixed Check Scanner User Guidance default background (was absent) for RTU-UI v1.
      • 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 Code11 barcodes with 10 data digits, when checksum is enabled and stripCheckDigits is true, scanner now correctly strips both check digits.
      • 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 SBSDKBaseScannerViewController 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.
    • ScanbotBarcodeCameraView:
      • Android: Fixed the resolution strategy for the square preview.
      • Android: When barcodeItemOverlayViewBinder callback is set, textFormat property in selectionOverlayConfig for Classic UI is considered.
    • 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:
    • ResultWrapper has been removed from all API responses, except those returned by RTU UI.
    • initializeSDK now returns a LicenseInfoResult instead of the previous result format.
    • RTU-UI v1 Removal:
      • Removed RTU-UI v1 APIs: startMrzScanner, startTextDataScanner, startBarcodeScanner, startBatchBarcodeScanner, startLicensePlateScanner and related types. Use corresponding RTU UI v2 methods.
    • Feature renaming:
      • Renamed startGenericDocumentRecognizer to startDocumentDataExtractor and related types from GenericDocumentRecognizer to DocumentDataExtractor.
      • Renamed startCheckRecognizer to startCheckScanner and related types from CheckRecognizer to CheckScanner.
      • Renamed startMedicalCertificateRecognizer to startMedicalCertificateScanner and related types from MedicalCertificateRecognizer to MedicalCertificateScanner.
      • Renamed recognizeGenericDocument to documentDataExtractor.
      • Renamed Text Data Scanner (also Generic Text Recognizer) to Text Pattern Scanner.
    • Result Type Changes:
    • Configuration Object Changes:
    • Document Scanner Configuration:
    • VIN Scanner Configuration:
      • Renamed minimumNumberOfRequiredFramesWithEqualRecognitionResult to minimumNumberOfRequiredFramesWithEqualScanningResult in VinScannerConfiguration.
    • ScanbotBarcodeCameraView:
      • detectorConfig replaced with barcodeScannerConfiguration.
      • onBarcodeScannerResult callback parameter is now BarcodeItem[].
      • barcodeItemOverlayViewBinder callback parameter is now BarcodeItem.
      • Renamed type FinderInset to CameraViewFinderInset.
      • Renamed type AspectRatio to CameraViewAspectRatio.
    • ScanbotDocumentScannerView:
      • Renamed type AspectRatio to CameraViewAspectRatio.
      • Removed property ignoreBadAspectRatio; use requiredAspectRatios.
    • Changed default text values for CameraPermission styled texts.
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v7.0.2.
    • Upgraded the native Scanbot iOS SDK to v7.0.2.
    • Upgraded nlohmann::json to 3.11.3.
    • Upgraded xsmid 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.0
    • Android: Android Jetpack Compose updated to 1.7.8.
    • Android: Updated Compile Sdk to 35.
    • Android: Upgrade OpenCV to 4.10.
    • iOS: The regex filters are applied for substrings instead of the entire output string.
    • iOS: Upgraded CLI11 to 2.5.

Version 6.2.1 (21 Mar 2025)​

  • 🐞 Bug fixes:
    • iOS: Resolved an issue where the iOS build failed when use_frameworks! was enabled in the Podfile.

Version 6.2.0 (18 Feb 2025)​

  • πŸŽ‰ New:
    • Added a new classic component, ScanbotDocumentScannerView. Learn more about it here.
    • Added a new callback barcodeItemOverlayViewBinder as a part of SelectionOverlayConfig in ScanbotBarcodeCameraView, that configures the selection overlay for each barcode item individually.
    • Barcode Scanner RTU-UI v2:
      • Added accessibility description strings for flash, zoom and flip camera buttons.
    • Document Scanner RTU-UI v2:
      • Added support for setting magnetic line color in cropping screen.
      • Added an option to suppress auto-cropping on manual snaps.
      • Added a configurable title for the acknowledge screen.
  • πŸš€ Improvements:
    • Android: Document Scanner RTU-UI v2: The Review Screen zoom button now allows its text to be hidden.
    • Android: Improved ScanbotCameraX resolution selection strategies for scanning, and preview cases.
    • iOS: The Generic Document Recognizer no longer needs the additional data bundle with OCR languages.
    • iOS: The Generic Document Recognizer now returns ID number (document number field) and sequence number (personal number field) separately for pre-2022 Costa Rican passports.
  • 🐞 Bug fixes:
    • Fixed the returned result when submitting a document without any changes in the cropping UI.
    • iOS: Fixed layout when hiding the text of the close button on zooming in RTU-UI v2 Document Scanner.
    • iOS: Fixed a layout bug in the RTU-UI v2 cropping screen's top bar.
    • Android: Fixed potential issue with ScanbotBarcodeCameraView during onDestroy when the AR overlay is displayed.
    • Android: Fixed nested views of ScanbotDocumentScannerView and ScanbotBarcodeCameraView when readjusting the parent view size.
    • Android: Cropping RTU-UI v2: Now returns successfully when the crop has not been adjusted and the apply button is pressed.
    • Android: Document Scanner RTU-UI v2: The horizontal layout camera bar now has a fixed width.
  • ⚠️ Breaking Changes:
    • shouldHighlight callback is removed from SelectionOverlayConfig in ScanbotBarcodeCameraView together with highlighted color properties. Please use the new barcodeItemOverlayViewBinder callback that configures the selection overlay for each barcode item individually.
  • πŸš™ Under the hood:
    • Support for RN 0.77
    • Upgraded the native Scanbot Android SDK to v6.2.1.
    • Upgraded the native Scanbot iOS SDK to v6.2.0.
    • Android: Updated androidx camerax 1.4.1 with 16kb page support.
    • iOS: Removed third-party-library symbols from the binary to avoid linking conflicts.

Version 6.1.1 (12 Dec 2024)​

  • 🐞 Bug fixes:
    • Fixed a bug where legacy Page couldn't be reused if the documentImageSizeLimit property was set on creation.

Version 6.1.0 (5 Dec 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 react-native-scanbot-sdk/ui_v2. See full documentation here.
    • Implemented new Document API to perform document creation and editing.
    • Added support for German health insurance cards (front side) and European health insurance cards to startGenericDocumentRecognizer and recognizeGenericDocument. Added literals DE_HEALTH_INSURANCE_CARD_FRONT and EU_HEALTH_INSURANCE_CARD to GenericDocumentType. Added EuropeanHealthInsuranceCardDocumentType and DeHealthInsuranceCardFrontDocumentType to DocumentsModelRootType.
    • Added support for new barcode types Maxicode, rMQR code, Code 11 and Code 32. Added literals that represent the new barcode types in BarcodeFormat.
    • Added a new optional property licenseStatusMessage in GetLicenseInfoResult.
    • Added a new optional property addAdditionalQuietZone in DetectBarcodesOnImageArguments. The default value is false.
    • 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 optional property encryptedImageFiles in CreatePDFArguments. The default value is false.
    • 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, BarcodeRecognizerConfiguration and DetectBarcodesOnImageArguments.
    • Added the ability to display the scanned barcode's image in the RTU-UI V2 Barcode Scanner FindAndPickScanningModeUseCase by specifying ExpectedBarcode.barcodeImageKey for the expected barcode's image property.
    • Added a new type literal CONFIRMED in ValidationStatus type in GenericDocument.
    • 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 a new property polygonInRoot in Field type used in GenericDocument.
    • 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.
    • The Generic Document Recognizer now uses the new SCANBOT_OCR engine under the hood. In order to scan generic documents, the additional OCR language data bundle is no longer required.
    • 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.
    • iOS: Fixed a bug where acceptedDocumentFormats where not accepted in recognizeGenericDocument.
    • 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:
    • React Native SDK 0.73 is the minimum supported version.
    • Deprecated startDocumentScanner, startFinderDocumentScanner, startCroppingScreen and related configurations and result types. See RTU-UI v2 Document Scanner.
    • Deprecated startEHICScanner, recognizeEHIC and related configurations and result types.
    • Removed property codeDensity from BarcodeScannerConfiguration, BatchBarcodeScannerConfiguration, BarcodeRecognizerConfiguration and DetectBarcodesOnImageArguments.
    • Removed property sharpnessAcceptanceFactor from GenericDocumentRecognizerConfiguration and RecognizeGenericDocumentArguments.
    • Removed type literals VALIDATE and DECODE and replaced them with VALIDATE_STRUCTURE, DECODE_STRUCTURE, VALIDATE_FULL and DECODE_FULL in Gs1HandlingMode.
    • Removed type literals SUCCESS_FOUND and ERROR_TOO_BLURRY and added new ERROR_UNKNOWN_DOCUMENT,ERROR_UNACCEPTABLE_DOCUMENT and INCOMPLETE_VALIDATION in RecognitionStatus.
    • Renamed type DetectionStatus to DocumentDetectionStatus and removed OK_BARCODE type literal.
    • 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.
    • 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.
    • iOS: Added optional property displayText in Field.Type.
    • iOS: rotatePage rotates clockwise with negative values.
  • πŸš™ 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.1 (13 Sep 2024)​

  • πŸŽ‰ New:
    • Expo config plugin is now available for Expo projects.
  • πŸš€ Improvements:
    • ScanbotBarcodeCameraView: Improved attachment and detachment of the barcode scanner.
  • 🐞 Bug fixes:
    • iOS: Fixed a crash when using React Native versions below 0.72.

Version 5.1.0 (26 Aug 2024)​

  • πŸŽ‰ New:
    • Added new freshly designed RTU-UI version 2 for Barcode scanning with advanced agile configuration. Import startBarcodeScanner from react-native-scanbot-sdk/ui_v2 to leverage the new UI. See our updated documentation for a full set of examples and use cases.
    • Added new data recognizers on still images: recognizeMedicalCertificate, recognizeEHIC, recognizeGenericDocument.
    • Added support for new barcode format MICRO_PDF_417. MICRO_PDF_417 literal added to type BarcodeFormat.
    • Added support for parsing of AAMVA Certificate of Title for motor vehicle barcodes.
    • Added support for Canadian and UAE Check standards. UAE and CAN literals added to type CheckStandard.
    • Added support for German residence permits (2011 and 2019 formats) in GenericDocumentRecognizer. DE_RESIDENCE_PERMIT_FRONT and DE_RESIDENCE_PERMIT_BACK literals added to type GenericDocumentType. Wrapper classes added for the generic document result (DeResidencePermitFront, DeResidencePermitBack).
    • Added new class-based image filters ParametricFilters:
      • ScanbotBinarizationFilter
      • CustomBinarizationFilter
      • ColorDocumentFilter
      • BrightnessFilter
      • ContrastFilter
      • GrayscaleFilter
      • WhiteBlackPointFilter
      • LegacyFilter (encapsulates the deprecated ImageFilterType filters)
    • Added new VALIDATION_FAILED literal to type CheckStatus.
    • Added new type DocumentQualityAnalyzerArguments to better describe the input parameters for documentQualityAnalyzer.
    • Added new type HealthInsuranceCardFieldType to better describe the type property in HealthInsuranceCardField.
    • Added new types OCRBoundingBox, OCRResultBlock and OCRPage to better describe PerformOCRResult.
    • Added new property detectionStatus of type HealthInsuranceCardDetectionStatus in HealthInsuranceCardScannerResult.
    • Added new property acceptedBrightnessThreshold in DocumentScannerConfiguration, FinderDocumentScannerConfiguration.
    • Added new property textDataValueFilter in TextDataScannerConfiguration.
    • Added new property userDefinedFields of type TIFFUserDefinedField[] in WriteTIFFArgument.
    • Added new property minimumNumberOfSymbols in DocumentQualityAnalyzerArguments.
    • Added new properties pageFitMode, dpi, jpegQuality, resample and ocrConfiguration in CreatePDFArguments.
    • Added new properties engineMode, lowPowerMode, codeDensity in DetectBarcodesOnImageArguments.
    • Added new property parametricFilters in Page.
    • Added new literals OK_OFF_CENTER and OK_BARCODE to type DetectionStatus.
    • Added new applyImageFilters and applyImageFiltersOnPage APIs that accept an array of parametric filters as input and apply them to an image or page, respectively.
    • The result of the document scanner RTU screen has metadata that shows the current state of the flash, multiPage, and autoSnapping settings during scanning.
    • ScanbotBarcodeCameraView:
      • Added new property cameraZoomRange which sets the range of valid camera zoom factors.
      • Added new property cameraModule which sets the camera device being used for scanning.
      • Added new property minFocusDistanceLock which locks focus distance within minimum possible range.
      • Added new property lowPowerMode which regulates energy consumption.
      • Added new property barcodesExtensionFilter which sets the extension filter for EAN and UPC barcodes.
      • Added new property finderInset which sets the minimum space from view finders outer edges to the view edges.
      • Added new property codeDensity which sets expected density of QR codes.
      • Added new methods freezeCamera and unfreezeCamera which control the camera preview.
      • Added new config selectionOverlayConfig which configures the selection overlay.
  • πŸš€ Improvements:
    • The Barcode Scanner now supports transposed (mirrored/flipped) Aztec barcodes.
    • The Health Insurance Card Recognizer now implements the new Scanbot OCR engine. The recognition is faster and more accurate than before.
    • 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.
    • iOS: Improved the installation of custom OCR languages for the Tesseract OCR engine.
    • iOS: Improved speed and image quality of still image capturing.
    • iOS: Added support of haptic feedback on capable devices.
    • Android: Optimized speed of the camera preview frames handling for all scanners.
    • Android: Optimized memory consumption for PDF rendering with encryption enabled.
    • Android: Text detection is faster and more accurate.
    • Android: Improved MRZ parser for a stronger rejection of outliers.
    • Android: Improved speed and quality of scanning for GenericDocumentRecognizer.
    • Android: Changed touch to focus square in the native camera view to a circle.
    • Android: writeTiff API method can be used with encryption.
    • ScanbotBarcodeCameraView:
      • Improved overall performance and reliability.
      • Improved consistency between the behaviors on Android and iOS.
      • Added support for the new React Native Fabric renderer.
  • 🐞 Bug fixes:
    • Android: For BarcodeFormat.PDF_417, a single case to generate clusters was not covered, which led to a crash.
    • Android: Fixed an issue with misaligned barcode polygons on some devices with horizontal orientation.
    • Android: Fixed null pointer exception for PageFileStorage operations.
    • Android: BarcodeExtensionsFilter now accepts EAN and UPC barcodes with extensions only and all other formats without extensions.
    • Android: Fixed recognizeMRZ API crash on some devices due to incorrect image loading.
  • ⚠️ Breaking changes:
    • React Native SDK 0.68 is the minimum supported version.
    • Android: Important: Previously in order to use the plugin, manual linking was needed in android project (android/settings.gradle). There is no need for that anymore. Linking is done automatically, but you need to remove the manual linking, otherwise the plugin won't work starting from v5.1.0.
    • startBarcodeScanner, closeBarcodeScanner, startBatchBarcodeScanner, closeBatchBarcodeScanner have been deprecated.
    • Removed getFilteredDocumentPreviewUri and associated types. Please utilize applyImageFiltersOnPage.
    • Removed detectBarcodesOnImages and associated types. Please utilize detectBarcodesOnImage.
    • Removed literal FAIL from CheckStatus. All failed check recognitions are now being rejected.
    • Removed literals CCITTFAX3 and CCITTFAX4 from TIFFCompression. Use CCITT_T4 and CCITT_T6 respectively.
    • Replaced GenericDocumentWrapper with the improved GenericDocument.
    • Changed formattedResult type to a GenericDocument in BarcodeResultField. Removed the previous barcode document interfaces (AAMVADocumentFormat, BoardingPassDocumentFormat, GS1DocumentFormat, IDCardPDF417DocumentFormat, MedicalCertificateDocumentFormat, MedicalPlanDocumentFormat, SEPADocumentFormat, SwissQRCodeDocumentFormat, VCardDocumentFormat), and replaced them with the improved and more capable wrapper classes (AAMVA, BoardingPass, GS1, IDCardPDF417, MedicalCertificate, DEMedicalPlan, SEPA, SwissQR, VCard).
    • Changed check type to a GenericDocument in CheckRecognizerResult. Removed the previous check document interfaces (USACheckDocument, FRACheckDocument, KWTCheckDocument, AUSCheckDocument, INDCheckDocument, ISRCheckDocument, UnknownCheckDocument), and replaced them with the improved and more capable wrapper classes (USACheck, FRACheck, KWTCheck, AUSCheck, INDCheck, ISRCheck, UnknownCheck).
    • Changed mrz type to a GenericDocument in RecognizeMRZResult. Removed the previous mrz document interface (MRZDocument) and replaced it with the improved and more capable wrapper class (MRZDocument).
    • Changed documents type to a GenericDocument[] in GenericDocumentRecognizerResult. Removed the previous generic document interfaces (MRZDocument, DeIdCardFrontDocument, DeIdCardBackDocument, DePassportDocument, DeDriverLicenseFrontDocument, DeDriverLicenseBackDocument), and replaced them with the improved and more capable wrapper classes (MRZ, DeIdCardFront, DeIdCardBack, DePassport, DeDriverLicenseFront, DeDriverLicenseBack).
    • Changed acceptedCheckStandards property type to CheckDocumentModelRootType in recognizeCheck.
    • Replaced literals RSS_14 and RSS_EXPANDED with DATABAR and DATABAR_EXPANDED in BarcodeFormat.
    • Replaced property oneBitEncoded with binarizationFilter in WriteTIFFArguments.
    • Renamed property pageOrientation to pageDirection in CreatePDFArguments.
    • Renamed type MRZDocumentType to MRZDocumentTypes, PDFPageSize to PageSize, PDFPageOrientation to PageDirection.
    • Removed type RemovePageResult. removePage now returns status only.
    • Removed type CheckRecognizerScreenResult.
    • Removed applyImageFilter and applyImageFilterOnPage. The new applyImageFilters and applyImageFiltersOnPage accept parametric filter array.
    • The following properties are now required:
      • page in CroppingResult
      • documentImageFileUri and polygon in DetectDocumentResult
      • result in TextDataScannerResult
      • all properties of LicensePlateScannerResult
      • all properties of VinScannerResult
    • Reworked performOCR parameters and result. See PerformOCRResult and PerformOCRArguments.
    • ZoomRange can be created with any input values but will be limited under the hood by internal MIN_ZOOM (x0.2) and MAX_ZOOM (x100) values.
    • BarcodeFormat.CODE_25 is no longer being scanned with the default configuration and needs to be included explicitly in the barcode formats array for all barcode scanners.
    • iOS: Important: The default rear camera in all scanners has been changed from the ultra-wide or wide camera to the triple or dual camera.
    • ScanbotBarcodeCameraView:
      • Decoupled all the properties from configuration prop and subdivided by configurations.
      • Child views are no longer added natively. There is a dedicated container that holds views.
      • onBarcodeScannerResult now returns BarcodeScannerResult instead of ScanbotBarcodeCameraViewResult.
      • Renamed property shouldUseFinderView to viewFinderEnabled.
      • Renamed property finderAspectRatio to requiredAspectRatio.
      • renamed property finderMinimumPadding to minPadding.
      • Removed property finderBackgroundColor and finderBackgroundOpacity in favor of overlayColor. overlayColor accepts ColorValue through which opacity can be set.
      • Removed property finderVerticalOffset.
      • Removed property requestComponentReload.
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v5.1.3.
    • Upgraded the native Scanbot iOS SDK to v5.1.4.
    • Added 3rd-party library libzueci version 1.0.0.
    • Updated 3rd-party libraries: libjpeg-turbo to 2.1.5.1, libpng to 1.6.40 and libtiff to 4.6.0.
    • iOS: Refactored all public SDK code to Swift.
    • iOS: Updated 3rd-party library zlib to version 1.3.1.
    • Android: Added 3rd-party library zlib.
    • Android: Added Theme.AppCompat.NoActionBar theme as default for Barcode Scanner RTU UI v2 activity.
    • Android: Fixed pro-guard rules for DocumentQualityAnalyzer.
    • Android: Added more rules for R8 shrinker to work adequately with AGP >= 8.
    • Android: Added an R8 consumer rule to keep the internals of io.scanbot.core.processor.ImageProcessor from shrinking/obfuscating.
    • Android: Added Consumer Proguard rules for RTU UI v2 modules.
    • ScanbotBarcodeCameraView:
      • Android: Replaced the native component ScanbotCameraView with the new and improved ScanbotCameraScannerView.

Version 4.16.0 (19 Apr 2024)​

  • πŸŽ‰ New:
    • Introduced VIN Scanner RTU UI.
    • Introduced Document Quality Analyzer. It analyzes the text quality (legibility) on images.
    • Added new Barcode Types: MICRO_QR_CODE, INDUSTRIAL_2_OF_5, USPS_INTELLIGENT_MAIL, ROYAL_MAIL, JAPAN_POST, ROYAL_TNT_POST, AUSTRALIA_POST, DATABAR_LIMITED and GS1_COMPOSITE.
    • Added support for Kuwait ID cards in the MRZ scanner.
    • Added support for the Israeli Check standard.
    • New generation of Text Data Scanner RTU UI. The quality and speed of scanning has significantly improved. Changed the default OCR engine to the new Scanbot_OCR engine. With the new ML-based OCR engine the speed of text recognition has increased twofold. The new OCR engine currently supports all languages with latin letters, there is no need to specify the languages for it.
    • Tesseract language traindata is no longer needed by default. Tesseract engine mode can still be used with customization of OCR config.
    • Added a type literal, BACK_WIDEST for CameraModule (iOS only).
    • Added a type literal, CREW_MEMBER_CERTIFICATE for MRZDocumentType.
    • Added new types:
      • FinderDocumentScannerResult that describes the result of startFinderDocumentScanner.
      • BarcodeScannerResult that describes the result of startBarcodeScanner.
      • BatchBarcodeScannerResult that describes the result of startBatchBarcodeScanner.
      • TextDataRecognitionResult that describes the result of TextDataScannerResult.
      • HealthInsuranceCardField that describes the fields of the HealthInsuranceCardScannerResult.
      • MedicalCertificateDatesInfo, MedicalCertificateCheckboxesInfo, MedicalCertificatePatientDataInfo and MedicalCertificatePatientDataInfoField to better describe MedicalCertificateRecognizerResult.
      • PerformOCRArguments to better describe the arguments for performOcr function.
      • CreatePDFArguments to better describe the arguments for createPDFResult function.
      • WriteTIFFArguments to better describe the arguments for writeTIFF function.
    • Added new properties in the following configurations:
      • DocumentScannerConfiguration - flashButtonHidden, flashButtonTitle, touchToFocusEnabled and preferredAspectRatios.
      • FinderDocumentScannerConfiguration - flashButtonHidden and touchToFocusEnabled.
      • CroppingConfiguration - topBarTitle and topBarTitleColor.
      • BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration - barcodesExtensionFilter, flashButtonHidden, flashButtonTitle, touchToFocusEnabled, viewFinderEnabled, barcodeValueFilter and confirmationDialogConfiguration.
      • MrzScannerConfiguration, HealthInsuranceCardScannerConfiguration, TextDataScannerConfiguration, LicensePlateScannerConfiguration, MedicalCertificateRecognizerConfiguration, CheckRecognizerConfiguration and GenericDocumentRecognizerConfiguration - flashButtonHidden, flashButtonTitle and touchToFocusEnabled.
    • Added support for inverted PDF-417 barcodes.
    • MRZ support for td1 long document standard.
    • Android: Added a new implementation of extractImagesFromPdf and extractPagesFromPdf.
    • iOS: Added Privacy manifest file (PrivacyInfo.xcprivacy) to the SDK.
  • πŸš€ Improvements:
    • Improved accuracy and detection speed of QR_CODE, CODE_39, and CODE_93 barcode types.
    • Improved the speed of barcode recognition for most barcode symbologies.
    • 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.
    • Android: Optimized the size of native libraries integrated into the Scanbot SDK.
    • Android: Enhanced error handling behavior when deleting SDK pages.
    • Android: Improved quality and speed of the Document Contour detector.
    • Android: Decreased size of Document Contour detector ML model.
    • iOS: Changed the default zoom range from (0.0 - 3.0) to (0.0 - 12.0) for cameraZoomRange in all RTU-UI configurations.
  • 🐞 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 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.
    • Android: Fixed potential memory leak in all RTU-UI screens.
    • Android: Fixed some OOM crashes on low to midrange devices.
    • Android: Fixed false positives for CODE_39 and CODABAR barcodes.
    • Android: Fixed colors not being applied to fields in GenericDocumentRecognizerConfiguration.
    • Android: Fixed crash in TextDataScanner on ARM v7 devices.
    • Android: Fixed bug with invisible back button on Document Scanner RTU UI screens when no Camera permission was granted.
    • Android: Fixed the logic in autoSnapProgressEnabled and polygonAutoSnapProgressEnabled methods in FinderDocumentScannerConfiguration and DocumentScannerConfiguration respectively.
    • Android: Fixed textDataScannerStep not applying in TextDataScannerConfiguration.
    • Android: Fixed behavior of ocrResolutionLimit in TextDataScannerConfiguration.
    • Android: Corrected mapping of userGuidanceStrings in CheckRecognizerConfiguration.
    • Android: Fixed enableCameraButtonTitle and enableCameraExplanationText parameters on BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration.
    • iOS: Fixed issues with performOCR functionality.
    • iOS: Fixed storage path issue for some of the operations when setting custom storage.
    • iOS: Fixed a crash when denying camera permission.
    • iOS: Fixed a bug with magnetic lines in CroppingScreen RTU UI.
    • iOS: Fixed a bug where the polygon should be mirrored when using the front camera in DocumentScannerResult.
    • iOS: Fixed a bug where automaticSelectionEnabled was not working properly in BarcodeScannerConfiguration.
    • iOS: Fixed a bug where flashEnabled was not working properly in HealthInsuranceCardScannerConfiguration.
    • iOS: Fixed a bug where ocrResolutionLimit was not being used in TextDataScannerConfiguration.
    • iOS: Fixed a bug with the iPad 5th generation where captured images were wrong.
    • iOS: Fixed a bug where the finder text hint was still showing when viewFinderEnabled was disabled in BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration.
    • iOS: Fixed a wrong polygon color in RTU-UI barcode scanner tracking overlay.
    • iOS: Fixed rare cases where RTU UI screens were not shown and the application froze.
    • iOS: Fixed a bug where recognizeGenericDocument did not accept any acceptedDocumentFormats values.
  • ⚠️ Breaking Changes:
    • iOS: Removed support for iOS 11.x and 12.x. The minimum deployment target to use ScanbotSDK in your app is iOS 13.0!
    • status property is included in ResultWrapper interface and extracted from all resulting interfaces.
    • All file outputs are now represented as encoded URI strings.
    • ImageFilterType type literals were changed. Replace the type literals in order to use applyImageFilter, applyImageFilterOnPage, getFilteredDocumentPreviewUri and all Page functionalities.
    • MRZ Scanner and recognizeMRZ result breaking changes: field property in the result was removed and replaced with mrz of type MRZDocument. All types associated with fields property have been removed.
    • Check Recognizer and recognizeCheck result breaking changes: field property in the result was removed and replaced with check of type CheckDocument. All types associated with fields property have been removed.
    • GenericDocumentRecognizer result breaking changes: result was restructured to return an array containing the types MRZDocument, DeIdCardFrontDocument, DeIdCardBackDocument, DePassportDocument, DeDriverLicenseFrontDocument or DeDriverLicenseBackDocument. Previous types and properties have been removed.
    • The estimateBlur functionality has been removed and replaced by the far superior documentQualityAnalyzer.
    • recognizeCheck argument was redefined to be an object that contains imageFileUri and acceptedCheckStandards.
    • The property enableGS1Decoding has been replaced by gs1HandlingMode in BarcodeScannerConfiguration, BatchBarcodeScannerConfiguration and ScanbotBarcodeCameraViewConfiguration. GS1 codes are now handled differently for various barcode types. Using the default option PARSE will give the same result as before for all barcode types, except of RSS_EXPANDED. Previously, for RSS_EXPANDED, the result was inconsistently returned with parentheses. Now, to get results with parentheses for all barcode types, choose the option DECODE.
    • Property supportedLanguages has been removed from HealthInsuranceCardScannerConfiguration.
    • Property barcodeImageGenerationType has been removed from BarcodeScannerConfiguration.
    • Properties rawText and isValidationSuccessful were removed from LicensePlateScannerResult.
    • Property textFilterStrategy has been removed from TextDataScannerStep.
    • Property subfiles in AAMVADocumentFormat now returns an array of AAMVADocumentSubfile.
    • Removed type literal TRAVEL_DOCUMENT from MRZDocumentType.
    • Type literals for types CapturePhotoQualityPrioritization, LicensePlateScanStrategy, MSIPlesseyChecksumAlgorithm, GenericDocumentType and FieldDisplayState have been modified.
    • Type FinderAspectRatio was renamed to AspectRatio.
    • Type InitializationOptions was renamed to ScanbotSdkConfiguration.
    • Type CameraImageFormat was renamed to StorageImageFormat.
    • Removed JS Helpers: JSTextFunction, JSTextFunctionBuilder, JSStringToBoolTextFunction, JSStringToStringTextFunction, JSStringToBoolTextFunctionBuilder and JSStringToStringTextFunctionBuilder.
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v4.2.0
    • Upgraded the native Scanbot iOS SDK to v4.2.2
    • Added "libharu" library to dependencies.
    • Android: Blackview and Caterpillar brands are now excluded from GpuAcceleration-supported devices.
    • Android: Removed "Android PDF Writer" library from dependencies.
    • Android: Upgraded OpenCV version to 4.8
    • Android: Added "icu4c" library to dependencies.
    • Android: Updated version of Nameof C++ library to v0.10.3
    • Android: Disabled GPU acceleration for Redmi 9 models, Samsung Galaxy Grand Prime and devices with Android older than 6.

Version 4.15.5 (17 Nov 2023)​

  • 🐞 Bug fixes:
    • Android: fixed storageImageQuality parameter in InitializationOptions.
    • Fixed options being ignored when calling SDK functions: writeTiff, performOCR.
    • Fixed parsing of custom storage path for file URIs on iOS
    • Fixed performOCR for content file URIs
  • ⚠️ Breaking changes:
    • Removed Sensitive Binarization Image Filter

Version 4.15.4 (29 Sep 2023)​

  • πŸŽ‰ New:
    • Introduced FinderDocumentScanner RTU UI
  • 🐞 Bug fixes:
    • iOS: pageImageSource added to page response
    • iOS: fixed property documentImageSizeLimit not being set properly
    • iOS: fixed a focusing issue with the new iPhone 15 Pro and 15 Pro Max.
    • Android: added new enum values PageImageSource.UNDEFINED and PageImageSource.IMPORT to PageImageSource
    • Android: renamed previewImageUri to originalPreviewImageFileUri
    • Android: fixed documentImageSizeLimit returning an empty string
    • Android: fixed documentImageSizeLimit cast error
    • Android: filter property from the Page response now returns the correct value type of ImageFilterType instead of ImageFilter
    • Android: Min SDK was decreased back to 21
  • ⚠️ Breaking changes:
    • Replaced ImageFilter with ImageFilterType. applyImageFilter, applyImageFilterOnPage and getFilterDocumentPreviewUri now use ImageFilterType type value as an argument.

Version 4.15.3 (29 Jun 2023)​

  • πŸŽ‰ New:
    • Introduced exported GenericDocumentNormalizedFields constant for easier configuration of GenericDocumentRecognizer
  • 🐞 Bug fixes:
    • iOS: Fixed storage issues that would cause different SDK functions to fail when a custom storage directory was not specified
    • Android: Fixed licenseExpirationDate missing from getLicenseInfo() result
  • πŸš€ Improvements:
    • iOS: Automatically removing minihash query parameter from URLs passed to SDK functions
    • Android: Optimized getImageData() to return smaller Base64 strings Note: NO_WRAP encoding format is now used - the string will not contain line breaks anymore

Version 4.15.2 (19 Jun 2023)​

  • 🐞 Bug fixes:
    • iOS: Fixed 'Unsupported Swift Architecture' error when targeting the simulator
  • πŸš€ Improvements:
    • iOS: You can now start RTU components from modal components

Version 4.15.0 (14 Jun 2023)​

  • πŸŽ‰ New:
    • Introduced Generic Document Recognizer! It can be used to recognize various types of documents, including German ID cards, German passports, and German driver's licenses. See startGenericDocumentRecognizer
    • Added new supported Barcode types: CODE_25, IATA_2_OF_5 and INDUSTRIAL_2_OF_5
    • Introduced Check Recognizer Ready-To-Use UI (startCheckRecognizer) and recognizeCheckOnImage API function
    • Introduced Barcode Document Formats! When scanning barcodes, if a supported document is recognized, it will be parsed and included in the result
    • Introduced selection overlay for Barcode Scanner and Batch Barcode Scanner! See property overlayConfiguration in BarcodeScannerConfiguration and BatchBarcodeScannerConfiguration
    • Document Scanner:
      • Added new properties in DocumentScannerConfiguration:
        • userGuidanceFontSize
        • textHintOffCenter
        • stopsCameraSessionWhenDisappeared
        • photoQualityPriorization
        • forceUserGuidance
        • detectorMode
        • defaultPageFilter
        • cancelButtonHidden
        • cameraUnavailableExplanationText
        • cameraPreviewMode
    • MRZ Scanner:
      • Added rawString in MRZ Result, which contains the detected raw MRZ text
      • Added new properties in MrzScannerConfiguration:
        • cancelButtonHidden
        • finderAspectRatio
        • flashButtonHidden
        • topBarButtonsActiveColor
        • topBarButtonsInactiveColor
        • replaceCancelButtonWithIcon
        • cameraPreviewMode
        • autoCancelTimeout
    • Barcode Scanner:
      • Added new properties in BarcodeScannerConfiguration:
        • enableCameraButtonTitle
        • enableCameraExplanationText
        • flashButtonHidden
        • focusLockEnabled
        • focusLockPosition
        • minFocusDistanceLock
        • replaceCancelButtonWithIcon
        • cameraPreviewMode
        • cameraZoomRange
        • autoCancelTimeout
        • codeDensity
        • barcodeImageGenerationType
        • initialScanDelay
        • delayAfterScan
        • doubleTapToZoomEnabled
        • pinchToZoomEnabled
        • shouldAnimateZooming
        • confirmationDialogConfiguration
        • overlayConfiguration
    • Batch Barcode Scanner:
      • Added new properties in BarcodeScannerConfiguration:
        • enableCameraButtonTitle
        • enableCameraExplanationText
        • flashButtonHidden
        • focusLockEnabled
        • focusLockPosition
        • minFocusDistanceLock
        • replaceCancelButtonWithIcon
        • cameraPreviewMode
        • cameraZoomRange
        • autoCancelTimeout
        • codeDensity
        • barcodeImageGenerationType
        • initialScanDelay
        • delayAfterScan
        • doubleTapToZoomEnabled
        • pinchToZoomEnabled
        • shouldAnimateZooming
        • confirmationDialogConfiguration
        • overlayConfiguration
    • Health Insurance Card Scanner:
      • Added new properties in HealthInsuranceCardScannerConfiguration:
        • enableCameraButtonTitle
        • enableCameraExplanationText
        • flashButtonHidden
        • topBarButtonsActiveColor
        • topBarButtonsInactiveColor
        • replaceCancelButtonWithIcon
        • cameraPreviewMode
    • Text Data Scanner:
      • Added new properties in TextDataScannerConfiguration:
        • cancelButtonHidden
        • enableCameraExplanationText
        • flashButtonHidden
        • flashButtonTitle
        • orientationLockMode
        • topBarButtonsActiveColor
        • topBarButtonsInactiveColor
        • useButtonsAllCaps
        • replaceCancelButtonWithIcon
        • cameraPreviewMode
        • textDataScannerStep
      • Now you can also specify a threshold used to pause the detection after significant movement occurred; use property significantShakeDelay inside textDataScannerStep in TextDataScannerConfiguration
    • License Plate Scanner:
      • Added new properties in LicensePlateScannerConfiguration:
        • topBarButtonsActiveColor
        • confirmationDialogStyle
        • confirmationDialogConfirmButtonStyle
        • confirmationDialogRetryButtonStyle
        • enableCameraButtonTitle
        • enableCameraExplanationText
        • finderPreferredHeight
        • flashButtonHidden
        • flashButtonTitle
        • significantShakeDelay
        • replaceCancelButtonWithIcon
        • cameraPreviewMode
    • Medical Certificate Recognizer:
      • Added new properties in MedicalCertificateScannerConfiguration:
        • cameraOverlayColor
        • finderLineColor
        • finderLineWidth
        • flashButtonHidden
        • flashButtonTitle
        • userGuidanceHidden
        • recognizePatientInfo
        • returnCroppedDocumentImage
        • errorDialogStyle
        • errorDialogTitle
        • errorDialogAccentColor
        • errorDialogMessage
        • errorDialogOkButton
        • errorDialogOkButtonFilled
        • errorDialogOkButtonFilledTextColor
        • errorDialogButtonStyle
        • showFinderOverlay
        • userGuidanceStrings
        • cameraPreviewMode
        • finderAspectRatio
        • finderSecondaryAspectRatio
  • ⚠️ Breaking changes:
    • TypeScript: all the SDK types are now directly exported from react-native-scanbot-sdk; it is no longer required to use subpaths (ex. react-native-scanbot-sdk/src/enum) to import interfaces, types and enums in your code
    • IMPORTANT: Removed jniLibs from the plugin; when migrating from a previous version, you should remove the jniLibs folder from your Android project, along with the pickFirst packaging option in your app build.gradle
    • Removed ID Card Scanner. You should now use our Generic Document Recognizer (see startGenericDocumentRecognizer) to recognize German ID Cards, passports and driving licenses. You can still choose to detect ID Cards only, by setting acceptedDocumentTypes in GenericDocumentRecognizer to ['DeIdCardFront', 'DeIdCardBack']. What used to be IdCardScannerResult will be contained in the fields property of GenericDocumentRecognizerResult when you explicitly cast it to DeIdCardResult like this: let idCardResult = result.fields as DeIdCardResult; the result is slightly different:
      • Fields pin, pseudonym and maidenName were removed;
      • Field mrz has been renamed to rawMrz
    • Removed NFC Passport Reader
    • Replaced interfaceOrientation (ALL, PORTRAIT, LANDSCAPE) with orientationLockMode (NONE, PORTRAIT, LANDSCAPE) in all RTU Configurations; if you were using ALL you can replace it with NONE.
    • MRZ Scanner:
      • Removed finderHeight and finderWidth from MrzScannerConfiguration; from now on, use the new property finderAspectRatio
      • Removed topBarButtonsColor from MrzScannerConfiguration and added topBarButtonsActiveColor and topBarButtonsInactiveColor; now you can set the color for each state in which the buttons might be in
    • Batch Barcode Scanner:
      • Removed unused property recognitionEnabled from BatchBarcodeScannerConfiguration
    • Health Insurance Card Scanner:
      • Removed property validationType from HealthInsuranceCardScannerConfiguration
      • Removed properties flashButtonInactiveColor and topBarButtonsColor from HealthInsuranceCardScannerConfiguration and added topBarButtonsActiveColor and topBarButtonsInactiveColor; now you can set the color for each state in which the buttons might be in
      • Removed unused property recognitionEnabled from HealthInsuranceCardScannerConfiguration
    • Text Data Scanner:
      • The following properties are now inside the new property textDataScannerStep (of type TextDataScannerStep) in TextDataScannerConfiguration:
        • guidanceText
        • pattern
        • shouldMatchSubstring
        • preferredZoom
        • aspectRatio
        • unzoomedFinderHeight
        • allowedSymbols
        • textFilterStrategy
      • Removed properties from TextDataScannerConfiguration:
        • flashButtonInactiveColor
        • recognitionEnabled
        • title
        • topBarButtonsColor - added topBarButtonsActiveColor and topBarButtonsInactiveColor; now you can set the color for each state in which the buttons might be in
        • validationBlock
        • stringSanitizerBlock
    • License Plate Scanner:
      • Renamed detectorMode in LicensePlateScannerConfiguration to scanStrategy
      • Renamed topBarButtonsColor to topBarButtonsActiveColor in LicensePlateScannerConfiguration
    • Medical Certificate Recognizer:
      • startMedicalCertificateScanner has been renamed to startMedicalCertificateRecognizer
      • MedicalCertificateScannerConfiguration has been renamed to MedicalCertificateRecognizerConfiguration
      • MedicalCertificateScannerResult has been renamed to MedicalCertificateRecognizerResult
      • Removed "data" field of type MedicalCertificateScannerResultData from the result in MedicalCertificateScannerResult; its fields are now at top-level
      • Removed unused field validationConfidence from the result date fields in MedicalCertificateScannerResult
      • Removed properties from configuration:
        • extractPatientInfo (renamed to recognizePatientInfo)
        • guidanceText (use userGuidanceStrings instead)
        • errorDialogText (use errorDialogMessage; also see new error dialog properties)
  • πŸš€ Improvements:
    • Improved crops and contours for detected barcodes
    • Improved 1D barcode recognition
    • Improved MRZ detection for US passports
    • Improved recognition of inverted barcodes
    • Improved performance and reduced false positive rate for stacked RSS barcodes
    • Improved performance of DataMatrix and QR-codes
    • Improved recognition of Medical Certificates
    • Improved performance and accuracy of machine-readable-zone recognition
    • The raw string is now returned for RSS Expanded barcodes that don't contain a GS1 string
    • Patient info box recognition has been improved in the medical certificate scanners
    • Various memory allocation improvements
    • iOS: Various performance improvements for BarcodeCameraView
  • 🐞 Bug fixes:
    • Fixed a crash when applying a filter to single channel images
    • Fixed issues with MRZ on Mexican and US passports
    • Fixed finderVerticalOffset wrong direction in ScanbotBarcodeCameraView configuration
    • iOS: Fixed stripCheckDigits not being applied for ScanbotBarcodeCameraView component
    • iOS: Fixed a bug that caused the document scanner to auto-capture a second image shortly after the first image
    • iOS: Fixed a rare crash on the detection of Health Insurance cards
    • iOS: Fixed a potential crash when the app using ScanbotSDK is suspended by the operating system
    • iOS: Fixed a potential crash during the SDK initialization when the app name contains spaces
    • iOS: Fix component configuration being ignored on start of BarcodeCameraView
    • iOS: Medical certificates of type 1C are no longer recognized as 1A
    • iOS: Fixed visibility of the shutter button in Document Scanner when camera access is denied
    • iOS: Fixed a bug where the MRZ recognition would produce inaccurate results
    • iOS: Fixed a bug where UPC/EAN extensions were not recognized
    • Android: Fixed Scanbot RTU-UI scanners handling when the app is terminated in the background
    • Android: Fixed a crash on specific PDF-417 codes with boarding passes
    • Android: Fixed an incorrect mapping of guidance strings for Medical Certificate Recognizer
    • Android: Fixed snapped page filtering in Document Scanner RTU UI screen
    • Android: Fixed a bug with RTU Barcode scanner not being able to produce the barcode image when a barcode filter is set
    • Android: Fixed crashes on devices running Android 5 and 6 in some scenarios
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v2.2.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v2.2.0 (cf. changelog)

Version 4.14.0 (3 Mar 2023)​

  • πŸš€ Improvements:
    • Internal refactoring and improvements
  • 🐞 Bug fixes:
    • Fixed conflicts in ScanbotBarcodeCameraView caused by usage of deprecated dimensions listener in RN 0.70+
    • Android: Fixed ScanbotBarcodeCameraView not recognizing barcodes after navigating back from another screen
    • Android: Fixed interfaceOrientation not working for value ALL
    • Android: Fixed configuration properties being ignored under some conditions
    • Android: Fixed issues when engineMode is not set in ScanbotBarcodeCameraView
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.93.1.665 which contains a special hotfix for the back navigation problem in ScanbotBarcodeCameraView

Version 4.13.1 (22 Jun 2022)​

  • πŸš€ Improvements:
    • Updated README

Version 4.13.0 (25 May 2022)​

  • πŸŽ‰ New:
    • New checkbox types are now supported for Medical certificates: requiresCareNo, accidentNo, otherAccident.
    • Added extractPatientInfo in MedicalCertificateScannerConfiguration which allows deciding whether the information of the patient is extracted or not.
    • Added cancelButtonHidden in MedicalCertificateScannerConfiguration which allows hiding the cancel button. iOS only.
    • Added guidanceText in MedicalCertificateScannerConfiguration which allows configuring the guidance texts.
    • Added errorDialogText in MedicalCertificateScannerConfiguration which allows configuring the error alert texts.
    • Removed unused configuration parameters in MedicalCertificateScannerConfiguration.
    • Added topAndBottomButtonsSwapped in CroppingScreenConfiguration to invert the top and bottom buttons' position.
  • πŸš€ Improvements:
    • Huge improvement on the speed and accuracy of 1D barcodes recognition.
    • Native libraries size decreased by more than 20%
    • iOS: Improved barcode image cropping.
  • 🐞 Bug fixes:
    • Android: Fixed GPU acceleration issues with the Samsung S22 series devices.
    • Android: Fixed camera flash state for the document scanner after picture is taken in multi-page mode.
    • Android: Fixed cropped images of 1D barcodes.
    • iOS: Fixed a bug with the view finder rectangle not being calculated correctly in landscape mode in Barcode Scanner.
    • The configuration topBarButtonsActiveColor in MedicalCertificateScannerConfiguration was not working on both iOS and Android.
    • The configuration topBarButtonsInactiveColor in MedicalCertificateScannerConfiguration was not working on iOS.
  • ⚠️ Breaking changes:
    • capturedPage property is removed from MedicalCertificateScannerResultData and imageFileUri property is introduced as a replacement for capturedPage in MedicalCertificateScannerResultData
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.93.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.26.2 (cf. changelog)

Version 4.12.0 (06 Apr 2022)​

  • πŸš€ Improvements:
    • Improved Machine Readable Zone recognizer
    • Improved ID card recognizer
    • Improved Aztec barcode recognition
    • Android: Improved the UX of the Document Scanner; now the pausing of the preview is done only after the image is captured. Previously it could result in blurry images.
  • 🐞 Bug fixes:
    • Android: By default, GPU acceleration has been disabled (due to issues on the Samsung S22 series devices). To enable it, set allowGpuAcceleration to true when you initialize the SDK
    • iOS: Fixed ScanbotSDK being embedded twice under certain configurations, causing the build to fail
    • iOS: Fixed a bug with simulators not capturing the demo image when the shutter button is pressed
    • iOS: Fixed a bug in SBSDKPDFPagesExtractor with transformed PDF pages
    • iOS: Fixed an issue with view finder colors and line width not being applied in RTU-UI components
  • ⚠️ Breaking changes:
    • IMPORTANT (iOS): Changed SDK internal podspec definition; a full clean by removing node_modules, package-lock.json, clearing npm cache, removing Pods and Podfile.lock, and reinstalling everything again with npm install and pod install --repo-update might be needed in case the iOS build fails.
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.92.1 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.25.1 (cf. changelog)

Version 4.11.3 (13 Jan 2022)​

  • 🐞 Bug fixes:
    • Fixed the interfaceOrientation configuration in CroppingScreenConfiguration which could have caused an exception on Android

Version 4.11.2 (12 Jan 2022)​

  • 🐞 Bug fixes:
    • Re-added missing flashButtonHidden configuration parameter into DocumentScannerConfiguration.

Version 4.11.1 (12 Jan 2022)​

  • πŸŽ‰ New:
    • Added new configuration parameter flashButtonInactiveColor into HealthInsuranceCardScannerConfiguration which allows choosing the foreground color of the flash button when the flash is off (iOS only) EHIC Scanner
    • Added new configuration parameter allowXnnpackAcceleration into InitializationOptions, which allows controlling whether the XNN pack optimizations should be used (Android only)
    • Added new configuration parameter enableNativeLogging into InitializationOptions, which enables Scanbot SDK Core native logging (default is false; Android only)
  • πŸš€ Improvements:
    • Improved PDF417 recognition performance on single photos (iOS)
    • Improved barcode detection on large documents (iOS)
    • Updated flash buttons' icons (iOS)
    • Improved GS-1 databar recognition in the next-gen barcode scanner (iOS)
    • Improved robustness and performance of the MRZ scanner (Android)
    • Improved recognition of small barcodes on large images (Android)
    • Improved recognition of stacked RSS Expanded (GS1) barcodes (Android)
    • Improved rectangular DataMatrix performance (Android)
    • Increased performance on stable images with PDF-417 barcodes (Android)
  • 🐞 Bug fixes:
    • Fixed a problem with an inaccurate finder in Health Insurance Card Scanner and MRZ Scanner (iOS)
    • Fixed a crash in the barcode detector with Legacy engine mode on still images (Android)
  • ⚠️ Breaking changes:
    • IMPORTANT: Removed bottomButtonsActiveColor and bottomButtonsInactiveColor from HealthInsuranceCardScannerConfiguration
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.90.1 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.23.0 (cf. changelog)

Version 4.11.0 (14 Dec 2021)​

  • πŸŽ‰ New:
    • Introduced Medical Certificate Scanner RTU-UI! You can use it to scan German medical certificates. See startMedicalCertificateScanner
    • Introduced cameraModule in RTU-UI components! You can set it to FRONT if you want to use the front camera in the RTU-UI component.
  • πŸš€ Improvements:
    • Barcode Camera View now supports stripCheckDigits
    • Android: initializeSdk now throws an error when the SDK initialization fails (eg. invalid license)
  • 🐞 Bug fixes:
    • Fixed licenseExpirationDate wrong timestamp in getLicenseInfo Android result
    • Fixed gs1DecodingEnabled being ignored in RTU-UI components
    • Fixed allowedInterfaceOrientations ambiguous behavior in RTU-UI configurations
    • Fixed getLicenseInfo not being callable when using an invalid license
  • ⚠️ Breaking changes:
    • IMPORTANT: Removed allowedInterfaceOrientations and orientationLockMode from all RTU-UI configurations. Use interfaceOrientation instead (PORTRAIT, LANDSCAPE or ALL)
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.89.1 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.22.0 (cf. changelog)

Version 4.10.1 (8 Nov 2021)​

  • πŸŽ‰ New:
    • Introduced forceClose function in RTU-UI components! You can use it to programmatically close the components.
  • πŸš€ Improvements:
    • Improved flexibility, speed, and accuracy of the EHIC Scanner (European Health Insurance Cards)
    • Android: You can enable CameraX under the hood on Android. See useCameraX in InitializationOptions
    • Android: GPU Acceleration will be used for Barcode Scanner, Document Scanner and Generic Document Recognizer. You can disable it by setting allowGpuAcceleration to false; see InitializationOptions
  • 🐞 Bug fixes:
    • Android: FixedΒ msiPlesseyChecksumAlgorithm,Β stripCheckDigitsΒ andΒ cameraZoomFactor being ignored in BatchBarcodeScannerConfiguration
  • ⚠️ Breaking changes:
    • submitButtonTitle in IdCardScannerConfiguration has been renamed to viewResultsButtonTitle
    • The ID Card Scanner result is now wrapped in idCard object.
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.89.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.21.2 (cf. changelog)

Version 4.10.0 (21 Sep 2021)​

  • πŸŽ‰ New:
    • Introduced BarcodeCameraView native component! From now on you can use it to embed our camera view directly into your react layouts!
    • New functionalities to extract images and pages from PDF files!
    • Added new parameter cameraZoomFactor in Barcode Scanner RTU-UI, to set the initial camera zoom level.
    • Added new parameter pageImageSource in Page objects.
    • Added new parameter anchorPointsColor in Cropping Screen RTU-UI.
    • Introduced new parameter stripCheckDigits for Barcode Detection.
    • Added acceptedDocumentFormats parameter in Batch Barcode Scanner RTU-UI.
  • πŸš€ Improvements:
    • Improved recognition of UPC/EAN barcodes due to ink spread
    • Android: Improved recognition of the front side of ID cards by GenericDocumentRecognizer
  • 🐞 Bug fixes:
    • Android: Fixed a bug with the EHIC recognizer that caused some UTF8 characters to be ignored upon recognition
  • ⚠️ Breaking changes:
    • Android: Updated compile and target SDK of the library to 30
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.87.1 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.20.0 (cf. changelog)

Version 4.9.0 (9 Aug 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.
    • Text Data Scanner: a new RTU-UI component that allows you to perform OCR using our Data Scanner Camera API. See the new API function startTextDataScanner.
  • 🐞 Bug fixes:
    • Document Scanner (Android): fixed a bug that sometimes caused pictures to have the wrong orientation after they were imported
    • Fixed various UI related issues
  • πŸš™ Under the hood:
    • Updated the native Android Scanbot SDK to 1.85.1 (cf. changelog)
    • Updated the native iOS Scanbot SDK to 1.19.3 (cf. changelog)

Version 4.8.0 (25 Jun 2021)​

  • πŸŽ‰ New:
    • MSI Plessey barcode recognition
  • πŸš€ Improvements:
    • Droid: Exposed native dependencies to allow custom native implementations
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.84.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.18.0 (cf. changelog)

Version 4.7.0 (14 Apr 2021)​

  • πŸŽ‰ New:
    • A new scanner UI component for Vehicle License Plates! See the new API function startLicensePlateScanner
    • Added detectBarcodesOnImages for multiple images barcode detection.
    • Added support for TIFF files encryption
    • Document Type filters for Barcode and ID Card Scanner. See startIdCardScanner, startBarcodeScanner.
    • Accessibility configuration for Document Scanner and Cropping Screen
  • πŸš€ Improvements:
    • Introduced minimumTextLength, maximumTextLength, minimum1DBarcodesQuietZone for ITF Barcodes on startBarcodeScanner.
    • Added Document Scanner polygonCornerRadius parameter and auto-snapping UI customization. See startDocumentScanner.
    • Added new ID Card Scanner parameter 'sharpnessAcceptanceFactor'. See startIdCardScanner
  • ⚠️ Breaking Changes:
    • Removed flashImageButtonHidden from DocumentScanner configuration; use flashButtonHidden instead. See startDocumentScanner/
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.81.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.15.1 (cf. changelog)

Version 4.6.0 (15 Feb 2021)​

  • πŸŽ‰ New:
    • Added NFC passport reader - a new UI component to read data from passport's NFC chip.

Version 4.5.0 (2 Feb 2021)​

  • πŸŽ‰ New:
    • Encryption of image and PDF files. For more details please check out the section "Storage Encryption".
  • πŸš€ Improvements:
    • Improved support for advanced TypeScript compiler constraints
  • ⚠️ Breaking Changes:
    • The structured OCR result data is now returned as a JSON data field jsonData instead of a JSON file (jsonFileUri)
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.78.0 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.13.0 (cf. changelog)

Version 4.4.0 (4 Dec 2020)​

  • πŸŽ‰ New:
    • Android: Added a new optional config property useButtonsAllCaps: boolean for all RTU UI screens to control whether the buttons should use the all-capitals-style, as defined by the Android Material Design
  • πŸš€ Improvements:
    • Improvements in the detection of barcodes, especially of the type PDF417. Better recognition of rotated and damaged PDF417 codes
  • 🐞 Bug fixes:
    • iOS: Introduced a new API method refreshImageUris(pages) to fix image file paths after app updates. For more details please check out the section Persistence of Page Objects.
    • iOS: Fixed an issue about Bitcode support when submitting an app to the App Store Connect (error "ITMS-90562: Invalid Bundle - Bitcode failed to compile")
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.76.2 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.12.1 (cf. changelog)

Version 4.3.0 (22 Oct 2020)​

  • πŸŽ‰ New:
    • Batch Barcode Scanner - a new UI component to scan multiple barcodes in a row. See the new API function startBatchBarcodeScanner.
    • ID-Card Scanner - See the new API function startIdCardScanner.
    • Blur Estimator - a new API method to detect blurriness on still images.
    • New CroppingScreenConfiguration parameters: hintTitle and hintTitleColor
  • πŸš€ Improvements:
    • Android: Some big improvements in the Document Scanner UI that make document scanning perform better and much smoother. Increased 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).
    • Android and iOS: Improved recognition of barcodes and QR-codes (live detection and from still images)
  • ⚠️ Breaking Changes:
    • iOS: Dropped support for iOS 9 and iOS 10!
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.74.2 (cf. changelog)
    • Upgraded the native Scanbot iOS SDK to v1.11.2 (cf. changelog)

Version 4.2.1 (28 Sep 2020)​

  • 🐞 Bug fixes:
    • Android: Fixed a crash during the initialization process on some devices with Android 5.1 and less
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.72.3 (see the changelog)

Version 4.2.0 (5 Aug 2020)​

  • πŸŽ‰ New:
    • A new scanner UI component for the European Health Insurance Cards (EHIC)! See the new API function startEHICScanner.
    • Added support for TIFF compression types and for defining custom DPI value as TIFF meta data. See the new options compression and dpi of the writeTIFF() method.
  • πŸš€ Improvements:
    • Improved shared asset copy script with proper error handling and different pathing options
    • Android: Increased resolution of the preview images
  • 🐞 Bug fixes:
    • Android: topBarBackgroundColor now also affects the status bar in all UI components (Document Scanner UI, Cropping UI, etc)
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.71.0 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.19 (see the changelog)

Version 4.1.0 (20 Jul 2020)​

  • πŸŽ‰ New:
    • New and improved Barcode Scanner. Support for multiple barcode scanning
    • Introduced getLicenseInfo() API method to get more information about your license
    • Barcode detection on still (imported) images: detectBarcodesOnImage
    • ML-Based document detection: documentDetectorMode: 'ML_BASED'
  • πŸš€ Improvements:
    • Added support for React Native 0.62.
  • 🐞 Bug fixes:
    • Android: Fixed several crashes that occurred as of React Native 0.62 😑
    • iOS: Fixed multiple beep-boop sounds when scanning barcodes
    • iOS: MRZ Scanner finder aspect ratio is now properly set
  • ⚠️ Breaking Changes:
    • Removed isLicenseValid() API method. Please use getLicenseInfo().isLicenseValid instead.
    • BarcodeResult now contains an array of barcodes
    • Android: minSdkVersion increased to 21
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.70.1 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.15 (see the changelog)

Version 4.0.1 (13 Jan 2020)​

  • πŸš€ Improvements:
    • Android & iOS: Enhanced TypeScript support
  • 🐞 Bug fixes:
    • Android: Fixed a rare case where the application crashed on startup
    • iOS: Fixed issue where document detection status was empty

Version 4.0.0 (11 Nov 2019)​

This version requires React Native 0.60 or higher as well as CocoaPods integration for iOS.

  • πŸŽ‰ New:
    • Added official support for React Native 0.60+ with the Autolinking feature.
    • Android: Migrated to AndroidX libraries.
    • iOS: Added default support for CocoaPods.
  • πŸš™ Under the hood:
    • Upgraded the native Scanbot Android SDK to v1.54.0 (see the changelog)

Version 3.1.0 (10 Oct 2019)​

  • πŸŽ‰ New:

    • Android & iOS: Added a new Images Filter LOW_LIGHT_BINARIZATION_2.

  • 🐞 Bug fixes:

    • Android: Fixed crashes with some image filters, like BACKGROUND_CLEAN, DEEP_BINARIZATION, LOW_LIGHT_BINARIZATION, etc. on ARM 32-bit devices (armeabi-v7).
    • iOS: Fixed modal dialog style of the Document Scanner UI, Cropping UI, Barcode Scanner UI and MRZ Scanner UI on iOS 13. All UI screens are opened in full-screen mode again.

  • πŸš™ Under the hood:

    • Upgraded the native Scanbot Android SDK to v1.39.52.2 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.3 (see the changelog)

Version 3.0.0 (26 Jul 2019)​

  • πŸŽ‰ New:

    • Android & iOS: Reset/Detect functionality in Cropping UI.
    • Android & iOS: Added support for orientationLockMode in Cropping UI.
    • Android & iOS: Support for PDF page sizes (see the createPdf method).
    • Android & iOS: Added new Images Filters OTSU_BINARIZATION, DEEP_BINARIZATION, EDGE_HIGHLIGHT and LOW_LIGHT_BINARIZATION.
    • Android & iOS: A new config option storageBaseDirectory allows to overwrite the storage location of the native Scanbot SDKs on initialization.
    • Android & iOS: Added new config properties in the Document Scanner UI:
      • documentImageSizeLimit - to limit the resolution of the document image.
      • maxNumberOfPages - maximum number of pages to scan.
      • shutterButtonHidden - to hide the shutter button.
      • textHintEnergySavingActive - the text being displayed on the user-guidance label, when the scanners energy saver is activated (iOS only).
    • Android: Added native libs (.so) for the x86_64 architecture.

  • πŸš€ Improvements:

    • Android: Internal Storage - All components of this Module now use the internal storage by default, which is more secure and do not require storage permission prompts. See the Storage section of this documentation for more details.
    • Android & iOS: OCR - Upgraded the OCR engine to Tesseract v4.00. Improved recognition speed and quality. Please also note the Breaking Changes below.
    • Android & iOS: OCR API - Detailed OCR results per page, including bounding boxes for words, lines and paragraphs. See OcrOutputFormat.RESULT_JSON.

  • ⚠️ Breaking Changes:

    • Android: Added file format extension (.jpg or .png) for all Page images. Affects the new image files created by all modules like Document Scanner, Cropping UI, etc. Please note that only the new created image files will contain extensions. The currently available image files in the temporary storage of the Scanbot SDK RN Module will not get file extensions and may become inaccessible. So please make sure to implement a suitable migration mechanism.
    • Android: Internal Storage - In case your app is using the storage for scanned Pages as permanent storage, please make sure to implement a suitable migration. E.g. move the previous archived Page images from the old external storage folder to the new internal storage. Or alternatively overwrite the storage directory to the external folder again by using the new storageBaseDirectory config option.
    • Android & iOS: The config parameter pageCounterButtonTitle in Document Scanner now requires a placeholder "%d" for the number of pages (e.g. pageCounterButtonTitle: "%d Page(s)").
    • Android & iOS: OCR Language Files - If you use the OCR feature of this Module, please upgrade the OCR language files to Tesseract 4.00. See the OCR section of this documentation for more details.

  • 🐞 Bug fixes:

    • Android: Fixed an issue with camera on "Xiaomi Redmi 5 Plus" devices with MIUI Chinese ROM.
    • Android: Fixed a bug with freezing camera on Document Scanner start.
    • Android: Some layout fixes in Cropping UI (aka. inaccessible "DONE" button).
    • Android: Fixed a bug with the Magnifier in Cropping UI (the Magnifier was stuck in a corner).
    • iOS: Fixed issues with orientationLockMode in Document Scanner.
    • iOS: Fixed handling of uiConfigs arguments in Cropping UI (polygonColor, etc).
    • iOS: Fixed a bug with missing Page meta data as result of the detectDocumentOnPage method.
    • iOS: Fixed handling of the config arguments enableCameraButtonTitle and enableCameraExplanationText in Document Scanner UI, Barcode Scanner UI and MRZ Scanner UI.
    • iOS: Fixed the status of the torch light toggle button in the Document Scanner on reactivating the scanning screen.
    • Android & iOS: Various minor fixes and improvements.

  • πŸš™ Under the hood:

    • Upgraded the native Scanbot Android SDK to v1.39.52 (see the changelog)
    • Upgraded the native Scanbot iOS SDK to v1.9.2 (see the changelog)

  • πŸ›  Dependencies:

    • Android: Requires Android SDK 28, Android Support Libs 28+ (com.android.support:*).
    • Android: The native Scanbot Android SDK now uses the latest version of Google Play Services Vision lib v16.2.0 (com.google.android.gms:play-services-vision:16.2.0).

Version 2.0.7 (1 Jul 2019)​

  • Android: Removed minSdkVersion from AndroidManifest.xml.

Version 2.0.6 (20 Dec 2018)​

  • iOS: Fixed Cropping UI configuration.

Version 2.0.5 (28 Aug 2018)​

  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.7:
    • Fixed bitcode generation

Version 2.0.4 (28 Aug 2018)​

  • Under the hood: Upgraded the native Scanbot Android SDK to v1.34.0
    • Upgraded to OpenCV 3.4.2
  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.6

Version 2.0.3 (1 Aug 2018)​

  • New function recognizeMrz(imageFileUri: string) to recognize MRZ data on image file.

Version 2.0.2 (23 Jul 2018)​

  • Android: Various bug fixes and improvements in methods getFilteredDocumentPreviewUri() and applyImageFilterOnPage()
  • Under the hood: Upgraded the native Scanbot Android SDK to v1.33.3
    • Removed the allowBackup flag from AndroidManifest.xml in io.scanbot:sdk-package-ui library
  • iOS: Added the ?minihash= query parameter in result of getFilteredDocumentPreviewUri()
  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.4
    • Fixed memory leaks in Document Scanner

Version 2.0.1 (16 Jul 2018)​

  • iOS:
    • Fixed a bug in PDF creation
    • Fixed property mapping of text key textHintOK
  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.3

Version 2.0.0 (10 Jul 2018)​

  • New Document Scanner UI and Cropping UI - based on the native Ready-To-Use UI Components of the Scanbot SDK for Android and iOS.
  • Multi-page scanning in Document Scanner UI
  • Barcode Scanner UI
  • MRZ Scanner UI
  • TIFF support: provides creation of 1-bit TIFF images with multi-page support
  • New image filter types:
    • PURE_BINARIZED - Creates an image with pixel values set to either pure black or pure white.
    • BACKGROUND_CLEAN - Cleans up the background and tries to preserve photos within the image.
    • BLACK_AND_WHITE - Black and white filter with background cleaning. Creates a grayscaled 8-bit image with mostly black or white pixels.
  • New Scanbot SDK JS API:
    • Promise-based design (compatible with async/await)
    • Typings provide contextual help in JS IDEs
  • Under the hood: Upgraded the native Scanbot Android SDK to v1.33.0
  • Under the hood: Upgraded the native Scanbot iOS SDK to v1.7.2:
    • Dropped support for iOS 8
  • Minor bug fixes and improvements

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
Apryse Logo Glass lightApryse Logo Glass dark

On this page