Skip to main content

Changelog for the Web Data Capture SDK

Version 8.1.1 (2 April 2026)​

  • 🐞 Bug fixes:
    • Document Scanner:
      • RTU UI: Fixed an issue where auto-rotated images were incorrectly cropped in some cases.

Version 8.1.0 (31 March 2026)​

  • 🎉 New:
    • General:
      • RTU UI: Implemented a new unified navigation bar; all scanners now include a camera switch button.
    • Document Scanner:
      • Added FIT_IN support for cameraPreviewMode.
      • Added an option to disable automatic cropping.
    • Image Processing:
      • New ColorDocumentShadowRemovalFilter capable of removing shadows from documents without damaging text, barcodes, or images.
    • PDF Generation:
      • Added a binarization option.
    • Document Quality Analyzer:
      • Added an option to explicitly enable/disable by tile processing via ProcessByTileConfiguration.
    • Text Pattern Scanner:
      • Added the option optimizeSingleLine to TextPatternScannerConfiguration. Enable this option when scanning a single line or a single word that is hard to scan reliably. Disabled by default.
    • Document Data Extractor:
      • Introduced PersonalId common field type.
      • Added support for Romanian, Italian, Turkish, and Polish ID cards.
    • Barcode Scanner:
      • Added the fpsLimit property to limit the frames per second for scanning. This can be used to reduce CPU usage on low-end devices.
      • 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.
  • 🚀 Improvements:
    • General:
      • Improved default camera selection heuristics for devices with multiple cameras.
      • Added explicit enum definitions for document model configuration options that accept enum values.
    • Document Quality Analyzer:
      • Tiling is now enabled by default to reduce peak memory usage.
      • If the provided configuration is invalid, an error will be returned instead of changing invalid fields to default values.
    • OCR Engine:
      • New model with better performance for German diacritics and the ß character.
      • Added support for TR, PO, IT, and RO alphabets.
    • Document Data Extractor:
      • Reduced the likelihood of reading incorrect values for eye color on German ID cards (e.g., GRUN instead of GRÜN).
    • Check Scanner:
      • Support a wider range of USA check formats.
    • 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.
      • Improved recognition of DataMatrix codes under challenging conditions.
      • Significantly improved decoding performance for truncated PDF417 barcodes.
      • Reduced false-positives rate for Code 128.
  • 🐞 Bug fixes:
    • General:
      • Fixed an issue where the grace period of expired licenses was not respected.
      • Fixed an issue where setting the finder visibility to false in the scanner configuration did not hide the viewfinder.
      • Fixed an issue where a black screen was shown in case of camera permission error.
      • Fixed an issue where the front camera and/or external camera was not selected on some devices with multiple cameras.
    • Document Scanner:
      • Fixed the Cropping Screen image not being centered horizontally on larger screens.
      • Classic UI: Fixed the incorrect image being loaded from storage.
      • RTU UI: Fixed an issue where the scanner went into manual mode after opening the file selector dialog.
      • RTU UI: Fixed an issue where the underlying view could be scrolled beneath the scanner view on Safari.
      • RTU UI: Fixed the rotation not being applied to the detected document.
      • RTU UI: Fixed the incorrect "processing" state when rapidly clicking the shutter button multiple times.
      • RTU UI: autoRotateImages should now work properly in all cases.
    • PDF Generation:
      • Fixed an issue where empty pages were generated for images when resampling was used in certain cases.
      • Fixed an issue where invalid sandwich PDFs were generated.
    • MRZ Scanner:
      • Fixed a rare crash with inverted text.
    • Document Data Extractor:
      • Fixed an issue where scanning illegible documents could cause the scanner to return OkButInvalidDocument status.
    • Check Scanner:
      • Fixed an issue where scanning was not resumed after being paused.
  • ⚠️ Breaking changes:
    • Image Processing:
      • ColorDocumentFilter: Removed unused parameters.
    • Document Quality Analyzer:
      • The minProcessedFraction, maxProcessedFraction, minNumberOfRequiredSymbols, and tileSize options are moved into the separate ProcessByTileConfiguration.
    • Document Data Extractor:
      • Document type enum values are now static properties of the document type, e.g. AAMVADocumentType is now AAMVA.DOCUMENT_TYPE.
    • Barcode Scanner:
      • RTU UI: The scanner objects now accept an entire scannerConfiguration property of type BarcodeScannerConfiguration.
      • Reduced the number of false-positive Codabar barcodes when scanning in live mode and the barcode is only partially visible.
      • Removed enableOneDBlurScanner option from common config objects.
      • The option enableOneDBlurScanner is now disabled by default for UPC/EAN barcodes.
      • The barcodeFormats property has been replaced by barcodeFormatConfigurations, which allows more fine-grained configuration of each barcode format. Previous functionality can be replicated as follows: barcodeFormatConfigurations = [ new ScanbotSDK.Config.BarcodeFormatCommonConfiguration({ formats: ["PDF_417", ...] })].
  • 🚙 Under the hood
    • Updated 3rd-party libraries.

Version 8.0.1 (19 January 2026)​

  • 🐞 Bug fixes:
    • Disabled the option to cancel RTU UI scanners before initialization is complete to avoid unexpected behavior.

