Flutter SDK
Blaze Flutter SDK
The FACEKI eKYC SDK is designed to facilitate electronic Know Your Customer (eKYC) processes within applications using Flutter. This SDK simplifies the integration of document and selfie verification processes required for user identity verification.
Features
Document and Selfie Verification: Streamline the verification processes with easy integrations.
Guidance GIFs: Provides visual guidance to help users capture documents and selfies correctly.
Customizable Thresholds and Callbacks: Offers customization for verification thresholds and processes through callbacks.
Getting Started
Installation
To add the FACEKI eKYC SDK to your Flutter project, include it in your pubspec.yaml
: Always refer to Github for the latest version number
Run flutter pub get to install the new dependency.
iOS
Add these on ios/Runner/Info.plist:
Add these on ios/Podfile:
Android
Change the minimum SDK version to 21 (or higher) in android/app/build.gradle:
For More : https://pub.dev/packages/camerawesome
Basic Usage
Import the package and initialize the SDK:
Configuration Parameters
This section details the various parameters that can be configured when initializing the FACEKI eKYC SDK.
verification_link
verification_link
Type:
String
Description: Link generated from the API, use the value of key named "data"
onCompleteSelfie
onCompleteSelfie
Type:
DynamicCallback
Description: A callback function that is triggered after the selfie verification process is completed. This function is used to handle the results of the verification.
termsAndConditionUrl
termsAndConditionUrl
Type:
String
Description: A URL linking to the terms and conditions that the user must agree to before using the SDK for verification purposes.
SelfieGuidance
SelfieGuidance
Type:
String
(Optional)Example:
"packages/faceki_blaze_sdk/lib/assets/SelfieGif.gif"
Description: The path to a GIF file that provides visual guidance for taking a selfie. This helps ensure that selfies are taken in a manner suitable for verification.
CardGuidance
CardGuidance
Type:
String
(Optional)Example:
"packages/faceki_blaze_sdk/lib/assets/BH-ID.gif"
Description: The path to a GIF file that shows how to capture a document correctly for the verification process.
turnGuidanceOff
turnGuidanceOff
Type:
Bool
(Optional)Default:
false
Description: A boolean to turn off the guidance GIFs if set to true. Useful in cases where custom UI/UX implementations are preferred.
record_identifier
record_identifier
Type:
String
(Optional)Default:
""
Description: An optional field used to provide an additional identifier that can be used to record or log the verification process for audit purposes.
Last updated