hyperkyc_flutter 0.40.1
hyperkyc_flutter: ^0.40.1 copied to clipboard
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 SDK #
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 11, and Android OS versions from Lollipop 5.1 (Android API level 21) to Android 13 (Android API level 31)
Please contact Hyperverge for complete documentation and a properly designed solution specific to your usecase to use HyperKYC SDK to its optimum capacity
Minimum Requirements #
- Android :
- Full migration to AndroidX
minSdkVersion
>= 21compileSdkVersion
>= 31- Minimum Gradle versions
- Gradle build tools version -
4.0.0
- Gradle wrapper version -
6.1.1
- Recommended Gradle versions
- Gradle build tools version -
7.0.4
- Gradle build tools version -
- Gradle wrapper version -
7.0.2
- Gradle build tools version -
- iOS :
- min iOS SDK version
11
- Recommended platform versions :
- xCode 13+
- Swift 5.5
- Cocoapods 1.11.x
- min iOS SDK version
Android Setup #
- Make sure that the minimum SDK version is 21 or higher
- Enable
multidex
- Open
android/build.gradle
file and add the following lines insideallprojects
function
allprojects {
repositories {
google()
mavenCentral()
maven {
url = "https://s3.ap-south-1.amazonaws.com/hvsdk/android/releases"
}
}
}
- Sync the project
iOS Setup #
cd
to iOS directory and runpod install
- 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 #
- Create
HyperKycConfig
instance usingHyperKycConfig.fromAccessToken
(more secure) orHyperKycConfig.fromAppIdAppKey
(less secure)
// Create HyperKycConfig instance using `HyperKycConfig.fromAppIdAppKey` (less secure)
var hyperKycConfig = HyperKycConfig.fromAppIdAppKey(
appId: <app-id>, // Get this from Hyperverge team
appKey: <app-key>, // Get this from Hyperverge team
workflowId: <workflow-id>, // Get workflow-id from Hyperverge dashboard
transactionId: <transaction-id>,
);
- Set Custom Inputs (Optional)
final Map<String, String> customInputs = {
'key1': 'value1',
'key2': 'value2',
...
}
hyperKycConfig.setInputs(inputs: customInputs)
- Launch HyperKYC
// Launch HyperKYC using launch() function
HyperKycResult hyperKycResult = await HyperKyc.launch(hyperKycConfig: hyperKycConfig); // Please contact Hyperverge team to understand how to process HyperKycResult