Version 8.0.0 (24 October 2025)​

  • 🎉 New
    • General
      • Introduced Image API
      • Introduced Check Scanner
      • Introduced Document Data Extractor
      • Reviewed security policy and updated to the new and improved wasm-unsafe-eval CSP header standard. The more comprehensive unsafe-eval exception is no longer required.
    • Document Scanner:
      • Can now detect partially visible documents where all four corners are not visible.
      • Introduced a new PartiallyVisibleDocumentConfiguration object to determine how partially visible documents are aggregated and tracked. This feature is disabled by default.
      • Added two new DocumentDetectionStatus values:
        • ERROR_PARTIALLY_VISIBLE
        • ERROR_PARTIALLY_VISIBLE_TOO_CLOSE
      • The DocumentDetectionResult now includes two new properties to indicate the direction towards the center of a partially visible document:
        • displacementVector
        • displacement
    • Barcode Scanner
      • A new algorithm is used for recognition of 1D symbologies, improving the blurred and distant barcode use cases. This feature is enabled by default, but might be disabled via the enableOneDBlurScanner on low-power devices if needed.
      • Added a new BarcodeScannerEngineMode: NEXT_GEN_MAX_DISTANCE, which is optimized for scanning from far distances on very high-power devices with a 4K video stream.
      • Introduced 4K stream support: BarcodeScannerViewConfiguration.enable4kStream. Should be enabled for high-powered devices and complex and/or distant barcodes. Can cause memory issues on low-end devices. Disabled by default.
      • BarcodeItem has a new field rawBytesEncodings that contains the precise character encoding information of rawBytes.
      • BarcodeItem has a new field structuredAppendInfo for messages split across multiple barcodes.
      • BarcodeScannerConfiguration has a new field accumulationConfig which allows the accumulation of barcodes over multiple frames in live mode. BarcodeItem has a new field globalIndex to identify a barcode across multiple frames.
    • MRZ Scanner:
      • Added a property to MrzScannerConfiguration that allows setting whether crops should be returned. (Default: false).
    • Document Quality Analyzer:
      • Added an option (inspectSmalltext property) to detect small text. Ignored by default.
      • Added cumulativeContrastHistogram and cumulativeTextSizeHistogram for text contrast and text size estimation.
      • Added orientationConfidence of the document as a new analysis property.
  • 🚀 Improvements
    • General:
      • All OCR-based features now benefit from new OCR models that are optimized for speed and accuracy.
      • Improved error messages when a feature is accessed that is not available in the loaded flavor of the SDK.
      • The definition of DeepPartial has been improved so that it now requires _type for polymorphic types.
    • Document Scanner
      • Increased performance for Document Scanner algorithms.
      • Improved storage performance and reliability.
      • PDF Generator with OCR layer now handles non-ASCII characters correctly.
      • Aspect ratio scores are now symmetrical, and low scores are more consistent.
    • PDF Generation:
      • PDF generation now supports binarized images. Binarized images are stored in the PDF with an optimized compression algorithm,
      • PDF Generator with OCR layer now handles non-ASCII characters correctly. resulting in extremely small file sizes.
    • Document Quality Analyzer:
      • Speed improvements. Note: document quality scores may slightly change for the same input images when compared to the previous version of the DoQA.
    • Barcode Scanner
      • Boarding pass document parser now supports up to version 8 of the IATA-BCBP standard.
      • vCard document parser was improved.
      • GS1 Composite codes are now processed faster in Scan from Image mode.
    • 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.
    • OCR-based features:
      • Improved handling of special characters like umlauts when frame accumulation is used.
  • 🐞 Bug fixes
    • Document Scanner
      • Fixed a rare division by zero crash.
      • Now correctly returns ERROR_TOO_DARK when nothing is detected and the image brightness is below the threshold.
    • MRZ Scanner
      • RTU-UI v2: Fixed issue where preset overlay was not shown in some cases.
      • Fixed a rare division by zero crash.
      • Fixed an issue causing null to be returned as a confidence of empty fields.
    • Barcode Scanner:
      • The carrier identifier for MaxiCode mode 3 might be encoded by using different codewords. Now, all possible codewords are checked.
      • vCard document parser now correctly processes the FN key as FormattedName.
  • ⚠️ Breaking Changes
    • General
      • Adopted a new API design model: Results retrieved from ScanbotSDK scanners are now suffixed with *Result.
      • Unified scanner view configuration's scanner configurations under *ViewConfiguration.scannerConfiguration.
      • Removed recognizeURL from various still image scan services. Use our new Image class API to fetch images from URLs.
      • Image operations (rotate, resize, crop, filter) are now located under the ImageProcessor service (sdk.createImageProcessor()).
    • Document Scanner
      • The still image detection function detectAndCropDocument returns DocumentScannerScanResponse, which contains the original image as well as DocumentScanningResult.
      • Exposed the more comprehensive and unified DocumentScannerConfiguration to the corresponding classic component instead of DocumentScannerParameters. The parameter object is now a property of the configuration object.
      • Renamed DocumentDetectionResult to DocumentScanningResult.
      • processingMode has been moved from DocumentScannerParameters to DocumentScannerConfiguration.
      • Deprecated CroppedDetectionResult in favor of DocumentScannerScanResponse.
      • Removed DocumentScannerViewConfiguration.ignoreBadAspectRatio. Please use DocumentScannerViewConfiguration's scannerConfiguration.parameters.aspectRatios and scannerConfiguration.parameters.acceptedAspectRatioScore.
      • RTU-UI v2: Removed the ERROR_TOO_NOISY and OK_BUT_OFF_CENTER DocumentDetectionStatus values.
    • Image Processing:
      • Filters: The ColorDocumentFilter now works slightly differently by default. To get the previous behavior, set paperWhitening=0 and paperWhiteningBias=64.
    • MRZ Scanner
      • Removed SimpleMrzRecognizer (createSimpleMRZRecognizer) in favor of the new unified MrzScanner (createMrzScannerEngine).
    • Feature removal:
      • Removed legacy image filters.
  • 🚙 Under the Hood
    • Moved to React 18 root-based rendering system.
    • Updated 3rd-party libraries.

