Blusalt Full Identity Verification Flutter Plugin #

A Flutter plugin for Blusalt Full Identity Verification SDK that supports both Android and iOS platforms.

Features #

• Full Identity SDK: Complete identity verification with document scanning and liveness check
• Document Absent with Custom Selector: Identity verification where user selects document type from a list
• Document Absent with ID Number: Identity verification by providing document type and number directly
• Cross-platform: Works on both Android (API 16+) and iOS (11.0+)
• Native Integration: Uses native Blusalt SDKs for optimal performance

Getting Started #

Prerequisites #

Android

• Min SDK: 16
• Compile SDK: 31
• Kotlin: 1.7.10+

iOS

• iOS 11.0+
• Swift 5.0+
• Xcode 13.0+

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  full_identity_verification:
    path: ../full_identity_verification

Setup #

Android Setup

1. Add GitHub credentials to your project's android/github.properties:

USERNAME_GITHUB=your_github_username
TOKEN_GITHUB=your_github_token

2. The plugin already includes the necessary dependencies in its build.gradle.

iOS Setup

The plugin includes the necessary frameworks. Just run:

cd ios && pod install

Usage #

Import the package #

import 'package:full_identity_verification/full_identity_verification.dart';
import 'package:full_identity_verification/enums.dart';

Initialize the plugin #

final _fullIdentityPlugin = BlusaltFullIdentityVerification();

1. Full Identity SDK (Document Present) #

Use this when users will physically scan their documents:

final result = await _fullIdentityPlugin.startFullIdentitySDK(
  apiKey: 'your_api_key',
  appName: 'your_app_name',
  clientId: 'your_client_id',
  isDev: true, // Set to false for production
  reference: 'unique_reference',
  webhookUrl: 'https://your-webhook-url.com',
  documentTypeList: [
    DocumentType.bvn,
    DocumentType.nin,
    DocumentType.passport,
    DocumentType.driverLicense,
    DocumentType.pvc,
  ],
  timeoutDurationInSec: 120,
);

if (result?.blusaltFullIdentityProcess == BlusaltFullIdentityProcess.completed) {
  // Success - Access data
  final documentData = result?.fullIdentitySuccessData?.extractedDocumentData;
  final livenessData = result?.fullIdentitySuccessData?.livenessSuccessData;
  
  print('First Name: ${documentData?.firstName}');
  print('Last Name: ${documentData?.lastName}');
  print('Document Number: ${documentData?.documentNumber}');
  print('Liveness Passed: ${livenessData?.isPassProcedureValidation}');
} else {
  // Handle error
  print('Error: ${result?.message}');
}

2. Document Absent with Custom Selector #

Use this when document is not available but user can select document type:

final result = await _fullIdentityPlugin.startDocAbsentWithCustomSelector(
  apiKey: 'your_api_key',
  appName: 'your_app_name',
  clientId: 'your_client_id',
  isDev: true,
  documentTypeList: [
    DocumentType.bvn,
    DocumentType.nin,
  ],
  reference: 'unique_reference',
  webhookUrl: 'https://your-webhook-url.com',
  livenessFacialComparisonType: LivenessFacialComparisonType.motional,
  thresholdInPercent: 85.0, // Optional: 0-100, higher = stricter
  timeoutDurationInSec: 120,
);

// Handle result same as above

3. Document Absent with ID Number #

Use this when you already have the document type and number:

final result = await _fullIdentityPlugin.startDocAbsentWithIdNumber(
  apiKey: 'your_api_key',
  appName: 'your_app_name',
  clientId: 'your_client_id',
  isDev: true,
  documentType: DocumentType.bvn,
  documentNumber: '12345678901',
  reference: 'unique_reference',
  webhookUrl: 'https://your-webhook-url.com',
  livenessFacialComparisonType: LivenessFacialComparisonType.motional,
  thresholdInPercent: 85.0,
  timeoutDurationInSec: 120,
);

// Handle result same as above

Models #

BlusaltFullIdentityResultResponse #

Main response model containing:

• blusaltFullIdentityProcess: Status (completed/notImplemented)
• exception: Exception if any error occurred
• code: Error code if applicable
• message: Error message if applicable
• reference: Your reference string
• fullIdentitySuccessData: Success data containing document and liveness info

FullIdentitySuccessData #

Success data containing:

• extractedDocumentData: Document information
• livenessSuccessData: Liveness check results

ExtractedDocumentData #

Document information:

• firstName: First name from document
• lastName: Last name from document
• middleName: Middle name from document
• phoneNumber: Phone number if available
• email: Email if available
• dateOfBirth: Date of birth
• gender: Gender
• documentNumber: Document ID number
• documentType: Type of document
• imageByte: Base64 encoded image from document

LivenessSuccessData #

Liveness check results:

• isPassProcedureValidation: Overall validation status
• isPassFaceComparison: Face comparison result (for doc-absent flows)
• isPassFaceGenuiness: Face genuineness result
• livenessImage: Base64 encoded liveness image
• originalLivenessImage: Base64 encoded original liveness image
• originalImage: Base64 encoded original image (for comparison)

Enums #

BlusaltFullIdentityProcess #

• completed: Process completed successfully
• notImplemented: Platform not supported or error occurred

DocumentType #

• bvn: Bank Verification Number
• nin: National Identification Number
• passport: International Passport
• driverLicense: Driver's License
• pvc: Permanent Voter's Card

LivenessFacialComparisonType #

• motional: User performs head movements (more secure)
• still: User takes a still photo (faster)

DocumentAvailabilityType #

• present: Physical document available for scanning
• absent: Document not physically available

Parameters #

Common Parameters #

Full Identity SDK Parameters #

Document Absent Parameters #

Error Handling #

try {
  final result = await _fullIdentityPlugin.startFullIdentitySDK(...);
  
  if (result != null) {
    if (result.blusaltFullIdentityProcess == BlusaltFullIdentityProcess.completed) {
      // Success
    } else {
      // Failed
      print('Error Code: ${result.code}');
      print('Error Message: ${result.message}');
    }
  }
} catch (e) {
  print('Exception: $e');
}

Platform-Specific Notes #

Android #

• The plugin uses the native Blusalt Full Identity SDK for Android
• Requires camera, storage, and microphone permissions
• Minimum Android version: API 16 (Android 4.1)

iOS #

• The plugin uses the native Blusalt Full Identity Framework for iOS
• Requires camera and photo library permissions
• Minimum iOS version: 11.0

Permissions #

Android (AndroidManifest.xml) #

The plugin automatically requests these permissions:

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />

iOS (Info.plist) #

Add these keys to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>We need camera access for identity verification</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>We need photo library access for identity verification</string>
<key>NSMicrophoneUsageDescription</key>
<string>We need microphone access for liveness detection</string>

Example #

See the example directory for a complete sample app demonstrating all three SDK modes.

Support #

For issues, questions, or contributions, please contact Blusalt support or visit the Blusalt developer portal.

License #

This plugin is licensed under LICENSE.