2.3.0

Release Notes

Have a feature request? Contact us

2.3.0 - 2024/02/19

Breaking Changes

  • Removed Onboarding application API key property and replaced it with two new properties. The following properties must be configured instead of the API key:

    • LicenseKey: This replaces the previous API key property and acts as the tenant's license key.

    • ClientID: This property needs to be configured for each tenant and helps with auditing.

2.2.1 - 2023/11/22

Changes & additions

  • Added gzipped files for sybrin.onboarding.js and sybrin.common.js.

  • Added built-in, internal handlers for gzipped content.

2.2.0 - 2023/11/05

Changes & additions

  • Added the following attributes to the data extraction after acceptance integration point:

    • The fraud detection results extracted from document fraud detection if enabled

  • Added the following attributes to the finalize integration point:

    • The fraud detection results extracted from document fraud detection if enabled

2.1.0 - 2023/10/04

Breaking Changes

  • Added support for multi-tenancy, which has changed how configuration is structured and applied. Please see the Multi Tenancy section for details on how do upgrade. This update brings:

    • Capability to host multiple configuration sets under a single deployment instance.

    • Capability to serve the onboarding UI through the API host.

    • Capability to specify authorisation settings per tenant.

    • Capability to enable a global configuration configuration and translations files for tenants.

  • Visual overhaul.

    • All components have been visually updated to have a slicker style.

    • New font is being used - Roboto.

    • Icons have been reworked.

  • Removed the "Any other country" option from the country select component.

    • Removed corresponding translation (sy-i-translation-27)

  • Refactored OTP sending configuration to more generic SMS sending configuration. Affected properties:

    • OtpRemoteEndpoint changed to SmsEndpoint.

    • OtpRemoteUsername changed to SmsUsername.

    • OtpRemotePassword changed to SmsPassword.

    • OtpRemoteSeparator changed to SmsSeparator.

Changes & additions

  • Added all countries to country select component.

  • Added corresponding translations for all countries.

    • sy-i-translation-90 to sy-i-translation-329

  • Added a search bar to the country select component, with corresponding translation keys for search features:

    • sy-i-translation-330

    • sy-i-translation-331

  • Improved error feedback for cases where camera permission has been blocked.

  • Added light threshold functionality that allows for dynamic adjustment of overexposure and underexposure thresholds to prevent the user from getting completely stuck due to poor lighting conditions.

  • Added configurable capability to send SMS with link to execute mobile capture on steps where mobile capture can be used. The EnableMobileCaptureSms configuration property may be used to toggle this functionality.

  • Changed default KYC title translations to be unique and more specific to each step's function.

  • Added configuration options to control the initial lighting values and threshold for both under- and overexposure:

    • BiometricsUnderexposedValue

    • BiometricsOverexposedValue

    • BiometricsUnderexposedThreshold

    • BiometricsOverexposedThreshold

    • IdentityUnderexposedValue

    • IdentityOverexposedValue

    • IdentityUnderexposedThreshold

    • IdentityOverexposedThreshold

  • Added automatic browser locale detection features.

  • Added capability to track originating IP information.

  • Added dynamic capability for device screening using Fido API.

  • Added dynamic capability for phone number screening using Pipl API.

  • Added dynamic capability for reverse geolocation lookup using Google map API.

  • Added dynamic capability for facial feature extraction.

  • Added capability to track originating IP information.

  • Added translation for button text in cases where OTP won't be sent: sy-o-translation-102

  • Added the following document types:

    • Tanzania Passport

    • Tanzania ID Card

    • Tanzania Driver's License

    • Tanzania Birth Certificate

    • Tanzania Voter Card

  • Added the following translations for new document types:

    • sy-i-translation-332: Birth Certificate

    • sy-i-translation-333: Voter Card

  • The request for location permission has been adjusted to prompt the user upon agreeing to the terns and pressing Start.

  • Added a flag to enable or disable file uploads for Identity

  • Added configuration that takes a selfie without running liveness on the image/video.

  • Added the following attributes to the terms integration point:

    • The residential address, residential country and residential country code information extracted from reverse geolocation lookup if enabled

    • The device information extracted from device screening if enabled.

  • Added the following attributes to the verify OTP integration point:

    • The phone number screening information extracted from phone screening if enabled.

  • Added the following attributes to the accept data extraction result integration point:

    • The device information extracted from device screening during document extraction if enabled.

  • Added the following attributes to the accept passive liveness result integration point:

    • The device information extracted from device screening during passive liveness extraction if enabled.

  • Added the following attributes to the accept passive liveness result integration point:

    • The face vectors extracted from facial vector extraction during passive liveness if enabled.

  • Added the following attributes to the finalize integration point:

    • The residential address, residential country and residential country code information extracted from reverse geolocation lookup if enabled.

    • The device information extracted from device screening during accepting terms, document extraction and passive liveness if enabled.

    • The phone number screening information extracted from phone screening if enabled

    • The face vectors extracted from facial vector extraction during passive liveness if enabled

  • Added loader with progress for downloading of js files.

  • 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.

  • Added translation for when camera permission has been denied:

    • sy-b-translation-47

    • sy-i-translation-336