Version 7.2.0 (02 June 2025)​

  • 🎉 New:
    • Introduced Ready-To-Use MRZ Scanner UI.
    • Added minimumInsets and preferredHeight to ViewFinderConfiguration in order to change its size and location.
    • RTU-UI: Added the option to insert HTML links directly into camera permission denied screen.
    • Added pattern grammar to pattern content validation. Selectable grammars are: WILDCARD and REGEX.
    • Added onComplete callback to InitializationOptions to allow better handling of deferred initialization.
    • Added option to programmatically cancel RTU UI controllers: await ScanbotSDK.UI.abortScanner().
  • 🚀 Improvements:
    • Slightly changed ViewFinder default size and positioning in order to accommodate the aforementioned new API.
    • Slightly improved PDF417 barcode recognition.
    • RTU UI: Introduction screen is now always shown when showAutomatically is set to true.
    • RTU UI: Improved Barcode Scanner multi-line text handling.
  • 🐞 Bug fixes:
    • Disabled Clear All button by default in sheet view of Multi Barcode Scanner.
    • Fixed niche iOS 16 issue where SIMD was supported but Extended Constant Expressions were not, causing the scanner to freeze.
    • Fixed a bug for Code 93 in case of stripCheckdigits=false (which is the new default behavior) and in case a check digit was an extension character.
    • RTU UI: Fixed the value of requiredAspectRatios parameter being ignored.
  • ⚠️ Breaking changes:
    • Renamed the engine modes NEXT_GEN_AR to NEXT_GEN_FAR_DISTANCE and NEXT_GEN_LOW_POWER_AR to NEXT_GEN_LOW_POWER_FAR_DISTANCE. They were already optimized to scan from far distance. Now, both have been improved so that they can also scan from a short distance.
    • Removed live property from Barcode Scanner and Document Scanner configs.
    • MrzScannerView now returns unvalidated (by frame accumulation configuration) results. Unvalidated results can be filtered out via the success flag.

Version 7.1.0 (17 March 2025)​

  • 🎉 New:
    • OCR on PDF! It's now possible to run OCR when generating a PDF, see the runOcr property of PdfPageOptions.
  • 🐞 Bug fixes:
    • Fixed a render issue after a barcode was deleted from the drawer list.
    • Fixed barcode format UPC_E mapping issue that caused barcode types EAN_8, EAN_13 and UPC_A to be recognized.

Version 7.0.2 (20 February 2025)​

  • 🎉 New:
    • Added ignoreOrientationMismatch user guidance text localization for the RTU-UI Document Scanner.
    • Added returnBarcodeImage property to BarcodeScannerConfiguration. If true, the barcode image will be returned in the result. Defaults to false.
  • 🐞 Bug fixes:
    • Fixed issue where ignoreOrientationMismatch was not respected in the Classic Document Scanner.
  • ⚠️ Breaking changes:
    • If you work with Barcode Scanner result images, returnBarcodeImage must now be set to true in the BarcodeScannerConfiguration.
    • Renamed ignoreBadAspectRatio to ignoreOrientationMismatch in the RTU-UI Document Scanner configuration.

Version 7.0.1 (05 February 2025)​

  • 🐞 Bug fixes:
    • Fixed an issue where the container parameter was not respected when the containerId property was missing.
    • Specified a null return type in the document scanner handle's detectAndCrop function.

