Release Notes
Have a feature request? Contact us
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 theresult
parameter, which is aDocumentCaptureResult
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
andbase64
parameters of the upload document JavaScript API function intofrontFile
andfrontBase64
.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
Last updated