Migration Guide - Special Versions

Welcome SDK Migration from V5.33.4-nu to 5.33.5-nu

1. Remove any workarounds for the SelfieScanResult data mapping issue (explained in CHANGELOG_SPECIAL document)

Welcome SDK Migration from V5.33.3-nu to 5.33.4-nu

1. If you use any of following optional dependencies, make sure to update to the latest versions

implementation 'com.incode.sdk:camera:1.2.1-nu'

implementation("com.incode.sdk:camera:1.2.1-nu")

2. Assisted Onboarding re-enabled for Face Capture/SelfieScan

Integrators that were unable to upgrade to 5.33.1-nu due to Assisted Onboard being disabled can now upgrade to this version. The module configurations previously affected will behave as they did prior to 5.33.1-nu.

3. Handling metadata from IdScanResult and SelfieScanResult

When invoking certain Incode APIs externally that use these results, providing the metadata is now mandatory in the following scenario:

• Deepsight is enabled.
• Capture-Only mode is being used.

The following Incode APIs require metadata in their request body in this scenario:

• omni/add/front-id/v2
• omni/add/front-second-id/v2
• omni/add/back-id/v2
• omni/add/back-second-id/v2
• omni/add/face/third-party

The metadata can be provided like so:

curl --request POST \
     --url https://demo-api.incodesmile.com/omni/add/face/third-party \
     --header 'X-Incode-Hardware-Id: [YOUR_TOKEN_HERE]' \
     --header 'accept: application/json' \
     --header 'api-version: 1.0' \
     --header 'content-type: application/json' \
     --header 'x-api-key: [YOUR_API_KEY_HERE]' \
     --data '
{
  "base64Image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB...",
  "metadata": "[ENCRYPTED_STRING_RETURNED_IN_SELFIE_SCAN_RESULT]",
  "faceCoordinates": {
    "leftEyeX": 1391.01,
    "leftEyeY": 1334.62,
    "rightEyeX": 918.383,
    "rightEyeY": 1359.96,
    "leftMouthX": 918.383,
    "leftMouthY": 1359.96,
    "rightMouthX": 918.383,
    "rightMouthY": 1359.96,
    "noseTipX": 918.383,
    "noseTipY": 1359.96,
    "x": 448,
    "y": 778,
    "width": 1366,
    "height": 1366
  }
}
'

4. Creating a DocumentScan module

Prior to the introduction of Builder classes for configuring modules in a FlowConfig, it was possible to create a DocumentScan module object directly. This approach is now deprecated. Instead, use DocumentScan.Builder() to configure the DocumentScan module in your FlowConfig.

Welcome SDK Migration from V5.26.4-compat to 5.33.1-nu

1. Compatibility Notes

If you're using any of these modules/module variants, this release will be incompatible with your integration as they've been removed to optimize SDK size for more common use cases:

• ID Capture V2 added in 5.30.0
• CombinedConsents added in 5.31.0
• DynamicForms added in 5.32.0

2. Handling Assisted Onboarding being disabled for Face Capture/SelfieScan

This release temporarily disables Assisted Onboarding for the SelfieScan module. Because of this, the following module configurations will show no effect:

• Assisted Onboarding configuration in the Face Capture module on the Incode Dashboard
• SelfieScan.Builder().setAssistedOnboardingEnabled()
• SelfieScan.Builder().setCameraFacing(CameraFacing.BACK)

As such, for integrators dependent on Assisted Onboarding functionality, do NOT upgrade to this SDK version. Assisted Onboarding for Face Capture/SelfieScan will be restored in a future release.

3. nu SDK versions

The nu versions of the Incode Welcome SDK follows the compat line of releases. As such, the path to migrate to 5.33.1-nu includes all the notes from 5.26.4-compat until now, with the following exceptions.

4. The camera dependency is now mandatory when using the SelfieScan module. Be sure to add it as such

implementation 'com.incode.sdk:camera:1.2.0-nu'

If this dependency is missing and you attempt to use the SelfieScan module, a MissingCameraDependencyException will be thrown when the module needs to use the camera.

5. Modified classes

On top of any SDK classes/methods removed as a result of item #1, this release has a few other breaking changes of note.

5.1 ScreenRecordModule

If you were using the ScreenRecordModule object in your integration, this class has been renamed to RecordModule to represent it supporting the new video recording feature in SelfieScan.

Replace

ScreenRecordModule

With

RecordModule

5.2 DeviceFingerprintKt

If you were accessing the JSON representation of the DeviceFingerprint via DeviceFingerprintKt.toJSON(), this method has been moved inside the DeviceFingerprint class proper.

Replace

DeviceFingerprintKt.toJSON()

With

DeviceFingerprint.toJSON()

Welcome SDK Migration from V5.0.0 to 5.26.3-compat

This compat release was introduced for projects that couldn't upgrade from 4.X.X to 5.0.0 due to the RxJava version used internally. As such, the path to migrate to 5.26.3-compat includes all the notes from 5.0.0 through 5.26.2-compat, with the following exceptions.

If you use any of the following optional dependencies, make sure to update to the latest versions

implementation 'com.incode.sdk:kiosk-login:1.3.4.1-compat'
implementation 'com.incode.sdk:nfc:1.3.4.1-compat'
implementation 'com.incode.sdk:qr-face-login:1.2.2.1-compat'

Welcome SDK Migration from V5.21.0 to 5.26.2-compat

The compat versions of Incode Welcome SDK dependencies were introduced for projects that couldn't upgrade from 5.21.0 to 5.22.0 due to the Kotlin version upgrade from 1.6.21 to 1.8.10. As such, the path to migrate to 5.26.2-compat includes all the notes from 5.22.0 until now, with the following exceptions.

1. Update core-light dependency to the latest version

implementation 'com.incode.sdk:core-light:2.6.3'

2. If you use any of the following optional dependencies, make sure to update to the latest versions

implementation 'com.incode.sdk:kiosk-login:1.3.4-compat'
implementation 'com.incode.sdk:nfc:1.3.4-compat'
implementation 'com.incode.sdk:qr-face-login:1.2.2-compat'
implementation 'com.incode.sdk:video-streaming:1.5.5'

Note: If Android Studio shows a warning about nfc 1.3.4 or qr-face-login 1.2.2 being available, these can be safely ignored.