The Socure Device Risk SDK React Native bridge provides Reach developers with the ability to call the Socure Device Risk SDK, either the Android or iOS native library variants, through React.
This guide covers the integration within React, as well as React Native implementation on iOS and Android.
Minimum Requirements iOS 13 and above Android SDK version 33 and above
Please read the documentation on either the Android or iOS native library variants to understand how the Device Risk SDK works.
Please follow the instructions below to add this wrapper library to your project. Alternatively, you can use this sample app as a starting point.
Add the following dependency to package.json
:
"dependencies":{
....,
"react-native-device-risk": "https://github.com/socure-inc/socure-sigmadevice-wrapper-react-native#1.2.1"
}
Step 1: Open the module level build.gradle for the main project module and inside of the defaultConfig section, set the minSdkVersion to 33
Step 2: Synchronize your gradle projects
The Android side of the Bridge should be ready to run.
Note: If pulling from Maven, implement the below)
buildscript {
…………..
dependencies {
……………………
classpath ‘com.github.dcendents:android-maven-gradle-plugin:1.5’
}
}
(NOT IN THE buildscript
code block above. allprojects is a sibling to build script)
You will receive a username and token from Socure
Place these variables in you gradle.properties file inside your Android project
allprojects {
repositories {
…….
maven {
url “https://jitpack.io”
}
}
}
- Ensure
Kotlin
plugin is added in thedependencies
section:
buildscript {
.....
dependencies {
.....
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:x.x.x"
}
}
Note: Socure has tested the build with plugin version 1.6.0.
Step 3:
In the main module (<root project dir>/android/app/build.gradle)
add the below dependency
in dependencies {}
section:
dependencies {
.....
implementation "org.jetbrains.kotlin:kotlin-stdlib:x.x.x"
.....
}
Note: Socure has tested the build with plugin version 1.6.0.
Step 4:
In the (<root project dir>/android/gradle.properties)
file add the following:
username=Socure
authToken=Socure
Build and run:
- Run
yarn install
. - Run
react-native run-android
from the root folder.
Step 0: Install cocoapods-user-defined-build-types
Since the Socure Document Verification SDK is an XCFramework, Cocoapods doesn’t easily allow dynamic frameworks to intermingle with static libraries. This gem modifies Cocoapods to allow both to exist at the same time. Follow the instructions over at https://github.com/joncardasis/cocoapods-user-defined-build-types
Step 1: Install Socure SDK React Native Bridge using CocoaPods (recommended)
Before your target
, add the following:
plugin 'cocoapods-user-defined-build-types'
enable_user_defined_build_types!
and inside your target
, add the corresponding pod
lines
use_frameworks!
pod 'SocureDeviceRisk', :build_type => :dynamic_framework
Update your pods from the terminal
pod install
You can also copy the folder react-native-device-risk
and add it along with your other React Native pods.
Step 2: Add appropriate permissions for the services you want DeviceRisk SDK to use
This is explained in more detail in the native iOS library’s documentation
Step 3:
- Run
react-native run-ios
.
For instructions on how to configure the SDK, see the React Native documentation on DevHub.
You can checkout the example app from here. The file App.js
shows the JS function calls used and how to ultimately retrieve the Device Risk Session ID.