Skip to main content

​
📘 Get Started with Flutter SDK - Dojah KYC Widget

​
Native SDK

Package : dojah_kyc_sdk_flutter Example Application: https://github.com/dojah-inc/Dojah-flutter-sdk

​
Installation

 $ flutter pub add dojah_kyc_sdk_flutter

​
Android Setup

Requirements
  • Minimum Android SDK version - 21
  • Supported targetSdkVersion - 35
In your android root/build.gradle file set maven path: 
...
allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}
Or Set maven path in your root/settings.gradle file: 
...
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}
Permissions For Android you don’t need to declare permissions, its already included in the Package.

​
iOS Setup

Requirements
  • Minimum iOS version - 14
Add the following POD dependencies in your Podfile app under your App target 
  pod 'Realm', '~> 10.52.2', :modular_headers => true
  pod 'DojahWidget', :git => 'https://github.com/dojah-inc/sdk-swift.git', :branch => 'pod-package'

target 'Example' do
  ...
  pod 'Realm', '~> 10.52.2', :modular_headers => true
  pod 'DojahWidget', :git => 'https://github.com/dojah-inc/sdk-swift.git', :branch => 'pod-package'
  ...
end
and run pod install in your iOS folder: 
cd iOS
pod install
Permissions 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.

​
Usage

To start KYC, import DojahKyc in your Flutter code, and launch Dojah Screen 
import 'package:dojah_kyc_sdk_flutter/dojah_kyc_sdk_flutter.dart';

DojahKyc.launch(
  "{Required: Your_WidgetID}",
  referenceId: "{Optional: Reference_ID}",
  email: "{Optional: Email_Address}"
)



//Example (If you're not passing WidgetID, Reference_ID and Email_Address values)

DojahKyc.launch("1234678901234",  referenceId: "DJ-123456",  email: "abc@gmail.com")


//Example (If you're not passing Reference_ID and Email_Address values)

DojahKyc.launch("1234678901234",  referenceId: null, email: null)
SDK Parameters
  • WidgetID - a REQUIRED parameter. You get this ID when you sign up on the Dojah platform, follow the next step to generate your WidgetId.
  • Reference ID - an OPTIONAL parameter that allows you to initialize the SDK for an ongoing verification.
  • Email Address - an OPTIONAL parameter that allows you to initialize the SDK for an ongoing verification.

​
How to Get a Widget ID

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.

​
Example Application

Contributing
  • KYC WIDGET Repository
  • Fork it!
  • Create your feature branch: git checkout -b feature/feature-name
  • Commit your changes: git commit -am 'Some commit message'
  • Push to the branch: git push origin feature/feature-name
  • Submit a pull request 😉😉

​
Webview SDK

Package : flutter_dojah_kyc Example Application: https://github.com/dojah-inc/Flutter-SDK

​
Installation

 $ flutter pub add flutter_dojah_kyc

​
iOS

Add the following keys to your Info.plist file, located in <project root>/ios/Runner/Info.plist:
  • 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.

​
Podfile

Kindly include this in Podfile set up. dart: PermissionGroup.camera PERMISSION_CAMERA=1, dart: PermissionGroup.microphone PERMISSION_MICROPHONE=1, dart: PermissionGroup.location PERMISSION_LOCATION=1,

​
Android

// Add the camera permission: 

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

// For newer Android versions
<uses-permission android:name="android.permission.ACCESS_MEDIA_LOCATION" />

<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />

// Add the modify audio settings permission:
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
// Add the Internet settings permission:
<uses-permission android:name="android.permission.INTERNET"/>
// Add the Location settings permission :
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

​
Usage

final Map<String,dynamic> config = {
  debug: true,
  otp: true, //for verification type
  selfie: true //for verification type
};


  final userData = {
          "first_name": "John",
          "last_name": "Doe",
          "dob": "1990-04-16",
          "residence_country": "Nigeria",
          "email": "abc@gmail.com"
        };


     final configObj = {
      "widget_id": "Your Widget ID"
      };

    final metaData = {
       "user_id": "81828289191919193882",
       "many_other_custom_fields": "",
    };


  final govData = {
                  "bvn": "",
                  "nin": "",
                  "dl": "",
                  "mobile": ""
  };


    final govId = {
         "passport": "https://d.jpeg",  
         "national": "https://d.jpeg",    //National ID card/ NIN Slip
         "dl": "https://d.jpeg",         //Driver's license
         "permit": "https://d.jpeg", 
         "voter": "https://d.jpeg",
         "custom": "https://d.jpeg",

};

 final DojahKYC _dojahKYC = DojahKYC(
    appId: appId,
    publicKey: publicKey,
    type: "custom",
    userData: userData, //Optional 
    metaData: metaData, //Optional 
    config: configObj, 
    govData: govData, //Optional 
    govId: govId, //Optional 
    referenceId: referenceId //Optional  
                );


  _dojahKYC.open(context, onSuccess: (result) {
    print('$result');
  }, 
  onClose: (close) => print('Widget Closed'),
  onError: (err) {
    print('error: $err');
  });

​
Deployment

REMEMBER TO CHANGE THE APP ID and PUBLIC KEY WHEN DEPLOYING TO A LIVE (PRODUCTION) ENVIRONMENT Contributing
  • KYC WIDGET Repository
  • Fork it!
  • Create your feature branch: git checkout -b feature/feature-name
  • Commit your changes: git commit -am 'Some commit message'
  • Push to the branch: git push origin feature/feature-name
  • Submit a pull request 😉😉

​
Android File Upload crash fixed

Here’s a fix for Android Device crashing during file upload Kindly do the following: The error message indicates that the Android file provider authority is not properly configured in your Flutter mobile application. The file provider authority is necessary for Android devices to access files using a content URI. To resolve this issue, you need to make sure that you have properly configured the file provider in your AndroidManifest.xml file. Here are the steps to configure the file provider:
  1. Open the AndroidManifest.xml file located in the android/app/src/main directory of your Flutter project.
  2. Inside the <application> tag, add the following code: Make sure to replace com.example.dojah_kyc with your application’s package name.
  3. Create a new file named provider_paths.xml in the android/app/src/main/res/xml directory (create the xml directory if it doesn’t exist). Add the following code to the provider_paths.xml file:
  1. Save the changes and rebuild your Flutter application. By following these steps, you should be able to properly configure the file provider and resolve the “Couldn’t find meta-data for provider” error when selecting files with the file picker in your Flutter application on Android devices.