hyperkyc_flutter 0.0.2

HyperKyc Flutter SDK can be used to create Global DKYC workflows to capture ID cards, selfie of the user, and perform face matches, etc to ease up integration friction.

hyperkyc_flutter

Flutter Plugin for HyperKyc GSDK

HyperKyc Flutter SDK can be used to create Global DKYC workflows to capture images of ID cards, photos of the face of the user, and perform other operations like face matches, etc all within itself to ease up integration friction on the client end. The SDK can be used within Flutter applications and supports all iOS versions from iOS 9, and Android OS versions from Lollipop 5.1 (Android API level 21) to Android 12 (Android API level 31)

Minimum Requirements

1. Android :
   1. Full migration to AndroidX
   2. minSdkVersion >= 21
   3. compileSdkVersion >= 31
   4. Minimum Gradle versions
      1. Gradle build tools version - 4.0.0
2. Gradle wrapper version - 6.1.1
3. Recommended Gradle versions
   1. Gradle build tools version - 7.0.4
4. Gradle wrapper version - 7.0.2
5. iOS :
   1. min iOS SDK version 9
   2. Recommended platform versions :
      1. xCode 13+
      2. Swift 5.5
      3. Cocoapods 1.11.x

Android Setup

1. Make sure that the minimum SDK version is 21 or higher
2. Enable multidex
3. Open android/build.gradle file and add the following lines inside allprojects function

allprojects {  
	 repositories { 
		 google() 
		 mavenCentral() 
		 maven { 
			 url = "s3://hvsdk/android/releases" 
			 credentials(AwsCredentials) { 
				 accessKey = "aws_access_key" // get this from the team 
				 secretKey = "aws_secret_pass"// get this from the team 
			} 
		} 
	}
}  

4. Sync the project

iOS Setup

1. cd to iOS directory and run pod install
2. Add Camera Permissions to request the user for camera permissions, add this key-value pair in your application's info.plist file.
   • Key : Privacy - Camera Usage Description
   • Value : "Access to camera is needed for document and face capture"

Integrate HyperKyc Flutter SDK

1. Create HyperKycConfig instance using HyperKycConfigBuilder

//  Create WorkFlow using HyperKycFlow enum 
var workFlow = [ HyperKycFlow.document,
				 HyperKycFlow.face,  
			   ];
//  Create HyperKycConfig instance using HyperKycConfigBuilder  
var hyperKycConfig = HyperKycConfigBuilder() 
					.setAppId(appId: '<appId>') // get this from Hyperverge team
					.setAccessToken(accessToken: '<accessToken>') // get more info from Hyperverge team 
					.setTransactionId(transactionId: '<transactionId>')
					.setWorkFlow(workFlow: workFlow)
					.build();  

2. Launch HyperKyc

//  Launch HyperKyc using launch() function
HyperKycResult hyperKycResult = await HyperKyc.launch(hyperKycConfig: hyperKycConfig); // Please contact Hyperverge team to understand how to process HyperKycResult  

Please contact Hyperverge for complete documentation and a properly designed solution specific to your usecase to use HyperKyc SDK to its optimum capacity