Release Notes
Have a feature request? Contact us
2.6.0 - 2023/05/02
Breaking changes
Changed the onContinue event of the Result and Wizard components to emit the DocumentScanResult instance with modifications applied if applicable.
Changes & additions
Added USA California Driver's License document type.
Added word confidence rating functionality and changed the Result component to handle it accordingly.
Added the following initialization properties to the Result and Wizard components to handle word confidence ratings:
wordConfidenceThreshold
isLowConfidenceEditable
isLowConfidenceConfirmable
isLowConfidenceBlocking
Added the following properties to DocumentScanResult:
wordConfidenceResults
originalValues
Added the following translation keys:
sy-i-translation-86: United States of America
sy-i-translation-87: California Driver's License
sy-i-translation-88: Some fields were captured with a low confidence rating.
sy-i-translation-89: Some fields were captured with a low confidence rating. Please review the highlighted values.
Bug fixes
Fixed the result component incorrectly displaying the internally used "BackParsedSuccessfully" property.
2.5.1 - 2023/04/14
Changes & additions
Changed all sample document images to JPEG format.
Bug fixes
Fixed SDK requesting an invalid sample document image when scanning Kenya military ID card.
2.5.0 - 2023/04/12
Breaking changes
Changed the way that capture modes are handled. Default behavior is preserved, so applications that do not make use of alternative capture modes will be unaffected by this change.
Added more capture modes to allow for more granular control over behavior and button positioning. See JavaScript API functionality section or relevant component sections for more information on the extra modes.
Removed the
captureMode
JavaScript API configuration option. This is now handled on function invocation and component levels instead. ThecameraButtonDisplayIcon
andcameraButtonDisplayText
configuration options are still in use, but they may be moved in a future update.Added a
captureMode
parameter to theopenScanDocument
JavaScript API function.Added a
captureMode
constructor parameter to the Document Scan and Wizard components.
In the JavaScript API
uploadDocument
function, refactored thefile
andbase64
parameters tofrontFile
andfrontBase64
.
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).
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.
Added a configuration option to disable file upload functionality.
The following translations were modified:
sy-i-translation-77 (Prepare component)
sy-i-translation-78 (Prepare component)
sy-i-translation-79 (Prepare component)
sy-i-translation-80 (Prepare component)
The following translations were added:
sy-i-translation-85 (Document Scan component)
Bug fixes
Fixed filter case sensitivity issue on country select component.
Fixed mobile capture URLs to generate with a trailing slash.
Fixed a bug where the JavaScript API
uploadDocument
function did not include the option to provide an external back file or base 64 string.Removed unused
captureMode
configuration option. This is provided to components or capture function calls.
2.4.2 - 2022/12/15
Changes & additions
Added Kenya military ID card support.
Added manual capture capabilities.
Bug fixes
Fixed spinners on iOS.
2.4.0 - 2022/10/26
Breaking changes
Changed the authorizationEndpoint configuration option to authEndpoint.
Changed guidelines on the Prepare component to show on the initial screen instead of requiring a button press to view in a new window.
Removed the setFlowDirection function and the flowDirection initialization property from the Prepare component as it is no longer used since changing the way that guidelines are presented.
Removed the setFlowDirection function and the flowDirection initialization property from the Wizard component as it is no longer used since changing the way that guidelines are presented.
Removed the exported FlowDirection enum.
Removed the onViewGuidelines event from the Prepare component as there is no longer a button to view guidelines.
Removed the onViewGuidelines event from the Wizard component as there is no longer a button to view guidelines.
Changed prompt behavior and translations to more clearly indicate an instruction prompt along with which side is being captured.
Changes & additions
Changed the UI presented during multi-sided document uploads to allow for easier file selection.
Added croppedFrontImage and croppedBackImage to DocumentScanResult.
Changed the Result component to first check for newly added cropped images, and only show the original images if no cropped images are present.
Added a configurable read-only mode to the Prepare component.
Changed the Device Select component to display differing device icons based on detected type. It can now display mobile, tablet, webcam and a generic camera for other types.
Updated Kenya ID card samples to more suitable images.
Added functionality to visually pre-select a default country on the Country Select component based on a provided parameter.
Added functionality to visually pre-select a default document type on the Document Select component based on a provided parameter.
Instead of always throwing an exception when no video input devices have been detected, the SDK now only throws an exception if no other capture method is available either.
Added parameter on Wizard to set camera direction priority.
Added parameter on Wizard to set default country.
Added parameter on Wizard to set default document type.
Added parameter to the uploadDocument function of the JavaScript API to be able to provide an upload modal container.
Changed Device Select component listing to attempt using more user-friendly labels on mobile devices that provide bad naming conventions for their cameras.
Changed the default translation text for sy-i-translation-27 from "Other" to "Any other country".
Changed the default translation text for sy-i-translation-42 from "Please hold the document up to the camera" to "Capturing FRONT".
Changed the default translation text for sy-i-translation-43 from "Please flip the document over for rear photo" to "Capturing BACK".
Changed the default translation text for sy-i-translation-44 from "Lighting conditions too dark" to "Lighting too dark".
Changed the default translation text for sy-i-translation-45 from "Lighting conditions too bright" to "Lighting too bright".
Added translation sy-i-translation-71 to use as new capture prompt.
Added translation sy-i-translation-72 to use as prompt to indicate that the user must flip the document over.
Added translations sy-i-translation-73 to sy-i-translation-80 for use on new multi-sided document prompt.
The SDK will now retry accessing the camera for a configurable number of times if it fails to gain access initially.
Added mediaStreamRetryCount configuration option.
Added mediaStreamRetryDelay configuration option.
Added thresholdAdjustAmount configuration option.
Added thresholdAdjustMaximum configuration option.
Changed blurThreshold default value from 6.5 to 6.7.
Added blurThresholdMobileModifier configuration option.
Added maxUploadFileSize configuration option.
Added showDebugOverlay configuration option.
Changed SDK to wait for 3 seconds while running the flip animation before running image analysis again and trying to take the rear photo.
Added UseV2 (value is "true") to default headers.
Added UseSegmentationBeforeOCR (value is "true") to default headers.
Added ValidateBackFront (value is "true") to default headers.
Removed the need for the audio permission.
Changed the UI loader/spinner.
General styling fixes.
Bug fixes
Fixed country code filters not working on the Document Select component.
Fixed a timing issue that could sometimes cause buttons on the prepare component to be created in an unintended order.
Added "WordConfidenceResults" and "IsBackFrontValid" to list of fields to filter out if present on the result.
Fixed a bug where the mobile prompt appeared on file upload failure.
Fixed the onBeforeUpload event not firing on the Wizard component.
Fixed the onScanError event not firing on the Wizard component.
Fixed certain permission issues causing the SDK to fail to retrieve or initialize video input devices on Safari and Firefox.
2.3.0 - 2022/07/27
Breaking changes
Removed the
useIntegrationApi
configuration option and replaced it with theintegrationMode
configuration option.Renamed the
authorizationEndpoint
property toauthEndpoint
.Removed the
integrationApiBaseUrl
configuration option. TheauthEndpoint
anddataExtractionEndpoint
properties must now be used.Removed the
extractionFrontParamName
configuration option. This value can now be modified using the body callback function (dataExtractionBodyCallback
).Removed the
extractionBackParamName
configuration option. This value can now be modified using the body callback function (dataExtractionBodyCallback
).Removed the
assetHeaders
configuration option. Asset headers can now be modified using the asset headers callback function (assetHeadersCallback
).Removed the
authHeaders
configuration option. Authorization headers can now be modified using the authentication headers callback function (authHeadersCallback
).Removed the
dataExtractionHeaders
configuration option. Data extraction headers can now be modified using the data extraction headers callback function (dataExtractionHeadersCallback
).Removed the
dataExtractionBodyValues
configuration option. Data extraction body can now be modified using the data extraction body callback function (dataExtractionBodyCallback
).
Changes & additions
Added optional middleware service that may be used to obfuscate the identity API key, along with corresponding configuration properties. Please see the middleware service documentation for details on how to implement and use it. Additionally, the SDK can now be configured to integrate with custom services. Relevant configuration properties are:
integrationMode
authHttpMethod
authHeadersCallback
authBodyCallback
dataExtractionHttpMethod
dataExtractionHeadersCallback
dataExtractionBodyCallback
encryptionKey
Added parameters to the Prepare component's mobile capture initialization function to allow more control over the generated URL.
Added encryption features.
Bug fixes
Fixed an issue with the SDK sometimes defaulting to emulated cameras when present.
Fixed issue where the card elements within components were sometimes not sized correctly.
Fixed issue where text sometimes was not center aligned where it needed to be.
Fixed a bug where the device select component would always appear when set as the first step (regardless of whether or not only a singular viable video input device is present).
2.2.0 - 2022/06/21
Changes & additions
Added generic SDK classes to HTML elements to simplify styling over multiple SDKs.
Added functionality to be able to edit extracted document data to Result component.
2.1.1 - 2022/06/08
Bug fixes
Fixed information blocks on the Prepare component having inconsistent sizes with smaller screens.
Fixed an issue with button overflow on the Prepare component when used with smaller screens.
Fixed an issue with guidelines not being viewable in Safari on mobile devices.
Fixed an issue with using an incorrect camera when pressing Retake on certain devices.
Fixed an issue with the video feed being incorrectly mirrored on certain devices.
Changes & additions
Added a flip animation to the capture step if a rear photo is required.
2.1.0 - 2022/06/03
Breaking Changes
Removed all localization properties available as JavaScript API configuration options. These values can now be modified by making use of the new localization framework. Removed properties are:
messagePreparing
messagePrepareFront
messagePrepareBack
messageLightingDark
messageLightingBright
messageBlurry
messageIncompatible
messageIncompatibleSafari
Name overrides have been removed from country configuration in favor of new localization functionality.
Title and subtitle overrides have been removed from document type configuration in favor of new localization functionality.
Changes & additions
Comprehensive localization rework (See localization section for details)
All components now accept a
translations
parameterAll templates updated to have translatable elements marked with the class
sy-i-translation-#
(where # is its unique number)
Bug fixes
Fixed a bug where an extra blue border displayed on the Document Scan component while capture was in progress.
Fixed an issue with poor framerates on certain higher quality webcams.
2.0.0 - 2022/05/17
Breaking Changes
Extensive UI overhaul of all components and functionality.
Country Select Component:
Removed all localization options for a future localization overhaul.
Visual UI overhaul.
Document Select Component:
Removed all localization options for a future localization overhaul.
Visual UI overhaul.
Document Scan Component:
Removed all localization options for a future localization overhaul.
Visual UI overhaul.
Removed useModal parameter from document scan component (As part of the UI overhaul, there is no longer a modal option).
Result Component:
Removed all localization options for a future localization overhaul.
Visual UI overhaul.
Added isSingleStep configuration parameter to toggle "Next" button text to "Complete Step" when needed,
Added promptMobileOnRetry configuration parameter to enable prompting for mobile usage when the user clicks "Retry".
Wizard Component
Removed all localization options for a future localization overhaul.
Visual UI overhaul.
Added events to bubble up from the newly added prepare component
onViewPrivacyPolicy
onViewGuidelines
onMobileCaptureStart
onMobileCaptureCancel
Added initialization configuration parameters
enableMobileCapture
isSingleStep
forceMobileCapture
Changes & additions
Added prepare component.
Added device select component.
Added "Other" option to country list. This option supports generic data extraction of passports.
Added better alphabetic sorting to selection components.
JavaScript API configuration options:
Adjusted thresholdAdjustInterval property default value from 10000 to 4000 in order to account for new dimensions.
Added optional parameters to the getVideoInputDevices function on the API to specify whether or not the UI should be blocked while loading input devices, along with the capability to specify an element to block.
1.5.1 - 2022/02/24
Changes & additions
Added emulation checks.
Added a property on data extraction results to indicate which camera was used.
Bug fixes
Fixed a bug where certain error responses were handled like a success.
Fixed the case of the seaman's book document type's title. (Was previously Seaman's book and is now Seaman's Book)
1.5.0 - 2022/01/13
Changes & additions
The SDK is now provides two different options for referencing the main library:
A singular file that contains all functionality (sybrin.identity.all.js). This matches implementations from previous versions.
A split approach where Identity specific functionality is provided in one file (sybrin.identity.js) and common functionality shared by other Sybrin web SDKs is provided in another (sybrin.common.js). This approach is new and is intended to reduce the overall page size in solutions that make use of multiple Sybrin web SDKs by including common functionality only once.
1.4.0 - 2021/12/02
Changes & additions
Added device selection functionality.
1.3.3 - 2021/11/25
Changes & additions
Added numeric country code to country selection output. The
onCountrySelected
events of the country component and the wizard component have been changed to pass down the Alpha-3 country code, the Alpha-2 country code and the numeric country code as parameters in that order.
Bug fixes
Fixed wizard component
onCountrySelected
event only passing the Alpha-3 country code.
1.3.2 - 2021/11/19
Changes & additions
Changed the Document Scan Component's internal error handling to always trigger the
onScanResult
event, even after anonScanError
event occurred. While not a breaking change, this could have an external effect on flows where the web SDK has been implemented, specifically where the Document Scan Component'sonScanResult
andonScanError
events are used to manage flow steps.Added configuration to integrate with the companion Sybrin Onboarding API as a middleware proxy when bundled with the web SDK. These configuration options include
useIntegrationApi
,integrationApiBaseUrl
andauthToken
Added a
dataExtractionBodyValues
configuration option to pass down additional form body values during the data extraction API call, similar to thedataExtractionHeaders
configuration option.
1.3.1 - 2021/11/08
Changes & additions
Changed the country select component's
onCountrySelected
event to additionally pass the Alpha-2 standard country code as a second parameter.Added functionality to retrieve a list of supported country codes in both Alpha-3 and Alpha-2 standards. These are
getCountryAlpha3Codes
andgetCountryAlpha2Codes
.Added a
useCutout
configuration option with a default value oftrue
to toggle whether or not the document cutout should be shown over the video feed.
Bug fixes
Fixed some internal memory cleanup errors.
1.3.0 - 2021/10/21
Breaking changes
Renamed the
documentDetectionInterval
configuration option tovideoInterval
.Removed the
messageCapturingFront
andmessageCapturingBack
configuration options as they are no longer used.
Changes & additions
Added compatibility check features, along with
messageIncompatible
andmessageIncompatibleSafari
configuration options.Added a
tokenTimeout
configuration option that determines how long a token is valid and will be reused for before a new authentication call is made.Increased the
takePictureDelay
configuration option default value from 2000 to 5000.Changed the
messagePrepareBack
configuration option default value from "Please flip the document over" to "Please flip the document over for rear photo"
1.2.3 - 2021/10/14
Changes & additions
Slightly decreased the default front capturing threshold for Philippines drivers licenses.
Added debug functionality features, along with
recordDebugInfo
anddebugInfoEndpoint
configuration options.
Bug fixes
Fixed a bug where the modal didn't take up the whole screen when the component was hosted in certain containers.
Fixed a bug where components didn't share the same API instance when the wizard was initialized without passing one down.
1.2.2 - 2021/09/28
Changes & additions
Added an
instructionTextPosition
API configuration option that allows configuration of where the instruction text is located while the video feed is being processed. The options are "top", "bottom", or "topandbottom".Added a strongly typed
ClientInfo
class that is now returned by thegetClientInfo
call.Added more detailed information to be returned from
getClientInfo
.Added custom header configuration for authentication (
authHeaders
) and data extraction (dataExtractionHeaders
) API calls that can be set using the API configuration options.Changed the default blur text to "Image too blurry" (see
messageBlurry
under the API configuration options).
Bug fixes
Fixed a memory leak that occurred while the video feed was being processed.
Fixed a bug where resizing while the video feed is already open would not properly adjust processing areas.
Fixed a bug on iPad where the video feed was blank.
Fixed a bug on iPad where the video cutout would sometimes not re-render correctly on resize or orientation change.
Fixed some exceptions not being handled properly.
Fixed styling being applied to some elements too strictly (would have needed to use !important to style said elements before).
1.2.1 - 2021/09/14
Bug fixes
Fixed Correlation ID not being passed down correctly
1.2.0 - 2021/09/10
Breaking changes
Changed all
onBeforeWebcam
events toonBeforeScan
.
Changes & additions
Inverted the video feed when a frontal camera is being used in order to improve the alignment process.
Added typings for Typescript. These can be found under the
src
folder.The library no longer requires
sybrin.identity.css
to be included and referenced separately for default component styling to take effect. You may still apply overrides using your own stylesheet by referencing a custom .css file after the library.Added a read-only mode to the wizard component which disables all events.
Added an option to set request headers for asset retrieval requests.
Added a
flattenAssets
option which results in the library looking for samples in a flat structure instead of nested within folders for each country. To use this, asset file names must manually be moved one level up and prefixed with the country code and a dash. For instance: gha/passport.png changes to gha-passport.png.
Bug fixes
Fixed a bug where the wizard fired the
onBeforeStepChanged
andonAfterStepChanged
events on initialization.Fixed a bug where an error occurred if the SDK was included multiple times.
Fixed issue where
DocumentScanResult
was not being exported from the library.
1.1.0 - 2021/08/19
Changes & additions
Added blur detection as well as a configuration option to set the blur threshold.
Added lighting detection as well as configuration options to set values and thresholds to use when checking for image overexposure or underexposure.
Added version info retrieval functionality.
Added client info retrieval functionality.
Added instructions page to the document scan component in order to pre-emptively give the user some guidelines on how to ensure a viable document image.
Added localization options to document scan component initialization for changing guideline instruction texts.
Added
useModal
configuration option to the document scan component which enables launching the video feed in a modal.Updated wizard component with matching properties for instruction localization and modal usage to pass down to the document scan component upon initialization.
Updated the demo application to make use of the newly added client info retrieval functionality and initialize the wizard component to use the newly added modal functionality only when the client environment is not mobile.
Bug fixes
Fixed issue with video stream remaining open when using the wizard's back button after the feed had started.
Ensured that the video stream always closes when the document scan component is destroyed.
Last updated