Bug fixes

  • Fixed emulation error appearing on older devices when initializing camera.

  • Fixed document type selection breaking when selecting a generic document scan country and overrides have been provided.

  • Fixed video recording initialization failing on Firefox when ideal media constraints cannot be met.

  • Fixed OTP always being sent, even when the verification screen isn't configured.

  • Resolved language change bug to preserve component integrity. Now, when users switch languages, the component remains intact, providing a seamless experience without unnecessary disruptions.

  • Improved language selection functionality to prevent component destruction. Now, when users change the language, the component remains unaffected, ensuring a smooth and uninterrupted experience

  • Fixed mobile capture when user hasn't set a language preference.

  • Fixed broken translation on search input and no country found for document select component.

1.6.0 - 2023/05/12

Changes & additions

  • Added USA California Driver's License document type.

  • Added word confidence rating functionality and changed the document scan result component to handle it accordingly.

  • Added the following backend configuration settings to control word confidence behavior:

    • DataExtractionWordConfidenceThreshold

    • DataExtractionIsLowConfidenceEditable

    • DataExtractionIsLowConfidenceConfirmable

    • DataExtractionIsLowConfidenceBlocking

    • DataExtractionMobileIsLowConfidenceEditable

    • DataExtractionMobileIsLowConfidenceConfirmable

    • DataExtractionMobileIsLowConfidenceBlocking

  • Changed all sample document images to JPEG format.

  • All images are now captured in JPEG format.

  • Added control over target image formats (currently supports JPEG and Original, and defaults to Original). The TargetImageType configuration setting controls the targe image format. Images will be converted to the configured target format (after running liveness or OCR on the original) if they are not in the configured format already.

  • 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 more capture modes to allow for more granular control over behavior and button positioning.

  • Limited frame rate for video recordings to 15 fps.

  • Added alternative, configurable behavior for duplicate correlation IDs. The CorrelationDuplicateMode configuration setting controls this behavior. The options are to handle with exception (default) or to handle by flagging the case.

  • Added BiometricsVideoDuration configuration setting to control the duration of liveness videos.

  • Added LivenessMediaType to set the media that should be used for liveness (image or video).

  • Added hash security checks for liveness video.

  • Changed security checks to be more centralized and eliminate false negatives.

  • Implemented correlation ID verification for JSON and form data modes.

  • Changed biometrics portion of onboarding to automatically handle the best liveness version based on media type.

  • The following translations were modified to place the emphasis on the action rather than the side:

    • sy-i-translation-77

    • sy-i-translation-78

    • sy-i-translation-79

    • sy-i-translation-80

  • Along with the above changes, the icons for "Upload" and "Change" have been updated to more clearly indicate which action will take place with a click of the corresponding button.

  • Added/changes the following translation keys:

    • sy-i-translation-85: Start Capture

    • 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.

  • Changed location permission request to only occur after user input.

Bug fixes

  • Fixed the document scan result component incorrectly displaying the internally used "BackParsedSuccessfully" property.

  • Fixed filter case sensitivity issue on country select component.

  • Fixed mobile capture URLs to generate with a trailing slash.

  • Fixed SDK requesting an invalid sample document image when scanning Kenya military ID card.

  • Fixed spinners on iOS.

  • Fixed some conflicting translation keys.

  • Fixed video recordings not working since iOS 16.

  • Fixed issue with an error being thrown if cancelling the operation while recording a video.

  • Fixed identity hashing failing on military ID card.

  • Fixed broken country code parsing when providing an Alpha-2 or numeric code.

1.4.17 - 2022/12/15

Bug fixes

  • Fixed an invalid translation (sy-o-translation-16).

  • Fixed old log files never being deleted.

  • Fixed broken OTP functionality.

1.4.16 - 2022/11/01

Breaking changes

  • For all steps, changed guideline display behavior. Guidelines are now shown in a block instead of requiring a button press to view them in a new window.

  • On Identity, changed prompt behavior and translations to more clearly indicate an instruction prompt along with which side is being captured.