Version 7.0.0 (30 January 2025)​

  • 🎉 New:
    • Introduced Ready-To-Use Document Scanner UI.
    • Introduced Persistent Storage API.
    • Added Find and Pick use case for Barcode Scanner RTU UI.
    • The MRZ Scanner has new configuration options under MrzScannerConfiguration.recognizerConfiguration.
    • DocumentScannerViewConfiguration now has a new field detectionParameters of type DocumentScannerParameters, which incorporates and replaces the parameters acceptedBrightnessThreshold, acceptedAngleScore and acceptedSizeScore. Additionally, this object allows the configuration of a rectangleOfInterest and an acceptedBrightnessThreshold.
    • Classic Document Scanner component now returns a DocumentDetectionResult, which has a few new informative fields, such as the detectionScores and aspectRatio. With these one can fine-tune which scan results are deemed acceptable.
    • Added an option to configure the Document Detector's aspect ratio tolerance: acceptedAspectRatioScore.
    • Classic Barcode Scanner: The new BarcodeScannerConfiguration type allows a more fine-grained configuration of the barcode detection process. For each type of barcode, several parameters can now be controlled, e.g. the minimum quiet zone around 1D barcodes, a regex-filter, etc. This is only available for the Classic UI, not the Ready-to-Use UI.
    • Classic and Ready-To-Use Barcode-Scanner: BarcodeItem has a new sizeScore field with a value between 0 and 1 that represents the relative size of the barcode compared to the size of the input image. All barcode configurations have a new float minimumSizeScore that is set to 0 by default. All barcodes with sizeScore < minSizeScore are ignored. Note that minSizeScore can be chosen differently for each barcode format.
    • Classic Barcode Scanner: The BarcodeScannerConfiguration has a new flag onlyAcceptDocuments. If this flag is enabled, we only return barcodes that were parsed as barcode documents in the list of acceptedDocumentFormats (if this list is empty, we return all detected barcodes independent of the flag).
    • Introduced support for new barcode formats that are used in the pharmaceutical industry: PHARMA_CODE, PHARMA_CODE_TWO_TRACK and PZN (Pharmazentralnummer).
    • Barcode & Document Ready-To-Use UI: Added new camera configuration property idealPreviewResolution. This is directly translated to the ideal property of the videoConstraints object.
    • Added barcode document parsing to the Ready-To-Use UI Barcode Scanner.
    • The VIN Scanner now has the option to scan VINs from barcodes.
    • The Document Quality Analyzer can now also return the orientation of the document in steps of 90 degrees. Enabled by setting DocumentQualityAnalyzerConfiguration.detectOrientation to true.
    • Added a new image filter preset - PRESET_5, an improved version of PRESET_4, that also works well on documents with barcodes.
  • 🚀 Improvements:
    • Improved error handling: Edge cases that prevented the SDK to load in certain scenarios now produce better error messages.
    • Images from the various API functions are no longer returned as encoded JPEG but as a RawImage. RawImage objects can be converted to JPEGs using the new function sdk.imageToJpeg. This speeds up all the API functions that return images, because the slow image-encoding step is now only done on demand. Most API functions that take images as input now also allow the input to be a RawImage.
    • The ScanbotSDK.Config namespace now bundles almost all configuration classes of the SDK.
    • sdk.detectDocument now takes a DocumentDetectorParameters argument, instead of individual parameters.
    • Classic and Ready-to-Use UI Barcode Scanner: The gs1Handling property now has more fine-grained validation options.
    • Classic and Ready-to-Use UI Barcode Scanner: Added new EngineMode options called NEXT_GEN_LOW_POWER_AR and NEXT_GEN_AR which are optimized for detecting multiple barcodes in live mode.
    • The Barcode Ready-to-Use UI MultipleScanningMode has a new option allowEmptySubmission which defaults to false.
    • Classic Barcode Scanner: A new flag addAdditionalQuietZone can be set. This flag should be used to scan sharp/tight crops of a barcode.
    • Classic and Ready-to-Use UI Barcode Scanner: Improved quiet zone handling for the barcode formats ITF, CODE_11, MSI_PLESSEY, IATA_2_OF_5, INDUSTRIAL_2_OF_5 and CODE_25.
    • sdk.createDocumentQualityAnalyzer configuration object has been revamped. This new configuration object has many more options to trade off analysis speed vs. accuracy.
    • The Document Quality Analyzer has been added to the "document-scanner" flavor of the SDK.
    • The VIN Scanner config now contain a new field detectionConfiguration of type VinScannerConfiguration that incorporates/replaces most of the previous configuration fields.
    • The VIN Scanner now returns a VinScannerResult, which contains more detailed information about each recognized word and character. It also contains information about the scanned barcode (if enabled).
    • Added optional container property to all Classic scanners, allowing the container element itself to be passed to the SDK, which solves cases where the document cannot be found by its id, e.g. in case of shadow DOM.
    • For devices with multiple cameras, we improved our code that decides which camera is chosen for a scanner. This aims to reduce the number of devices for which a "fish-eye" or telelense camera is picked, which are usually not desirable for scanning.
    • Improved internal memory management. This should reduce peak memory usage and avoid memory-related crashes on some old devices.
    • getLicenseInfo now also reports the date when the license will expire.
  • 🐞 Bug fixes:
    • For ITF, we fixed the usage of minimumTextLength. Before, we used it to check the number of symbols instead of the true text length.
    • Fixed a bug where AR overlay was not correctly positioned when the video was mirrored.
  • ⚠️ Breaking changes:
    • The Document Quality Analyzer no longer returns the value NO_DOCUMENT. It now returns null if no document is found.
    • The old DocumentDetectionResult has been refactored and replaced by CroppedDetectionResult, which now extends a new DocumentDetectionResult.
    • In SDK initialization, engine has been renamed to enginePath. Note that this parameter is now mandatory.
    • Removed applyFilter, rotateImageCcw and cropAndRotateImageCcw. Use the new functions imageFilter, imageRotate and imageCrop instead.
    • The image filter configuration objects have been moved from ScanbotSDK.imageFilters.* to ScanbotSDK.Config.ParametricFilter.*.
    • sdk.beginTiff signature changed and now takes a TiffGeneratorParameters argument, which has more options than before, e.g. jpegQuality, the ability to add user-defined fields in the TIFF file, etc.
    • sdk.beginPdf signature changed and now takes a PdfConfiguration argument, which has more options than before. Specifically, the ability to add custom attributes in the final PDF file.
    • Classic Component: Type rename: MrzScannerConfiguration -> MrzScannerViewConfiguration.
    • The MRZ Scanner returns a MrzScannerResult, which contains a GenericDocument. This result type has a slightly different structure than before, but provides more detailed information about the recognized MRZ.
    • MrzScannerConfiguration's accumulatedFrameVerificationConfiguration was moved to MrzScannerConfiguration.recognizerConfiguration.
    • Classic Component: Type rename: DocumentScannerConfiguration -> DocumentScannerViewConfiguration.
    • Classic Document Scanner component: The default acceptedSizeScore changed from 75 to 80.
    • DocumentDetectionStatus and HintTextConfiguration names have changed slightly, e.g. Error_Brightness was renamed to ERROR_TOO_DARK. Also, the new state OK_BUT_TOO_DARK was added.
    • Classic Barcode Scanner: Type rename: BarcodeScannerConfiguration -> BarcodeScannerViewConfiguration.
    • Classic Barcode Scanner: BarcodeScannerViewConfiguration also contains a detectionParameters field of type BarcodeScannerConfiguration which incorporates & replaces the parameters barcodesRegexFilter, gs1Handling, engineMode, returnBarcodeImage and barcodeFormats.
    • sdk.detectBarcodes now takes a BarcodeScannerConfiguration argument, instead of individual parameters.
    • Classic and Ready-to-Use UI Barcode Scanner: The barcode detection result's parsedDocument has been renamed to extractedDocument.
    • Classic and Ready-to-Use UI Barcode Scanner: The barcode detection result's rawBytes now contains a Uint8Array instead of a base64 string.
    • Classic and Ready-to-Use UI Barcode Scanner: The regexFilter option for barcode detection now requires that the entire scanned code matches the regex. Previously, it was enough if a substring matched the regex.
    • The Barcode Ready-to-Use UI result types BarcodeScannerResult and BarcodeScannerItem have been renamed to BarcodeScannerUiResult and BarcodeScannerUiItem.
    • The mode parameter of the function sdk.createOcrEngine has been removed.
    • OcrEngine.performOcr now returns an OcrTypes.Page object. This structures OCR results into text-blocks containing text-lines containing words. Each of these objects is annotated with positions and a confidence score. This allows for a more detailed analysis of the OCR results.
    • sdk.createTextDataScanner has been renamed to sdk.createTextPatternScanner. Associated types have also been renamed.
    • Classic Component: Type rename: TextDataScannerConfiguration -> TextPatternScannerViewConfiguration.
    • TextLineScanner and associated types have been renamed to TextPatternScanner.
    • TextPatternScanner now return a TextPatternScannerResult, which contains more detailed information about each recognized word and character.
    • TextPatternScannerViewConfiguration now contains a new property ocrConfiguration of type TextPatternScannerConfiguration that incorporates/replaces most of the previous configuration fields.
    • TextPatternScannerConfiguration.supportedLanguages has been removed.
    • In TextPatternScannerViewConfiguration, validationPattern, matchSubstring and allowedCharacters have been moved to PatternContentValidator, which is one possible value of the TextPatternScannerViewConfiguration.ocrConfiguration.validator field.
    • The parameter names for image rotation have been renamed. They are now called NONE instead of ROTATION_NONE, CLOCKWISE_90 instead of ROTATION_90_CLOCKWISE, etc.
    • The Document Quality Analyzer now returns a DocumentQualityAnalyzerTypes.DocumentQualityAnalyzerResult object, instead of a string.
    • ImageProcessor has been removed. Instead, there are now the functions imageRotate, imageFilter, imageCrop and imageResize, which can be used to process images.
    • Type rename: VinScannerConfiguration -> VinScannerViewConfiguration.
    • Renamed createVINScanner to createVinScanner.
    • VIN Scanner config field onTextDetected has been renamed to onVinDetected.
    • LicenseInfo.description has be renamed to LicenseInfo.licenseStatusMessage. LicenseInfo.status values are now in screaming-snake case (e.g. FailureExpired is now FAILURE_EXPIRED).
  • 🚙 Under the hood:
    • Updated 3rd-party libraries:
      • Added embla carousel
      • Added gs1-syntax-dictionary lib

