digio kyc workflow plugin #

Digio kyc workflow flutter plugin

Getting Started #

Example flutter kyc workflow application

Android #

1. Add it to your root build.gradle at the end of repositories:

allprojects {
  repositories {
     ...
     maven { url 'https://jitpack.io' }
  }
}

2. Add the dependency:

implementation 'com.github.digio-tech:gateway:v4.0.6'
implementation 'com.github.digio-tech:gateway_kyc:v4.0.6'

3. Check your app’s build.gradle file (android/apps/build.gradle) to confirm a declaration similar to the following (depending on the build configuration you’ve selected):

android {
    compileSdkVersion 32

    defaultConfig {
        minSdkVersion 21
    }

    buildFeatures {
        viewBinding true
        dataBinding true
    }
    
    dependencies {
        implementation 'com.github.digio-tech:gateway:v4.0.6'
        implementation 'com.github.digio-tech:gateway_kyc:v4.0.6'
    
        implementation 'androidx.core:core:1.9.0'
        implementation 'androidx.appcompat:appcompat:1.5.1'
        implementation 'com.google.android.material:material:1.7.0'
        implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
    
        implementation "androidx.camera:camera-core:1.2.0"
        implementation "androidx.camera:camera-camera2:1.2.0"
        implementation "androidx.camera:camera-lifecycle:1.2.0"
        implementation "androidx.camera:camera-view:1.2.0"
    
        implementation 'androidx.navigation:navigation-fragment:2.5.3'
        implementation 'androidx.navigation:navigation-ui:2.5.3'
    
        implementation 'androidx.preference:preference:1.2.0'
        implementation 'com.google.mlkit:object-detection:17.0.0'
        implementation 'com.google.android.gms:play-services-mlkit-face-detection:17.1.0'
    
        implementation 'com.google.firebase:firebase-common-ktx:20.2.0'
        implementation 'com.google.firebase:firebase-crashlytics-ktx:18.3.2'
        
        implementation 'androidx.swiperefreshlayout:swiperefreshlayout:1.1.0'
        implementation 'com.google.android.gms:play-services-location:21.0.1'
    }
}

• Digio SDK supports android version 5.0 and above (SDK level 21 above)

4. Module Build Gradle (android/build.gradle) has following

buildscript {
    ext.kotlin_version = '1.8.0'
    dependencies {
       
        classpath 'com.google.gms:google-services:4.3.14'
        classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.2'
    }
}

Note: Kotlin plugin should be added at your project level inside build gradle

Refer android guide for android folder Android Guide

IOS #

In case of iOS, No need to put SDK. You can proceed with writting the code below.

DigioKycSDK requires permission mentioned below. Make sure to add these permissions in your app's info.plist

<key>NSCameraUsageDescription</key>
<string>$(PRODUCT_NAME) would like to access your camera.</string>   
<key>NSPhotoLibraryUsageDescription</key> 
<string>$(PRODUCT_NAME) would like to access your photo.</string>   
<key>NSMicrophoneUsageDescription</key>
<string>$(PRODUCT_NAME) would like to access your microphone to capture video.</string>
<key>NSLocationWhenInUseUsageDescription</key> 
<string>$(PRODUCT_NAME) would like to access your location.</string> 
<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>$(PRODUCT_NAME) would like to access your location.</string>

Refer ios guide for ios folder iOS Guide

How to Integrate?

1. Download ios Kyc SDK

• iOSKycSDK framework

2. Add Digio ios Kyc SDK to framework folder.

3. Ensure that in the project settings framework is selected as Embed and Sign.

4. Check all the permission required in info.plist

   <key>NSCameraUsageDescription</key>
   <string>$(PRODUCT_NAME) would like to access your camera.</string>
   <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
   <string>$(PRODUCT_NAME) would like to access your location.</string>
   <key>NSLocationWhenInUseUsageDescription</key>
   <string>$(PRODUCT_NAME) would like to access your location.</string>
   <key>NSMicrophoneUsageDescription</key>
   <string>$(PRODUCT_NAME) would like to access your microphone to capture video.</string>
   <key>NSPhotoLibraryUsageDescription</key>
   <string>$(PRODUCT_NAME) would like to access your photo.</string>
   

• Please note that {current version} will be reflected in the .zip file which is downloaded. For eg. DigioKycSDK_v_0.2.1
• Digio SDK support for xcode 14.0 and above, Swift version 5.7

Note: Kotlin plugin should be added at your project level inside build gradle

Also refer ios guide for ios folder setup : ios Guide

Starting the digio kyc workflow #

var digioConfig = DigioConfig();
digioConfig.theme.primaryColor = "#32a83a";
digioConfig.logo = "https://your_logo_url";
digioConfig.environment = Environment.SANDBOX;

final _kycWorkflowPlugin = KycWorkflow(digioConfig);
_kycWorkflowPlugin.setGatewayEventListener((GatewayEvent? gatewayEvent) {
    print("gateway event : " + gatewayEvent.toString());
});
workflowResult = await _kycWorkflowPlugin.start("KID23010416361850266BAKNKNORLP6W","[email protected]","GWT230104163618520T2Y9IPUT2PBNC8",null);
print('workflowResult : ' + workflowResult.toString());

Gateway Event Doc