If you have ProGuard or R8 minification and resource shrinking enabled for your Android release builds, you must add keep rules so that the Dojah SDK classes and its dependencies are not stripped or obfuscated. Without these rules, the SDK may crash at runtime with ClassNotFoundException, NoSuchMethodError, or silent WebView/JavaScript bridge failures.
CLI (React Native)
Expo
1
Enable minification in build.gradle
In your android/app/build.gradle, enable ProGuard (R8) for release builds:
Create or open the file android/app/proguard-rules.pro and add the following rules:
# ── Dojah SDK ──-keep class com.dojah.** { *; }-keep class com.dojah_inc.** { *; }-keepclassmembers class com.dojah.** { *; }-dontwarn com.dojah.**# ── Android WebView JavaScript bridge ──-keepclassmembers class * { @android.webkit.JavascriptInterface <methods>;}-keepattributes JavascriptInterface# ── Retrofit (used internally by the SDK) ──-keepattributes Signature,InnerClasses,EnclosingMethod-keepattributes RuntimeVisibleAnnotations,RuntimeVisibleParameterAnnotations-keepattributes AnnotationDefault-keepclassmembers,allowshrinking,allowobfuscation interface * { @retrofit2.http.* <methods>;}-if interface * { @retrofit2.http.* <methods>; }-keep,allowobfuscation interface <1>-keep,allowobfuscation,allowshrinking interface retrofit2.Call-keep,allowobfuscation,allowshrinking class retrofit2.Response-keep,allowobfuscation,allowshrinking class kotlin.coroutines.Continuation-dontwarn retrofit2.KotlinExtensions-dontwarn retrofit2.KotlinExtensions$*# ── OkHttp / Okio ──-dontwarn okhttp3.**-dontwarn okio.**# ── Gson ──-keep class sun.misc.Unsafe { *; }-keep class com.google.gson.** { *; }# ── Glide (image loading) ──-keep public class * implements com.bumptech.glide.module.GlideModule-keep class * extends com.bumptech.glide.module.AppGlideModule { <init>(...);}-keep public enum com.bumptech.glide.load.ImageHeaderParser$** { **[] $VALUES; public *;}-keep class com.bumptech.glide.load.data.ParcelFileDescriptorRewinder$InternalRewinder { *** rewind();}# ── Misc ──-dontwarn javax.annotation.**-dontwarn kotlin.Unit-dontwarn org.codehaus.mojo.animal_sniffer.*
If you are using Expo, you can apply ProGuard rules directly in your app.config.ts (or app.json) using the expo-build-properties plugin without creating a separate proguard-rules.pro file:
android: { minSdkVersion: 26, compileSdkVersion: 35, targetSdkVersion: 35, enableProguardInReleaseBuilds: true, enableShrinkResourcesInReleaseBuilds: true, extraProguardRules: [ '-keep class com.dojah.** { *; }', '-keep class com.dojah_inc.** { *; }', '-keepclassmembers class com.dojah.** { *; }', '-keepclassmembers class * { @android.webkit.JavascriptInterface <methods>; }', '-keepattributes JavascriptInterface', '-keepattributes Signature,InnerClasses,EnclosingMethod', '-keepattributes RuntimeVisibleAnnotations,RuntimeVisibleParameterAnnotations', '-keepattributes AnnotationDefault', '-keepclassmembers,allowshrinking,allowobfuscation interface * { @retrofit2.http.* <methods>; }', '-dontwarn javax.annotation.**', '-dontwarn kotlin.Unit', '-dontwarn retrofit2.KotlinExtensions', '-dontwarn retrofit2.KotlinExtensions$*', '-if interface * { @retrofit2.http.* <methods>; }', '-keep,allowobfuscation interface <1>', '-keep,allowobfuscation,allowshrinking interface retrofit2.Call', '-keep,allowobfuscation,allowshrinking class retrofit2.Response', '-keep,allowobfuscation,allowshrinking class kotlin.coroutines.Continuation', '-dontwarn org.codehaus.mojo.animal_sniffer.*', '-keep class sun.misc.Unsafe { *; }', '-keep class com.google.gson.** { *; }', '-keep public class * implements com.bumptech.glide.module.GlideModule', '-keep class * extends com.bumptech.glide.module.AppGlideModule { <init>(...); }', '-keep public enum com.bumptech.glide.load.ImageHeaderParser$** { **[] $VALUES; public *; }', '-keep class com.bumptech.glide.load.data.ParcelFileDescriptorRewinder$InternalRewinder { *** rewind(); }', '-dontwarn com.dojah.**', '-dontwarn okhttp3.**', '-dontwarn okio.**', ].join('\n'),},
Then run npx expo prebuild to regenerate your native project with the updated rules.
Failing to add these rules when ProGuard/R8 is enabled will cause the Dojah SDK to malfunction in release builds. Common symptoms include blank screens, crashes on SDK launch, and network call failures. If you encounter issues, run a release build with --no-shrink temporarily to confirm ProGuard is the cause.
For iOS, Add the following keys to your Info.plist file:NSCameraUsageDescription - describe why your app needs access to the camera. This is called Privacy - Camera Usage Description in the visual editor.NSMicrophoneUsageDescription - describe why your app needs access to the microphone, if you intend to record videos. This is called Privacy - Microphone Usage Description in the visual editor.NSLocationWhenInUseUsageDescription - describe why your app needs access to the location, if you intend to verify address/location. This is called Privacy - Location Usage Description in the visual editor.
To use the SDK, you need a WidgetID, which is a required parameter for initializing the SDK. You can obtain this by creating a flow on the Dojah platform. Follow these steps to configure and get your Widget ID:
1. Log in to your Dojah Dashboard: If you don’t have an account, sign up on the Dojah platform.2. Navigate to the EasyOnboard Feature: Once logged in, find the EasyOnboard section on your dashboard.3. Create a Flow: - Click on the 'Create a Flow' button. - Name Your Flow: Choose a meaningful name for your flow, which will help you identify it later.4. Add an Application: - Either create a new application or add an existing one. - Customise your widget with your brand logo and color by selecting an application.5. Configure the Flow: - Select a Country: Choose the country or countries relevant to your verification process. - Select a Preview Process: Decide between automatic or manual verification. - Notification Type: Choose how you’d like to receive notifications for updates (email, SMS, etc.). - Add Verification Pages: Customize the verification steps in your flow (e.g., ID verification, address verification, etc.).6. Publish Your Widget: After configuring your flow, publish the widget. Once published, your flow is live.7. Copy Your Widget ID: After publishing, the platform will generate a Widget ID. Copy this Widget ID as you will need it to initialize the SDK as stated above.
-NB: Kindly input your widget_id inside uri above, Get it from your Easy Onboard application dashboard here
Important Security Update: Proper Handling of SDK Verification CallbacksThe final verification decision should never rely on SDK callbacks (onSuccess, onError, onClose) alone. Always retrieve the actual verification status from your backend using the reference ID before granting access or approving onboarding.
onSuccess — All verification steps completed
The onSuccess callback is triggered when the user has completed all the verification steps configured in the widget flow. This confirms that every step — such as document capture, liveness check, government data entry, etc. — has been submitted by the user.Important:onSuccess confirms flow completion, not that the user passed all checks. A user may complete every step but still fail backend validation (e.g., document mismatch, failed liveness). Always verify the final result from your backend using the reference ID.
onError — Error before all steps are completed
The onError callback is triggered when an error occurs before all verification steps are completed. This prevents the user from finishing the flow. Common causes include:
Network connectivity issues
SDK initialization or configuration errors
Provider-side failures during a verification step
Unexpected interruptions during the flow
When onError fires, the verification is incomplete. Your application should handle this gracefully — for example, by prompting the user to retry.
onClose — Widget terminated via close button
The onClose callback is triggered when the user terminates the widget using the close button. This indicates the user chose to exit the verification flow before completing all steps.The verification is considered abandoned when this occurs. If a redirect URL is configured, the user will be redirected there after the widget closes. The final verification status will be delivered through the webhook notification.
Recommended ImplementationAfter the widget interaction, create a backend flow or confirmation page that retrieves the actual verification result using the reference ID generated during the verification process. You can retrieve the final verification details through:
