Integrate the Biometric Sensor SDK

Prev Next

Android

To use the OneSpan Biometric Sensor SDK in your Android project

  1. Link BiometricSensorSDK.aar from the OneSpan Mobile Security Suite package to your project.

  2. Link the androidx.appcompat:appcompat library from Google version 1.1.0 and later to your project.

  3. Link the androidx.biometric:biometric library from Google version 1.0.1 and later to your project.

To be able to access the biometric authentication service, you need to set appropriate permissions in your application configuration.

For devices that run on Android versions earlier than Android 9, you need to add the USE_FINGERPRINT permission to the AndroidManifest.xml file.

For devices that run on Android 9 or later, you need to add the USE_BIOMETRIC permission to the AndroidManifest.xml file.

iOS

To use the OneSpan Biometric Sensor SDK in your iOS project

  1. Link the MSSBiometricSensor.xcframework from the OneSpan Mobile Security Suite package to your Xcode project.

  2. In the Build Settings > Other Linker flags section of your Xcode project, add the following line:

    -weak_framework LocalAuthentication.

  3. In the Info.plist file, define the NSFaceIDUsageDescription key.

You are now ready to use the OneSpan Biometric Sensor SDK.

API reference documentation and sample applications

To learn more about the public APIs and their functions, exceptions, and error codes, refer to the technical documentation that is included in the product package for each SDK and each platform. In the product package, you can also find the sample applications provided for each platform to see examples of how the SDKs can be used.

These sample apps are intended only to demonstrate basic scenarios and SDK usage. They are not designed to be copied directly into production projects!