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

dependencies:
  faceki_blaze_sdk: <latest>

Run flutter pub get to install the new dependency.

iOS

Add these on ios/Runner/Info.plist: 

<key>NSCameraUsageDescription</key>
<string>Your own description</string>

Add these on ios/Podfile: 

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
        '$(inherited)',

        ## dart: PermissionGroup.camera
        'PERMISSION_CAMERA=1',

        ## dart: PermissionGroup.photos
        'PERMISSION_PHOTOS=1',

        ## dart: PermissionGroup.mediaLibrary
        # 'PERMISSION_MEDIA_LIBRARY=1',
        ]
    end
    flutter_additional_ios_build_settings(target)
  end
end

Android

Change the minimum SDK version to 21 (or higher) in android/app/build.gradle: 

minSdkVersion 21

For More : https://pub.dev/packages/camerawesome

Basic Usage

Import the package and initialize the SDK:

import 'package:faceki_blaze_sdk/faceki_blaze_sdk.dart';

Faceki_Blaze_SDK ekyc = Faceki_Blaze_SDK(
    verification_link: "2607ba32-c906-4e01-sdsd-abec9f56324b",
    onCompleteSelfie: (result) {
      print("Selfie Verification Result: $result");
    },
    termsAndConditionUrl: "https://www.yourcompany.com/terms",
);
ekyc!.launchEKYCFlow(context);

Configuration Parameters

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 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.

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

  • 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

  • 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 that can be used to record or log the verification process for audit purposes.

PreviousAndroid SDKNextReact

Last updated