# React Native Module
# Latest Release
Version 1.24.0 (Changelog)
# Installation
yarn add @sumsub/react-native-mobilesdk-module
# Android
Please, make sure you are using Kotlin 1.5 and API level 21 (Android 5.0) or higher in your Android project.
Add the following repository to your android/build.gradle
file:
allprojects {
repositories {
// ...
maven { url "https://maven.sumsub.com/repository/maven-public/" }
// ...
}
}
To enable VideoIdent support, uncomment the following line in node_modules/@sumsub/react-native-mobilesdk-module/android/build.gradle
dependencies {
...
implementation "com.sumsub.sns:idensic-mobile-sdk-videoident:1.24.0"
...
}
# iOS
Ensure that bitcode is disabled for your iOS project
- Add as follows at the top of
ios/Podfile
:
source 'https://cdn.cocoapods.org/'
source 'https://github.com/SumSubstance/Specs.git'
# Enable MRTDReader (NFC) module
#ENV['IDENSIC_WITH_MRTDREADER'] = 'true'
# Enable VideoIdent module
#ENV['IDENSIC_WITH_VIDEOIDENT'] = 'true'
Then run:
npx pod-install
If it fails with CocoaPods could not find compatible versions for pod "IdensicMobileSDK"
message, then do as follows:
cd ios && pod update IdensicMobileSDK && cd ..
- Update
Info.plist
to have a description for the usage of the camera, the microphone, the photo library and the geolocation:
plutil -insert "NSCameraUsageDescription" -string "Let us take a photo" ios/${PWD##*/}/Info.plist
plutil -insert "NSMicrophoneUsageDescription" -string "Time to record a video" ios/${PWD##*/}/Info.plist
plutil -insert "NSPhotoLibraryUsageDescription" -string "Let us pick a photo" ios/${PWD##*/}/Info.plist
plutil -insert "NSLocationWhenInUseUsageDescription" -string "Please provide us with your geolocation data to prove your current location" ios/${PWD##*/}/Info.plist
# MRTDReader (NFC)
The MRTDReader
is a module that allows the SDK to detect and read the electronic chips placed on MRTD documents via NFC.
For Android platform the module comes out of the box. To enable iOS, please follow the instructions below.
- Update
ios/Podfile
1.1. Enable MRTDReader
module
# Enable MRTDReader (NFC) module
ENV['IDENSIC_WITH_MRTDREADER'] = 'true'
1.2. Ensure OpenSSL-Universal
dependency to be included in Release builds
The MRTDReader
module depends on the OpenSSL-Universal
internally but starting off React Native 0.67 the Flipper extension forces the OpenSSL-Universal
not to be included in the Release builds, so you have to either stop using Flipper or use the following workaround:
use_flipper!()
# Ensure `OpenSSL-Universal` dependency to be included in Release builds
if ENV['IDENSIC_WITH_MRTDREADER']
pod 'OpenSSL-Universal', :configurations => ['Debug', 'Release']
end
- Open up the iOS project in XCode
xed ios/
Then do as follows:
2.1. Turn on Near Field Communication Tag Reading
capability for your project’s target (here is how to)
2.2. Add to the application's Info.plist
file:
<key>NFCReaderUsageDescription</key>
<string>Let us scan the document for more precise recognition</string>
<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
<array>
<string>A0000002471001</string>
<string>A0000002472001</string>
<string>00000000000000</string>
</array>
# VideoIdent
The VideoIdent
is an optional module that is required only if you are going to use the Video Identification during the verification flow.
In order to enable the module, please follow the instructions below.
- Update
ios/Podfile
# Enable VideoIdent module
ENV['IDENSIC_WITH_VIDEOIDENT'] = 'true'
- Open up the iOS project in XCode
xed ios/
Then add Background mode
capability for your project’s target (here is how to) and select Audio, AirPlay, and Picture in Picture
option there. That's required for the video call not to be broken when the application goes into background.
# Usage
Before launching make sure you did the Backend routines
# Setup
import SNSMobileSDK from '@sumsub/react-native-mobilesdk-module';
// ...
let launchSNSMobileSDK = () => {
// From your backend get an access token for the applicant to be verified.
// The token must be generated with `levelName` and `userId`,
// where `levelName` is the name of a level configured in your dashboard.
//
// The sdk will work in the production or in the sandbox environment
// depend on which one the `accessToken` has been generated on.
//
let accessToken = "your_access_token";
let snsMobileSDK = SNSMobileSDK.init(accessToken, () => {
// this is a token expiration handler, will be called if the provided token is invalid or got expired
// call your backend to fetch a new access token (this is just an example)
return fetch('http://example.org/', {
method: 'GET',
}).then(resp => {
// return a fresh token from here
return 'new_access_token'
})
})
.withHandlers({ // Optional callbacks you can use to get notified of the corresponding events
onStatusChanged: (event) => {
console.log("onStatusChanged: [" + event.prevStatus + "] => [" + event.newStatus + "]");
},
onLog: (event) => {
console.log("onLog: [Idensic] " + event.message);
}
})
.withDebug(true)
.withLocale('en') // Optional, for cases when you need to override the system locale
.build();
snsMobileSDK.launch().then(result => {
console.log("SumSub SDK State: " + JSON.stringify(result))
}).catch(err => {
console.log("SumSub SDK Error: " + JSON.stringify(err))
});
}
The snsMobileSDK.launch()
returns a Promise
that will be resolved with a Result object. Use it to determine the SDK status upon its closure.
Here is an example of the result
:
{
"success": false,
"status": "Failed",
"errorType": "Unauthorized",
"errorMsg": "Unauthorized access with accessToken=[your access token]"
}
Please find a detailed description below.
# Launch
Next, you are able to use the launchSNSMobileSDK()
, as defined above, in order to launch the SDK.
For example:
<Button onPress={launchSNSMobileSDK} title="Launch SumSub SDK" />
# Dismission
By default, once the applicant is approved the SDK will be dismissed in 3 seconds automatically. You can adjust this time interval or switch the automatic dismissal off by setting value of zero:
snsMobileSDK.withAutoCloseOnApprove(0)
Also, in case you need to close the SDK programmatically, here is the what you can do:
snsMobileSDK.dismiss()
# Advanced
# Configuration
If it's required, you could provide an email and/or a phone number that will be assigned to the applicant initially:
.withApplicantConf({
"email": "...",
"phone": "..."
})
# Preferred Documents
For IDENTITY* steps, it's possible to specify the preferred country and document type to be selected automatically, thereby bypassing the DocType Selector screen. Note that the parameters provided will be applied only if the corresponding combination of country and idDocType is allowed at the step according to the level configuration.
.withPreferredDocumentDefinitions({
"IDENTITY": {
"idDocType":"PASSPORT",
"country":"USA"
},
"IDENTITY2": {
"idDocType":"DRIVERS",
"country":"FRA"
}
})
# Disable Google ML Kit
This is an Android-specific feature
The SumSub SDK uses Google ML Kit face detection library if it is available with the application and builtin Android face detection otherwise. You can disable using ML Kit even if it is available.
.withDisableMLKit(true)
# Localization
You can customize or localize the texts used within the SDK through the MSDK Translations tool in the dashboard.
The language of the texts will be set according to the system locale, but you could override it with the locale you desire:
.withLocale("en")
Please check the list of supported locales here.
# Strings
In addition to the MSDK Translations tool and .withLocale
described above, you can use .withStrings
option that allows you to define the strings locally. This could be helpful for iOS apps if you would like to avoid the Wordless Oops screen that could be rendered in case the network happens to be down during the sdk initialization and force the sdk to draw the Network Oops instead:
.withStrings({
"sns_oops_network_title": "Oops! Seems like the network is down.",
"sns_oops_network_html": "Please check your internet connection and try again.",
"sns_oops_action_retry": "Try again",
})
⚠️ Pay attention please that .withLocale
does not affect these strings, thus it's up to you to use the required localization.
# Analytics
The SDK collects and sends usage data to Sumsub servers. We don't track any sensitive data. Only general usage statistics is sent to us. It includes screen navigation events, UI controls interaction events and so on. We interpret the usage data in order to improve Sumsub. None of the data is sold or transfered to third parties, and we don't use it for advertisement.
If you still want to disable this feature, you can use the following to do this:
.withAnalyticsEnabled(false)
# Events
Various events happening along the processing could be delivered into an optional onEvent
handler:
.withHandlers({
onEvent: (event) => {
console.log("onEvent: " + JSON.stringify(event));
}
})
Each Event has eventType
and some parameters packed into payload
hash, for example:
{
"eventType": "StepInitiated",
"payload": {
"idDocSetType": "IDENTITY"
}
}
# Possible events:
eventType | payload | Description |
---|---|---|
"ApplicantLoaded" | { | The applicant $applicantId has been loaded |
"StepInitiated" | { | Step $idDocSetType has been initiated |
"StepCompleted" | { | Step $idDocSetType has been fulfilled or cancelled |
"Analytics" | { | Analytics event $eventName has occured |
# Applicant Actions
There is a special way to use the SDK in order to perform Applicant actions.
Only the Face authentication action is supported at the moment
In order to run the SDK in applicant action mode, you need to
- Associate your applicant level with a customization of
Applicant actions
type in your dashboard - Make an Access Token with the
userId
,levelName
andexternalActionId
parameters
When an action is completed the status
will be set to ActionCompleted
and the result structure would contain the actionResult
field that describes the outcome of the last action's invocation:
{
"success": true,
"status": "ActionCompleted",
"actionResult": {
"actionId": "5f77648daee05c419400c572",
"answer": "GREEN"
}
}
An empty value of actionResult.answer
means that the action was cancelled.
# Action Result Handler
In addition, there is an optional onActionResult
handler, that allows you to handle the action's result upon it's arrival from the backend.
The user sees the "Processing..." screen at this moment.
.withHandlers({
onActionResult: (result) => {
console.log("onActionResult: " + JSON.stringify(result));
// you must return a `Promise` that in turn should be resolved with
// either `cancel` to force the user interface to close, or `continue` to proceed as usual
return new Promise(resolve => {
resolve("continue");
})
}
})
# API Reference
# Result
An object described the outcome of the last sdk launch:
Field | Type | Description |
---|---|---|
success | Boolean | The boolean value indicates if there was an error on the moment the sdk is closed. Use errorType and errorMsg to see the reasons of the error if any |
status | String | SDK status |
errorType | String | A formal reason of the error if any |
errorMsg | String | A verbose error description if any |
actionResult | Object | Describes the result of the last applicant action's invocation if any |
While success
and status
are always present, the rest fields are optional.
# Status
Here is the possible sdk statuses:
Case | Description |
---|---|
Ready | SDK is initialized and ready to be presented |
Failed | SDK fails for some reasons (see errorType and errorMsg for details) |
Initial | No verification steps are passed yet |
Incomplete | Some but not all of the verification steps have been passed over |
Pending | Verification is pending |
TemporarilyDeclined | Applicant has been declined temporarily |
FinallyRejected | Applicant has been finally rejected |
Approved | Applicant has been approved |
ActionCompleted | Applicant action has been completed |
# Error Type
Here is the possible error types:
Case | Description |
---|---|
Unknown | Unknown or no fail |
InvalidParameters | An attempt to setup with invalid parameters |
Unauthorized | Unauthorized access detected (most likely accessToken is invalid or expired and had failed to be refreshed) |
InitialLoadingFailed | Initial loading from backend is failed |
ApplicantNotFound | No applicant is found for the given parameters |
ApplicantMisconfigured | Applicant is found, but is misconfigured (most likely lacks of idDocs) |
InititlizationError | An initialization error occured |
NetworkError | A network error occured (the user will be presented with Network Oops screen) |
UnexpectedError | Some unexpected error occured (the user will be presented with Fatal Oops screen) |
# Event
An object that represents an event happening along the processing:
Field | Type | Description |
---|---|---|
eventType | String | Event type |
payload | Object | Event payload |
# Action Result
An object that represents the applicant action's result:
Field | Type | Description |
---|---|---|
actionId | String | Applicant action identifier to check the results against the server |
answer | String | Overall result. Typical values are GREEN , RED or ERROR |