Skip to content

Upgrade Guide

Upgrade Guide

Before upgrading, please check the notes below for all versions between your current build and the latest version. New versions of the SDK may require changes to avoid breaking APIs and current configuration.

Upgrade Guide iOS

2.0.0

SDK rename (DigidentityIDK → DigidentitySDK)

In iOS SDK 2.0.0, the CocoaPod has been renamed from DigidentityIDK to DigidentitySDK. All references to DigidentityIDK in your project must be updated to DigidentitySDK:

  • In your Podfile, replace pod 'DigidentityIDK' with pod 'DigidentitySDK'
  • Replace all import DigidentityIDK statements with import DigidentitySDK
  • DigidentityIDK → DigidentitySDK
  • IDKDelegate → SDKDelegate
  • IDKHandleURLResult → SDKHandleURLResult
  • DigidentityIDKError → DigidentitySDKError
  • Replace any other remaining occurrences of IDK with SDK

New account switcher theme colors

In iOS SDK 2.0.0, the following colors were introduced:

  • accountSwitcherBackgroundColor
  • accountSwitcherIconFirstCircleColor
  • accountSwitcherIconSecondCircleColor
  • accountSwitcherIconThirdCircleColor

Please make sure to define these colors. An example of the customizable style file can be found here.

1.51.0

New customizable theme login screen Card background style

In iOS IDK 1.51.0, the following color was introduced:

  • loginCardItemBackgroundColor

Please make sure to define this color. An example of the customizable style file can be found here.

1.42.0

Account recovery

In iOS IDK 1.42.0, the account recovery feature has been introduced.

When a user attempts to add an existing account using their email address, the IDK will initiate the account recovery flow. This process always begins with the user entering a recovery code received by email. Depending on the circumstances, additional verification steps may be required, such as a selfie check or a combination of selfie and evidence upload.

1.39.0

In iOS IDK 1.39.0, explicit consent for photo processing has been introduced.

Please be aware that once this consent is enabled on the platform (November 24, 2025), all versions prior to 1.39.0 will cease to function. No code changes are required on your side; however, you must update to version 1.39.0 or later to ensure continued compatibility.

If you require additional time to adopt the latest IDK version, please contact Support to request that photo processing consent be temporarily disabled for your product.

1.35.0

New customizable theme text style

In iOS IDK 1.35.0, the following text style was added:

  • textNavigationActionColor

Add it to your theme configuration file to customize it. By default it will have the same values as found in the example configuration.

1.21.0

New dependencies

There were new dependencies added to the IDK which require additional setup with Cocoapods. Please update the "post_install" script in Podfile according to updated instructions.

1.18.0

New customizable theme text style

In iOS IDK 1.18.0, the following text style was added:

  • textMSemiBold

Add it to your theme configuration file to customize it. By default it will have the same values as found in the example configuration.

1.10.0

New customizable theme text style

In iOS IDK 1.10.0, the following text style was added:

  • textLBold

Add it to your theme configuration file to customize it. By default it will have the same values as found in the example configuration.

Upgrade Guide Android

2.0.0

Dependency migration (IDK + SDK → single SDK artifact)

In Android SDK 2.0.0, the previously separate com.digidentity:idk and com.digidentity:sdk libraries have been merged into a single artifact. Replace both dependencies with the new single dependency:

// Before:
implementation "com.digidentity:idk:1.x.x"

// After:
implementation "com.digidentity:sdk:2.0.0"

Class and package renames

The public API has been renamed from IDK to SDK branding. Update all usages in your app:

Was Is now
com.digidentity.idk.DigidentityIDK com.digidentity.sdk.DigidentitySDK
DigidentityIDK DigidentitySDK
DigidentityIDKError DigidentitySDKError
DigidentityIDKResponse DigidentitySDKResponse
IDKBroadcastManager SDKBroadcastManager
IDKLogger / NoOpIDKLogger SDKLogger / NoOpSDKLogger
IDKResult SDKResult

If your app overrides idk_digidentity_links_host, rename it to sdk_digidentity_links_host:

<!-- Before: -->
<string name="idk_digidentity_links_host" translatable="false" tools:override="true">yourapp.link.digidentity.eu</string>

<!-- After: -->
<string name="sdk_digidentity_links_host" translatable="false" tools:override="true">yourapp.link.digidentity.eu</string>

Failing to rename this will cause Digidentity Dynamic Links to stop working silently.

Gradle plugin

The theme Gradle plugin ID (com.digidentity.idk-theme) and the IDKTheme configuration block are unchanged.

1.46.0

Account recovery

In Android IDK 1.46.0, the account recovery feature has been introduced.

When a user attempts to add an existing account using their email address, the IDK will initiate the account recovery flow. This process always begins with the user entering a recovery code received by email. Depending on the circumstances, additional verification steps may be required, such as a selfie check or a combination of selfie and evidence upload.

1.42.0

In Android IDK 1.42.0, explicit consent for photo processing has been introduced.

Please be aware that once this consent is enabled on the platform (November 24, 2025), all versions prior to 1.42.0 will cease to function. No code changes are required on your side; however, you must update to version 1.42.0 or later to ensure continued compatibility.

If you require additional time to adopt the latest IDK version, please contact Support to request that photo processing consent be temporarily disabled for your product.

1.10.0

New customizable theme text style

In Android IDK 1.10.0, the following text style was added:

  • textLBold

Add it to your theme configuration file to customize it. By default it will have the same values as found in the example configuration.

1.4.0

We have started integrating Jetpack Compose into the IDK and this requires the use of IDK Theme plugin 0.8.0. The new plugin has some new configuration. Please refer to Project setup section Compose code generation.

1.2.0

Exceptions are no longer singletons

From Android IDK 1.2.0 exception types are no longer singletons. This may break the code handling these exceptions. The following types are affected:

  • DigidentityIDKError.FlowCancelled
  • DigidentityIDKError.CameraPermissionDenied
  • DigidentityIDKError.EntityExists
  • DigidentityIDKError.ServiceRegistrationNotSupported
  • DigidentityIDKError.UserForgotPin