Integrate the Device Binding SDK

  • Published on Oct 28, 2025
  • 1 minute(s) read
Prev Next

Android

To use the OneSpan Device Binding SDK in your Android project

  1. Link DeviceBindingSDK.aar from the OneSpan Mobile Security Suite package to the aars folder.

  2. Link UtilitiesSDK.aar from the OneSpan Mobile Security Suite package to your project.

Note the following warnings when integrating the SDK:

  1. To use the Device Binding SDK library, you also need to add the following external libraries to your maven/gradle project:

    dependencies {
implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.9.25'
implementation 'org.bouncycastle:bcprov-jdk18on:1.81'
}

  2. Prior to Android 10, you need to set the READ_PHONE_STATE permission in the AndroidManifest.xml file of your application if the Serial is used with the fingerprint method

    For applications that target API 23 (or later) and run on Android 6.0 (or later), the READ_PHONE_STATE permission must be explicitly requested at runtime. See the Android sample in the OneSpan Mobile Security Suite package for more details.

  3. To prevent the backup of the data file the Device Binding SDK created, including a full system backup where all application data are saved via adb, you must edit the application manifest file and set the attribute android:allowBackup to false.

iOS

To use the OneSpan Device Binding SDK in your iOS project

  • Link MSSDeviceBinding.xcframework from the OneSpanMobile Security Suite package to your Xcode project.

  • If you need to share your unique device identifier between several of your own applications, you must configure your project and use the proper access group when calling the API.

To learn more about how to share fingerprints using different kinds of access groups, open the MSSDeviceBinding.doccarchive file from the iOS/Documentation folder of the package and consult the tutorials.

To see the Objective-C error codes mapped to Swift error cases, refer to the DeviceBindingErrorCodes enum in the SDK's public header MSSDeviceBinding-Swift.h.

To ensure data privacy during the SDK integration, depending on your integration, you may have to add a privacy file to your application.

If you are using the Device Binding SDK with MSSCDDC or MSSDigipass, you must indicate that the device ID is recorded in your app's PrivacyInfo.xcprivacy file. Do this by adjusting the following settings:

  • If you are using the Device Binding SDK with MSSCDDC SDK, NSPrivacyCollectedDataTypeTracking must be set to true.

  • If you are using the Device Binding SDK with MSSDigipass SDK, NSPrivacyCollectedDataTypeLinked must be set to true.

You are now ready to use the Device Binding SDK. For more information on the methods, see Obtain the device fingerprint.