Last updated
Last updated
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.
Pub Dev:
Changelogs:
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.
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.
Import the package and initialize the SDK:
This section details the various parameters that can be configured when initializing the FACEKI eKYC SDK.
verification_link
Type: String
Description: Link generated from the API, use the value of the key named "data".
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
Type: String
Description: A URL linking to the terms and conditions that the user must agree to before using the SDK for verification purposes.
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
Type: String
(Optional)
Default: ""
Description: An optional field used to provide an additional identifier which can be used to record or log the verification process for audit purposes.
bgColor
Type: int
Description: Background color for the verification interface, defined as a hex integer.
language
Type: String
Default: "en"
Description: Language code for displaying text in the verification interface.
screenTexts
Type: Map<String, Map<String, String>>
Description: A map containing localized text for different screens in the verification process. Each key corresponds to a specific screen, containing its title, secondary text, and button label.
Sample: Arabic
Sample: English
For more:
Blaze Flutter SDK