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.8.0¶
DigidentitySDKError.userForgotPIN renamed to customAccountRecoveryRequested¶
The error case reported when the user requests account recovery has been renamed from DigidentitySDKError.userForgotPIN to DigidentitySDKError.customAccountRecoveryRequested. Update any code that handles it.
Previously this error was fired only by the "Forgot your PIN?" button. It is now also fired by the "Recover access" button, and the feature flag that enables this behaviour has been renamed from customForgotPinButton to customAccountRecovery, which takes precedence over disableAccountRecovery. Existing JWT secrets do not need to change: the former secret value customForgotPinButton is still accepted and maps to customAccountRecovery.
2.4.0¶
Liquid Glass support (iOS 26)¶
The SDK now renders correctly with the iOS 26 Liquid Glass design, so the compatibility opt-out is no longer needed.
Remove the UIDesignRequiresCompatibility key from your app's Info.plist:
<key>UIDesignRequiresCompatibility</key>
<true/>
If you keep this key, your app stays in the pre-iOS 26 compatibility appearance and will not pick up the updated navigation bar styling.
2.3.0¶
New login screen theme colors¶
In iOS SDK 2.3.0, the following colors were introduced:
loginCardBackgroundColoriOSloginDotColor
Please make sure to define these colors. An example of the customizable style file can be found here.
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, replacepod 'DigidentityIDK'withpod 'DigidentitySDK' - Replace all
import DigidentityIDKstatements withimport DigidentitySDK DigidentityIDK→DigidentitySDKIDKDelegate→SDKDelegateIDKHandleURLResult→SDKHandleURLResultDigidentityIDKError→DigidentitySDKError- Replace any other remaining occurrences of
IDKwithSDK
New account switcher theme colors¶
In iOS SDK 2.0.0, the following colors were introduced:
accountSwitcherBackgroundColoraccountSwitcherIconFirstCircleColoraccountSwitcherIconSecondCircleColoraccountSwitcherIconThirdCircleColor
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¶
Explicit photo processing consent¶
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.9.0¶
DigidentitySDKError.UserForgotPin renamed to CustomAccountRecoveryRequested¶
The error reported when the user requests account recovery has been renamed from DigidentitySDKError.UserForgotPin to DigidentitySDKError.CustomAccountRecoveryRequested. Update any code that handles it:
// Before
is DigidentitySDKError.UserForgotPin -> handleUserForgotPin()
// After
is DigidentitySDKError.CustomAccountRecoveryRequested -> handleUserForgotPin()
It is now also returned when the user taps "Recover access", and when "Forgot your PIN?" is tapped during a re-login or account switch inside an SDK flow or in a QR scan started from an SDK screen; push flows report it through the onFailure of handleNotification.
If disableAccountRecovery is also set, customAccountRecovery takes precedence on the unlock screens, so blocked or expired accounts show "Recover access" instead of the contact-customer-service option, and tapping it returns this error.
New numeric keyboard theme colors¶
In Android SDK 2.9.0, the following colors were introduced for the keys of the numeric keyboard:
androidNumpadKeyBackgroundColorandroidNumpadKeyBackgroundActiveColorandroidNumpadKeyBorderColorandroidNumpadKeyTextColor
And the following dimension:
androidNumpadKeyBorderWidth
Until now the keyboard keys used the secondary button style. To keep the current look, use the values of secondaryButtonBackgroundColor, secondaryButtonBackgroundActiveColor, secondaryButtonBorderColor, textPrimaryColor and secondaryButtonBorderWidth respectively.
These keys require IDK Theme plugin 0.18.0 or later. Update the plugin version in your build configuration, see Project setup.
Please make sure to define these values. A theme configuration without them will fail to compile. An example of the customizable style file can be found here.
New handleUri overload on the SDK interface¶
In Android SDK 2.9.0, the following method was added to the SDK interface:
fun handleUri(
context: Context,
uri: Uri,
referrer: Uri?,
isInAppLink: Boolean,
onSuccess: (HandleUriResult) -> Unit,
onFailure: FailureCallback,
): Intent
If your app only calls DigidentitySDK or the instance returned by DigidentitySDK.getInstance(), no change is needed. If your app has its own class that implements SDK, for example a test fake, add this method to it. Otherwise the class will fail to compile.
For when to pass isInAppLink, see Digidentity Dynamic Links setup.
New resolveDeepLinkReferrer on the SDK interface¶
In Android SDK 2.9.0, the following method was added to the SDK interface:
fun resolveDeepLinkReferrer(activity: Activity): Uri?
Pass its result as referrer to handleUri and handleDeepLink instead of Activity.getReferrer(), so that after a passwordless login the user returns to the browser that opened the link. Call it in the activity that Android launched for the link.
If your app has its own class that implements SDK, for example a test fake, add this method to it. Otherwise the class will fail to compile.
2.7.0¶
Build requirements¶
Android SDK 2.7.0 requires your app to be built with:
compileSdk37- Android Gradle Plugin 9.3.1 or later
android {
compileSdk 37
}
Builds using a lower compileSdk or an older Android Gradle Plugin will fail to compile against SDK 2.7.0.
2.5.0¶
Downgrading to an earlier SDK version is not supported¶
In Android SDK 2.5.0, protection of locally stored data has been strengthened.
It is one-way, however: once a build using SDK 2.5.0 has run on a device, that installation can no longer be opened by a build using an earlier SDK version. Upgrading from any earlier version to 2.5.0 is supported; downgrading is not.
Please take this into account when planning your rollout, and avoid rolling a 2.5.0 build back to an earlier build for users who have already installed it.
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 |
Dynamic Links resource string¶
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¶
Explicit photo processing consent¶
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.FlowCancelledDigidentityIDKError.CameraPermissionDeniedDigidentityIDKError.EntityExistsDigidentityIDKError.ServiceRegistrationNotSupportedDigidentityIDKError.UserForgotPin