GitHub Repository
View source code and examples on GitHub
npm Package
@didit-protocol/sdk-react-native
Requirements
Platform Requirements
Biometric consent needs native 4.10.0 or later. For people covered by Illinois, Texas or Colorado law, Didit can ask for explicit biometric consent before the first face capture. A React Native SDK release that pins native iOS and Android 4.10.0 or later shows that step. Earlier versions cannot show the step: their sessions run as before, and the decision reports the consent as not collected (
biometric_consent.reason: "BIOMETRIC_CONSENT_UNSUPPORTED_SDK"). Upgrade if you verify people in those states.Installation
Expo (Recommended)
app.json (or app.config.js). NFC is enabled by default:
- Android: Adds the Didit Maven repository to Gradle, sets the
diditSdkAndroidNfcEnabledGradle property, and applies BouncyCastle dependency/packaging rules - iOS: Adds the DiditSDK podspec to the Podfile (pinned to iOS 15 when NFC is enabled)
Info.plist. Add the iOS permission keys and, for NFC, the ISO7816 select identifiers under ios.infoPlist in the same file. D392F000260100000001 lets the SDK read the Japan My Number Card through JPKI:
Disabling NFC dependencies
To build without NFC support (smaller binary, no NFC capability required), pass plugin options:React Native CLI
iOS Setup
Add the DiditSDK pod to yourPodfile (it’s not on CocoaPods trunk). The block below honours an DIDIT_SDK_IOS_NFC_ENABLED environment variable so you can toggle the no-NFC subspec (DiditSDK/Core) at install time:
Android Setup
From 4.15.2 the package adds Didit’s Maven repository (theme.didit group only) to your build itself, and Android needs no Gradle change.
On 4.15.1, add the repository to every project in android/build.gradle:
settings.gradle and the build fails with Could not find me.didit:didit-sdk.
If your settings.gradle sets repositoriesMode to PREFER_SETTINGS, list the repository there instead.
The SDK’s wallet dependencies come from JitPack, which React Native’s Gradle plugin already adds.
Add the following to your app’s android/app/build.gradle (inside the android { ... } block) to resolve BouncyCastle duplicate-class conflicts and the OSGI MANIFEST.MF duplicate that the DiditSDK transitive dependencies can trigger:
me.didit:didit-sdk-core artifact instead of me.didit:didit-sdk), add this to android/gradle.properties:
true, to use the full Android SDK with NFC.
Permissions
iOS
Add the following keys to your app’sInfo.plist. Missing required iOS privacy keys will cause iOS to terminate the app as soon as the SDK accesses that protected resource.
NFC Configuration
To enable NFC reading for passports and ID cards with chips:-
Add NFC Capability in Xcode:
- Select your target > Signing & Capabilities > + Capability > Near Field Communication Tag Reading
-
Add ISO7816 Identifiers to
Info.plist:
D392F000260100000001 lets the SDK read the Japan My Number Card through JPKI: without it, iOS does not report the card to the SDK. My Number Card reading is not enabled in production yet, and the identifier changes nothing for other documents, so you can add it now.
- Add an entitlements file with NFC tag reading enabled:
Android
The following permissions are declared in the SDK’sAndroidManifest.xml and merged automatically:
Camera and NFC hardware features are declared as optional (
android:required="false"), so your app can be installed on devices without these features.
Quick Start
Integration Methods
The SDK supports two integration methods:Method 1: Session Token (Recommended for Production)
Create a session on your backend using the Create Verification Session API, then pass the token to the SDK:- Associating sessions with your users (
vendor_data) - Setting custom metadata
- Configuring callbacks per session
Method 2: Workflow ID (Simpler Integration)
For simpler integrations, the SDK can create sessions directly using your workflow ID:Configuration
Customize the SDK behavior by passing aDiditConfig object:
startVerificationWithWorkflow, pass config inside options.config:
Configuration Options
Camera options
The camera options match the Web SDK camera options. Each lens isCameraLens.Front or CameraLens.Back.
If the device does not have the requested lens, the SDK uses the first camera it has.
The camera switcher is also hidden on devices that have only one camera.
Set a switcher option to false to lock the user to the default lens of that step.
Theming & Colors: Colors, backgrounds, and intro screen settings are configured through your White Label settings in the Didit Console, not in the SDK configuration. This ensures consistent branding across all platforms.
Language Support
The SDK supports 54 languages. If no language is specified, the SDK uses the device locale with English as fallback.Advanced Options
These options are only available withstartVerificationWithWorkflow, where the SDK creates the session on your behalf.
Contact Details (Prefill & Notifications)
Provide contact details to prefill verification forms and enable email notifications:Expected Details (Cross-Validation)
Provide expected user details for automatic cross-validation with extracted document data:ExpectedDetails fields are optional. See src/types.ts for the full type.
Custom Metadata
Store custom JSON metadata with the session (not displayed to user):Handling Results
BothstartVerification and startVerificationWithWorkflow return a Promise<VerificationResult>. The result is a discriminated union — use the type field to determine the outcome.
Result Cases
SessionData Properties
Error Types
Lost connection
If the device loses its connection during the verification, the SDK covers the flow with a “No internet connection” screen instead of leaving a step loading. It keeps checking in the background and closes the screen by itself as soon as Didit can be reached again, and the user carries on from the step they were on. The screen offers Try Again and, whenshowCloseButton is true (the default), Exit Verification.
Exiting ends the verification with a failed result whose error is networkError, so your app knows the user left because of the connection.
Complete Result Handling Example
End-to-End Example (Backend Session → React Native SDK → Webhook)
The production-ready integration: your backend creates the session, your RN app receives thesession_token, and the SDK runs the flow. The final decision is delivered to your backend via webhook — never trust the client-side result alone.