# Cordova Plugin
# Latest Release
Version 1.19.4 (Changelog)
# Installation
The plugin will ask for access to the camera and possibly the microphone and the photo library too. Because of this, it is mandatory to have the corresponding usage descriptions in the application's Info.plist
file. When the system prompts the user to allow access, the corresponding usage string is displayed as a part of the dialog box. In order to add the entries you must pass the variables CAMERA_USAGE
, MICROPHONE_USAGE
and PHOTO_USAGE
on plugin install.
cordova plugin add @sumsub/cordova-idensic-mobile-sdk-plugin \
--variable CAMERA_USAGE="Let us take a photo" \
--variable MICROPHONE_USAGE="Time to record a video" \
--variable PHOTO_USAGE="Let us pick a photo" \
--with-MRTDReader
Note: omit --with-MRTDReader
if you don't like to enable the MRTDReader module
If you do not provide the variables, the defaults shown in the example above will be used instead.
Please, make sure you are using Kotlin 1.5 and API level 21 (Android 5.0) or higher in your android project.
# 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, while for iOS in order to enable please follow the instructions below.
- Use
--with-MRTDReader
option during the plugin installation:
cordova plugin add @sumsub/cordova-idensic-mobile-sdk-plugin \
--with-MRTDReader
- Open up the iOS project in XCode
xed platforms/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 {YourProjectName}-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>
# Capacitor
In case you are going to use the plugin in a Capacitor-powered app, please add the following line at the top of your ios/App/Podfile
before the plugin adding:
source 'https://github.com/SumSubstance/Specs.git'
# Usage
Before launching make sure you did the Backend routines
⚠️ In case your dashboard is in Flows/Levels mode, see here for the initialization details.
# Launch
// 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 new Promise((resolve, reject) => {
resolve('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 + "]");
}
})
.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.
# Dismission
Normally the user closes the sdk himself, but if you need to do it programmatically, here is the helper:
snsMobileSDK.dismiss()
# Advanced
# Configuration
If it's required, you could provide an email and/or a phone number those will be assigned to the applicant initially:
.withApplicantConf({
"email": "...",
"phone": "..."
})
# 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 |
---|---|---|
"StepInitiated" | { | Step $idDocSetType has been initiated |
"StepCompleted" | { | Step $idDocSetType has been fulfilled or cancelled |
# 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 |