Document Web SDK
2.3.0
Search
K
Comment on page

Release Notes

Have a feature request? Contact us

2.3.0 - 2023/10/04

Breaking Changes

  • DocumentScanResult model has changed:
    • success property has been removed.
    • captureSuccess property has been added.
    • ocrSuccess property has been added.

Changes & additions

  • Improvements to the behavior of the SDK's Device Select component when handling permission requests. These enhancements ensure a smoother and more intuitive experience when allowing or denying permissions in various scenarios.

2.2.0 - 2023/10/02

Breaking Changes

  • Visual overhaul.
    • All components have been visually updated to have a sleeker style.
    • New font is being used - Roboto.
    • Icons have been reworked.
  • Discontinued support for the PNG (Portable Network Graphics) format. Consequently, the option to capture images in PNG format will be removed from the available capture options.

Changes & additions

  • Added configurable property to Result component for toggling title display on or off.

Bug fixes

  • The request for camera permission removed when in read-only mode.

1.3.2 - 2023/06/15

Changes & additions

  • Added capability to hide back button on document processing component.
  • Added capability to provide initial images to wizard component.
  • Expanded document processing component to allow both base64 and data URI formats for input images.
  • Improved error feedback for cases where camera permission has been blocked.

Bug fixes

  • Fixed green image snapshots on older devices.

1.3.1 - 2023/04/12

Changes & additions

  • Added control over image capture formats (currently supports JPEG and PNG, and defaults to JPEG. Previously images were only captured in PNG format).
  • Added functionality to convert uploaded images to JPEG format.
  • For multi-sided document file uploads, changed the upload screen to more clearly indicate when a file has already been selected by showing more distinct icons and accentuating the action instead of the side on buttons.

Bug fixes

  • Removed unused frontThreshold and backThreshold properties from document type model.
  • The request for camera permission in the design component for the web SDK plugins has been removed.

1.2.0 - 2023/02/22

Breaking Changes

  • Changed the Document Capture component to require a country code, document type ID and document type name. These determine whether or not both a front and a back image will need to be captured.
  • Changed the Prepare component to require a country code, document type ID and document type name. These determine whether or not both a front and a back image will need to be uploaded upon clicking the Upload button.
  • Changed the Result component to require a country code, document type ID and document type name. These determine OCR parameters.
  • The Document Crop component has been removed. Functionality was moved into a new component that consolidates image processing functionality, called the Document Processing component.
  • Changed the "document-crop" step type to "document-processing" instead.
  • Removed rotation functionality from the Result component. This was moved into the Document Processing component instead.
  • Removed the dataUri input parameter from the Result component. It has been replaced with the result parameter, which is a DocumentCaptureResult instead of a string.
  • Added country code, document type ID and document type name parameters to the capture document JavaScript API function.
  • Added country code, document type ID and document type name parameters to the upload document JavaScript API function.
  • Refactored the file and base64 parameters of the upload document JavaScript API function into frontFile and frontBase64.
  • Reworked the DocumentCaptureResult object type.
  • Removed the following properties from DocumentCaptureResult:
    • originalDocumentImage
    • croppedDocumentImage
    • processedDocumentImage
  • Added the following properties to DocumentCaptureResult:
    • correlationId (string)
    • originalDocumentImages (array of strings)
    • documentImages (array of strings)
    • ocrResults (array of DocumentOcrResult)
    • countryCode (string)
    • documentType (string)

Changes & additions

  • Added Country Select component.
  • Added "country-select" step type.
  • Added Document Select component.
  • Added "document-select" step type.
  • Added Document Processing component.
  • Added front and back file upload functionality.
  • Changed the "Retry" text of the back button on the Result component to "Back" instead.
  • Added the following parameters to the Result component:
    • api
    • options
    • readonlyMode
    • enableOcr
  • Added the following parameters to the Wizard component:
    • correlationId
    • defaultCountry
    • defaultDocumentType
    • selectedCountryCode
    • selectedDocumentTypeName
    • selectedDocumentTypeId
    • countries
    • documentTypes
    • enableOcr
  • Added setCorrelationId function to Wizard component.
  • Added the following parameters to the uploadDocument JavaScript API function:
    • backFile
    • backBase64
  • Added executeDocumentOcr function to the JavaScript API.
  • Added the following JavaScript API configuration options:
    • utilityApiKey
    • utilityAuthToken
    • utilityIntegrationMode
    • utilityAuthHttpMethod
    • utilityAuthEndpoint
    • utilityAuthHeadersCallback
    • utilityAuthBodyCallback
    • ocrHttpMethod
    • ocrEndpoint
    • ocrHeadersCallback
    • ocrBodyCallback
  • Added the following functions to the JavaScript API:
    • getUtilityToken
    • executeDocumentOcr

Bug fixes

  • Fixed an issue with loss of quality when cropping an image.

1.1.6 - 2022/10/28

  • Initial release