Version 5.1.3 (16 August 2024)​

  • 🐞 Bug fixes:
    • Fixed a camera API quirk in the RTU UI Barcode Scanner component that resulted in a crash in Firefox

Version 5.1.2 (7 August 2024)​

  • 🐞 Bug fixes:
    • Fixes a bug where enabling multi-threading caused a significant slow-down for live-scanners, especially at high resolutions

Version 5.1.1 (10 June 2024)​

  • 🐞 Bug fixes:
    • Fixes a bug where the document outline in the cropping view is not correctly updated
    • Fixes a bug where the RTU UI Barcode Scanner would not scan well if multiple barcodes are visible in the same frame

Version 5.1.0 (31 May 2024)​

  • 🎉 New:
    • Introduced a new Ready-To-Use Barcode Scanner UI.
    • Support of new barcode type MICRO_PDF_417.
    • AAMVA Title Document Parser.
    • Added more options to the text data scanner: validationPattern, matchSubstring and allowedCharacters.
  • 🚀 Improvements:
    • Large performance increase thanks to improved multi-threading.
    • WASM loading & camera opening now happen in parallel, resulting in a reduced time-to-scan. If WASM is still loading when the camera is already opened, a spinner is shown.
    • WASM and JS files will now be requested with an additional cache-busting query parameter to ensure the latest version is always used. E.g., instead of ScanbotSDK.Asm.wasm, the file will now be requested as ScanbotSDK.Asm.wasm?5.1.0. This behavior can be configured or disabled using the requestSuffix config option during SDK initialization.
    • ImageProcessor: JPEG reading and writing is substantially faster thanks to multithreading.
    • Error and Erasure Correction to improve PDF_417, MICRO_PDF_417, and GS1_COMPOSITE.
    • Image filters: Antialiasing now requires significantly less memory.
    • Trimmed frames of MSI_PLESSEY, ITF, and CODABAR were likely scanned as false positives since the quiet zone requirement was not appropriately handled. Now, in live mode, we require a certain distance to the boundary and an additional quiet zone check.
    • Revamped ViewFinder with new styling options, including cornered or stroked style, strokeColor and -Width and configurable cornerRadius.
  • ⚠️ Breaking changes:
    • Barcode.parsedText is now called Barcode.parsedDocument and has a slightly different structure.
    • Removed deprecated ViewFinder left, right, top, widthProportion properties.
    • Support for jsdelivr CDN has been deprecated and will be removed in one of the next versions. Please host the SDK files on your own server or use a CDN of your own.
    • A workaround for certain webpack configurations (most notably that of create-react-app) has been removed. If you run into webpack errors when importing from scanbot-web-sdk/webpack, please switch to importing directly from scanbot-web-sdk and handle the hosting of the WASM files manually.
    • Multi-threading now requires the HTTP header Cross-Origin-Resource-Policy of value cross-origin to be set for the bundle/bin/*/*.js files. Before, a value of same-origin was also acceptable for that header.

Version 5.0.1 (30 Apr 2024)​

  • 🐞 Bug fixes:
  • Fixed an issue where the text data scanner would not open, unless the validatorPreset was set.

Version 5.0.0 (22 Mar 2024)​

  • 🎉 New:
    • Added torch controls for scanner views for a limited set of devices & browsers
    • Added more options to PDF generation: dpi, pageFit, jpegQuality, resample
    • Support new barcode type GS1_COMPOSITE (CC-A, CC-B and CC-C). We allow for composites with a linear component that can be RSS_14, RSS_EXPANDED, DATABAR_LIMITED or CODE_128.
  • 🚀 Improvements:
    • Many improvements to the cropping view. Most notably, pointer events no longer get lost when moving things about too quickly, and dragging handles now have an invisible 50x50 pixel hitbox, to make them easier to grab on mobile devices.
    • Massive overhaul of camera permission and error handling
    • Added frame accumulation based verification to MRZ scanner
    • New ImageProcessor API that allows for improved filters and more efficient post-processing of scan results
    • New API reference available at docs.scanbot.io
    • Significantly reduced WASM binary sizes (-2MB)
    • Added pdf renderer to Package 1 (Document scanner SDK). Previously it was only available in Package 2 (Full SDK).
    • Improved image sharpness calculation per document-template to filter blurry frames faster
    • Increased speed of tiff 1 bit packing
    • Text detection in Text Data & VIN scanner is faster and more accurate
    • Improved speed of document detection
  • ⚠️ Breaking changes:
    • Deprecated legacy errors and implemented proper permission checks. For specifics, see Handling Errors
    • TiffGenerator no longer has its own binarization options. Instead, apply a binarization filter using the new ImageProcessor API as described here.
    • GS1 string handling is now uniform across all supported GS1 symbologies (Code128, DataMatrix, QR Code, DataBar 14, DataBar Limited, DataBar Expanded, GS1 Composite)
    • Renamed RSS_14 to DATABAR and RSS_EXPANDED to DATABAR_EXPANDED
    • Older Safari on iOS are no longer supported. The minimum supported iOS version is now 14.5+
  • 🐞 Bug fixes:
    • DataBar Limited: add "(01)" prefix to result string
    • Fixed an issue in which the confidence of MRZ fields could be NaN
    • Fixed an issue with cross-validation between MRZ and Passport data
    • SimpleMrzRecognizer.recognizeURL will now resolve to undefined if recognition failed. Previously, it would remain in the pending state.
    • Fixed a bug where the VIN scanner would also successfully scan non-VIN text

Version 4.0.1 (26 Jan 2024)​

  • 🐞 Bug fixes:
  • Fixed an issue where css class-based styling of the document scanner view was not working

Version 4.0.0 (15 Dec 2023)​

  • 🎉 New:
    • Introduced DocumentQualityAnalyzer to replace deprecated BlurDetector
    • Introduced barcode formats USPS_INTELLIGENT_MAIL, ROYAL_MAIL, JAPAN_POST, ROYAL_TNT_POST, AUSTRALIA_POST and DATABAR_LIMITED
    • Introduced Scanbot PDF Renderer
    • Introduced a new OCR engine based on ML algorithms that is much faster and less error prone
    • Added path style configuration to our Document Scanner Configuration, allowing capture completion animation!
    • Added ImageCapture API support - Snap full-resolution images from the camera!
    • Added validatorPreset property to TextDataScannerConfiguration to simplify scans of specific text types, e.g. VIN
    • Added createVinScanner, a simple way to instantiate a vehicle identification number (VIN) scanner.
  • 🚀 Improvements:
    • Decreased complete binary size by more than 3MB
    • Improved WebAssembly memory management for a smoother experience
  • ⚠️ Breaking changes:
    • Removed BlurDetector
    • Removed dpi option from PDF generation options. DPI is chosen automatically
    • Removed paperWidthInches and paperHeightInches from PDF generation options. standardPaperSize now features various formats to replace custom sizing
    • Removed landscape boolean property from PDF generation options, added pageDirection property
    • Removed tessdata files from bundle
    • OCR engine constructor no longer takes languages parameter, now features an optional mode parameter

Version 3.0.1 (19 Oct 2023)​

  • 🐞 Bug fixes:
    • Fixed case where snapped image was not returned when document detection failed

Version 3.0.0 (02 Oct 2023)​

  • 🎉 New:
    • Introduced ML-Based document detector - incredible performance and accuracy increases!
  • 🚀 Improvements & 🚙 Under the hood:
    • Vectorised WASM binaries - increased performance for parallel computations such as cropping and image filter application
    • Models now run on TensorFlow.js binaries (with vectorization and threading!) - increased performance across the board!
  • 🐞 Bug fixes:
    • Fixed document polygon outline styling
  • ⚠️ Breaking changes:
    • OutlinePolygonStyleConfiguration now has four properties: strokeCapturing, fillCapturing, strokeSearching, fillSearching, instead of the previous stroke and fill properties

Version 2.14.0 (24 Aug 2023)​

  • 🎉 New:
    • Barcode Scanner AR Overlay
    • Added MICRO_QR_CODE barcode format
  • 🚀 Improvements:
    • Enhanced & smoothed out document detection polygon animations
    • New generation of Text Data Scanner component. The quality and speed of scanning has significantly improved
  • 🐞 Bug fixes:
    • Removed intrusive Device: ${preferredCamera} is not found error logging
  • 🚙 Under the hood:
    • Added framer-motion dependency

Version 2.13.1 (12 Jul 2023)​

  • 🎉 New:
    • setRecognitionResolution now works for live detection as well, not just for still images
  • 🐞 Bug fixes:
    • Fixed setZoom typings missing zoom parameter

Version 2.13.0 (29 Jun 2023)​

  • 🎉 New:
    • Barcode Scan & Count feature: enabled via scanAndCount property of BarcodeScannerConfiguration
    • Added option to pass the container html element in scanner configuration as an alternative to containerId string parameter
    • Added option to update barcode scanner input resolution at scanner runtime via barcodeScanner.setRecognitionResolution(n) – this provides the option to either go for a more performant scan or a more accurate scan
  • 🐞 Bug fixes:
    • Fixed issue where auto capture enable/disable was not updated at scanner runtime
  • 🚙 Under the hood:
    • Better per-frame accuracy for QR_CODE
    • Unify MRZ interface and create Generic Document interface
    • Code39 and Code93 should decode slightly faster
    • Support inverted PDF-417 barcodes

Version 2.12.0 (6 Apr 2023)​

  • 🚀 Improvements:
    • Improved performance and accuracy of machine-readable-zone recognition.
  • 🎉 New:
    • parsedText property is introduced in BarcodeResult. If the data is structured and parsing is supported for the data type, this structured data will be parsed into document-like data structures.
  • 🚙 Under the hood:
    • Updated third-party libraries.
    • Updated TensorFlow Lite to 2.10
    • Improved allocated memory releasing mechanism for:
      • Text Data scanner
      • MRZ scanner
      • TIFF creator
      • Blur estimator

Version 2.11.0 (2 Mar 2023)​

  • 🎉 New:
    • fetchAvailableCameras API was introduced to query the available cameras on the running browser. Available in DocumentScanner, BarcodeScanner, MrzScanner and TextDataScanner
    • getActiveCameraInfo API was introduced to retrieve information of the active camera on the scanner. Available in DocumentScanner, BarcodeScanner, MrzScanner and TextDataScanner
    • switchCamera API was introduced to switch any of the available cameras on the running browser. Available in DocumentScanner, BarcodeScanner, MrzScanner and TextDataScanner
    • showFinder parameter was added into BarcodeScannerConfiguration to initialize BarcodeScanner with or without the finder rectangle
    • widthProportion parameter was added into style.window parameters of all the scanners. This parameter is used to configure the size of the finder rectangle in proportion to the visible screen width
    • preferredCamera parameter was added into DocumentScannerConfiguration, BarcodeScannerConfiguration, MrzScannerConfiguration and TextDataScannerConfiguration. This parameter is used to pass a preferred camera label or camera device id to a scanner to decide which camera to start with
  • ⚠️ Breaking changes:
    • Removed paddingPropLeft in style.window parameters from all the scanners. The new configuration widthProportion can be used as a replacement

Version 2.10.0 (30 Jan 2023)​

  • 🚀 Improvements:
    • Improved the error handling in all scanners and introduced LicenseError that is thrown when a client calls any of the Scanbot SDK functions while having a license error. See Handling Errors.
    • Barcode Scanner optionally returns barcode images along with the barcode recognition result. See Configuration.
  • 🐞 Bug fixes:
    • Firefox on Android: when switching to the rear camera, the camera went black and could not be initiated again until the tab was closed and the browser was restarted.
    • isValid() method of LicenseInfo returned false when the status was equal to Trial. It should now return true while the trial mode is active.
  • ⚠️ Breaking changes:
    • Default camera resolution of Barcode Scanner, MRZ Scanner and Text Data Scanner was changed from UHD: 3840 x 2160 to HD: 1920 x 1080.
    • onError callback is now mandatory when configuring Document Scanner, Barcode Scanner, MRZ Scanner and Text Data Scanner. See Handling Errors.
  • 🚙 Under the hood:

Version 2.9.2 (9 Nov 2022)​

  • 🎉 New:
    • API method swapCameraFacing was introduced to switch between the front and rear camera in the Barcode Scanner, Document Scanner, MRZ Scanner and Data Scanner
  • 🚀 Improvements:
    • Further improvements on memory usage
  • 🚙 Under the hood:

Version 2.9.1 (29 Aug 2022)​

  • 🐞 Bug fixes:
    • When camera access was not given, scanners would throw an exception instead of using an error callback

Version 2.9.0 (11 Aug 2022)​

  • 🎉 New:
    • Text Data Scanner UI to perform text recognition
  • 🚀 Improvements:
    • Further improvements on memory usage
  • 🐞 Bug fixes:
    • Viewfinder overflows when device orientation changed

Version 2.8.2 (22 Jun 2022)​

  • 🚀 Improvements:
    • Updated README

Version 2.8.1 (18 May 2022)​

  • 🐞 Bug fixes:
    • The resolution of the generated PDF document was not reflecting the passed dpi value

Version 2.8.0 (11 May 2022)​

  • 🎉 New:
    • Dragging the points on the Cropping screen is now enabled on non-touch screen environments such as clicking via a mouse in a browser
    • saveImageAsJpeg utility function was introduced to help save a scanned document as a JPEG file
  • 🚀 Improvements:
    • Huge improvement on the speed and accuracy of 1D barcodes recognition
    • Improved accuracy of auto-capturing process in the document scanner
  • 🐞 Bug fixes:
    • Document size in a PDF page was not consistent while creating a PDF from a scanned document

Version 2.7.0 (16 Mar 2022)​

  • 🚀 Improvements:
    • Improved performance of Barcode, MRZ and Document Scanners
    • Significantly improved recognition of Aztec, PDF417 and Datamatrix barcodes
    • Improved the error handling in Document Scanner

Version 2.6.1 (10 Dec 2021)​

  • 🚀 Improvements:
    • Throwing specific errors on creating scanners (i.e. createDocumentScanner, createBarcodeScanner, createMrzScanner)

Version 2.6.0 (30 Nov 2021)​

  • 🎉 New:
    • Blur detection: The Blur Detector API allows you to detect the blurriness of images.
    • Document scanning on still images: Detects document on a still image on a JPG file regardless of the image source
    • Cropping on still images: Cropping and rotation operations on a still image on a JPG file regardless of the image source
  • 🐞 Bug fixes:
    • Fixed: MRZ Scanner 'RuntimeError: divide by zero error' while scanning clean solid colored images

Version 2.5.3 (5 Nov 2021)​

  • 🚀 Improvements:
    • Improving the polygon detection performance in time on document scanning
    • Preventing capturing multiple documents at once
    • Further improvements on memory usage

Version 2.5.2 (27 Oct 2021)​

  • 🐞 Bug fixes:
    • ViewFinder doesn't work well on all devices with different aspect ratios and resolutions
    • MRZ result is not right on Android on Firefox browser
    • Document Scanner captures black screen on iOS 15
  • 🚀 Improvements:
    • Improvement on memory usage regarding to bug: Scanner camera preview turns blank on iOS 15

Version 2.5.1 (8 Oct 2021)​

  • 🐞 Bug fixes:
    • Fixed: Polygons are not visible on Document Scanner

Version 2.5.0 (6 Oct 2021)​

  • 🎉 New:
    • MRZ Scanner UI
  • 🚀 Improvements:
    • In WindowStyleConfiguration, aspectRatio and paddingPropLeft elements can be used for configuring the size of the view-finder in a more responsive way for Barcode Scanner and MRZ Scanner. Styling
  • 🐞 Bug fixes:
    • Fixed: disableScroll in cropping view is not working as expected
  • ⚠️ Breaking Changes:
    • The type of style attribute of BarcodeScanner is refactored. It is changed from BarcodeScannerStyle to ViewFinderConfiguration Styling
    • text attribute is removed from BarcodeScannerConfiguration and the functionality is moved into ViewFinderConfiguration as hint Styling

Version 2.4.1 (6 Sep 2021)​

  • 🎉 New:
    • Additional parameter barcodeFormats: BarcodeFormat[] in BarcodeScannerConfiguration to specify the enabled barcode formats
    • Ability to scan MSI Plessey barcodes via passing MSI_PLESSEY in barcodeFormats parameter to BarcodeScannerConfiguration
  • 🚀 Improvements:
    • Improved the document scanner instructions to make it compliant with Scanbot mobile demo apps.
  • 🐞 Bug fixes:
    • Fixed: Document scanner instructions are not configurable. Now you can pass TextConfiguration to DocumentScannerConfiguration

Version 2.4.0 (13 Aug 2021)​

  • 🎉 New:
    • Added engineMode property of type EngineMode on barcode scanning APIs - BarcodeScannerConfiguration to switch between the legacy barcode engine and the new Next Generation barcode engine. By default, the new engine is used.
    • Exposed version info API: ScanbotSDK.version
    • Exposed Barcode Finder View positioning API: left, top and transform properties
  • ⚠️ Breaking Changes:
    • Removed experimental image filter types trinarization and lightMapNormalization

Version 2.3.0 (7 June 2021)​

  • 🎉 New:
  • 🚀 Improvements:
    • Revamped barcode view finder to support additional styling
  • 🐞 Bug fixes:
    • iOS: Fixed view finder turning gray on zoom
  • 🚙 Under the hood:
    • Updated internal dependencies to latest versions

Version 2.2.0 (27 Apr 2021)​

  • 🎉 New:
    • Magnifier View for Cropping View
  • 🚀 Improvements:
    • Exposed videoConstraints to Scanner Configuration, allowing to set facingMode and advanced options
    • Added source ImageData object to Barcode Scanner Result (ImageData object extracted from canvas)
    • Added mirrored option to Scanner Configuration (false by default)
    • Remove partially-supported MSI_PLESSEY barcode format
    • Improved how Scanbot Web SDK handles access errors. See Error Handling Section
    • Added option to add experimental or advanced constraints via scanner configuration.
  • 🐞 Bug fixes:
    • Barcode Finder Window custom positioning fix
    • Fixed auto-focus issue on certain android devices

Version 2.1.0 (3 Mar 2021)​

  • 🎉 New:
    • Barcode Scanner – Scanner view to scan various barcodes
  • 🐞 Bug fixes:
    • Fixed issue where camera component was not properly disposed of
  • ⚠️ Breaking Changes:
    • Moved Polygon object to utils/dto/polygon package
    • Moved DetectionStatus to model/document/detection-status package
    • Renamed and moved model/response/detection-result to model/document/document-detection-result

Version 2.0.2 (16 Feb 2021)​

  • 🎉 New:
    • TIFF support – The ability to export scanned images as binarized TIFF
  • 🚀 Improvements:
    • All typing imports now available from the @types root package
    • CroppingViewConfiguration now features a rotations property. The rotations property is also contained in CroppingResult after applying the crop
  • 🐞 Bug fixes:
    • Respect existing rotation state when re-applying detection
  • ⚠️ Breaking Changes:
    • Moved PdfGeneration(Options) and TiffGenerator(Options) to the service package

Version 2.0.1 (8 Feb 2021)​

  • 🎉 New:
    • Option to disable and enable auto-capture on the fly
  • 🚀 Improvements:
    • Improved ImageFilter @types support for advanced typescript configurations

Version 2.0.0 (3 Feb 2021)​

  • 🎉 New:
    • Cropping UI – New components to implement UI for manual cropping of images
    • Image Filters – Scanned documents can now be optimized by applying image filters like binarization, grayscale, etc
    • PDF support – The ability to export scanned images as PDF
  • 🚀 Improvements:
    • Improved @types support for non-react projects
  • ⚠️ Breaking Changes:
    • Detection result images are now Uint8Array. Use scanbotSDK.toDataUrl to convert it to a displayable image
    • The component package is no longer available in the Bundle SDK. Replaced by @types
      • Configuration objects moved from model/ to model/configuration/
  • 🚙 Under the hood:
    • Updated OpenCV to version 4.5.0. OpenCV license has been changed from BSD to Apache 2
    • Added further 3rd-party libraries, see Libraries.txt

Version 1.0.2 (03 Nov 2020)​

  • 🐞 Bug fixes:
    • Module loading fix for Webpack 5

Version 1.0.1 (20 Oct 2020)​

  • 🐞 Bug fixes:
    • Typings entrypoint fix

Version 1.0.0 (25 September 2020)​

  • 🎉 Initial release:
    • Document Scanner with Auto-cropping
    • UI Components: User-guidance text, Detection polygon and Capture button

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