Changes & additions

  • Improved many prompts for more clarity during multiple steps of the onboarding process.

  • On liveness selfie, changed the Result component to show the selfie image even if the liveness analysis returned false.

  • 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.

  • Instead of always throwing an exception when no video input devices have been detected, onboarding now only throws an exception if no other capture method is available either.

  • Added camera direction priority configuration.

  • Changed the process which gains control of the camera to retry a few times after an initial failure to do so.

  • Improvements to default threshold values.

  • Added more control over threshold configuration.

  • Improvements to face detection.

  • Changed Device Select component listing to attempt using more user-friendly labels on mobile devices that provide bad naming conventions for their cameras.

  • On Identity, changed the UI presented during multi-sided document uploads to allow for easier file selection.

  • Added cropped image results.

  • Changed the Result component to first check for newly added cropped images, and only show the original images if no cropped images are present.

  • Improvements to Kenya ID card auto detection.

  • Added manual capture capabilities to Identity.

  • 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.

  • On Identity, 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.

  • Added PDF conversion capabilities.

  • Added capability to skip liveness (with flag) after failing for a configurable number of times.

  • Added capability to configure inclusion of raw and cropped images during synchronization.

  • Added capability to configure the return of cropped images from the API.

  • Added capability to configure privacy policy and terms presentation modes, with an additional mode of opening a configurable URL in a new window.

  • Added capability to configure camera direction priorities.

  • Added capability to configure max upload file size for identity.

  • Added capability to configure data extraction headers.

  • Added capability to configure document type overrides.

  • Removed the following unused translations:

    • sy-b-translation-3

    • sy-b-translation-4

    • sy-b-translation-7

    • sy-b-translation-8

    • sy-b-translation-11

    • sy-b-translation-14

    • sy-b-translation-19

    • sy-i-translation-33

    • sy-i-translation-34

    • sy-i-translation-55

    • sy-o-translation-23

  • Changed the following translations:

    • sy-b-translation-6

    • sy-b-translation-9

    • sy-b-translation-25

    • sy-i-translation-27

    • sy-i-translation-42 to sy-i-translation-45

    • sy-i-translation-54

    • sy-i-translation-56

    • sy-o-translation-54

  • Added the following translations:

    • sy-b-translation-45

    • sy-i-translation-71 to sy-i-translation-84

  • Added the following API configuration options:

    • ConversionApiKey

    • ConversionAuthorizationEndpoint

    • ExtractImageFromPdfEndpoint

    • MediaStreamRetryCount

    • MediaStreamRetryDelay

    • PassiveLivenessEnableSkipFailureCount

    • IntegrationIncludeDocRaw

    • IntegrationIncludeDocCropped

    • DataExtractionReturnCroppedImages

    • FaceDetectionScale

    • EyeDetectionThreshold

    • EyeDetectionScale

    • BiometricsCameraDirectionPriority

    • IdentityCameraDirectionPriority

    • IdentityCaptureMode

    • IdentityMaxUploadFileSize

    • PrivacyPolicyPresentationMode

    • TermsPresentationmode

    • PrivacyPolicyUrl

    • TermsUrl

    • DocumentTypeOverrides

    • LivenessProviderType

    • LivenessHeaders

    • DataExtractionHeaders

  • Changed the UI loader/spinner.

  • General styling fixes.

Bug fixes

  • Fixed a timing issue that could sometimes cause buttons on the prepare component to be created in an unintended order.

  • Removed the need for microphone permissions if no audio is being recorded.

  • Fixed country code filters not working on the Document Select component.

  • 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.

1.3.0 - 2022/07/27

Breaking Changes

  • Added Biometrics hash check to Onboarding backend API as an additional layer of security.

Changes & additions

  • Integration with Biometrics 2.3.2

  • Integration with Identity 2.3.0

  • Added FinalizeImmediateCompletion configuration option to backend API appsettings.

  • Updated mobile capture functionality to no longer require additional URL query parameters.

  • Added the capability to pass a country in the form of a URL query parameter.

  • Added window events for step changes.

Bug Fixes

  • Fixed issue with the completion window event only executing if an onComplete callback is configured.

  • Fixed missing padding between flag and country code on the country dropdown of the phone input component.

1.2.0 - 2022/06/22

Breaking Changes

  • Removed unnecessary wrapping property (RequestData) from Nest integration requests

Changes & additions

  • Added custom CSS file to simplify custom styling

  • Added mobile capture functionality to liveness step

  • Added editing capabilities to data extraction result step

  • Added configuration option to toggle language selector

  • Added configuration option to toggle banner visibility

  • Added configuration option to include or exclude biometrics video

  • Added remote correlation ID verification capabilities

  • Adjustments so that the terms step is no longer required to be first

  • Added a window event to the final button click in order to signal completion to any containers

  • Added loader to initial screen

  • Added generic SDK classes to HTML elements to simplify styling over multiple SDKs

1.1.1 - 2022/06/08

Changes & additions

  • Changed the language dropdown to expand on click instead of hover.

  • Changed liveness to allow multiple faces but only take the nearest face into account.

  • Added flip animation to document capture when rear photo is required.

Bug Fixes

  • Fixed an issue specific to certain mobile browsers where the language selection dropdown would not close until the user interacted with another button on the screen.

  • Fixed a bug where no error message would be displayed when the UI could not communicate with the backend. API

  • Fixed an issue with content displayed in a new window not being viewable in Safari on mobile devices. This includes privacy policies, terms & conditions and guidelines.

  • Fixed issues with styling relating to certain components on smaller screens where some components would not be sized correctly.

1.1.0 - 2022/06/02

Breaking Changes

  • Moved terms & conditions and privacy policy files to the backend API

Changes & additions

  • Added localization

1.0.0 - 2022/05/17

  • Initial release

Last updated