caf_sdk

Android 16 compatibility: Updated Flutter plugin to support Android 16 (compileSdk / targetSdk 36), aligning with Google Play requirements for apps targeting recent Android versions.

Full release notes: https://docs.caf.io/caf-sdk/flutter/getting-started-with-the-sdk#caf_sdk-2.2.0

*Fingerprint SDK Upgrade: The underlying FingerprintJS Pro SDK has been updated from version 2.7.0 to 2.15.0.

Full release notes: https://docs.caf.io/caf-sdk/flutter/getting-started-with-the-sdk#caf_sdk-2.1.0

Breaking changes: typed eventStream (Stream<CafResponse>), flattened module configuration classes, and initializeCafSdk now returns Future<bool>.

Full release notes and the 1.x → 2.0.0 migration guide: https://docs.caf.io/caf-sdk/flutter/getting-started-with-the-sdk#caf_sdk-2.0.0

Payface provider updates (Android/iOS) and Face Liveness fixes.

Full release notes: https://docs.caf.io/caf-sdk/flutter/getting-started-with-the-sdk#caf_sdk-1.5.0

Fixes

DocumentDetector: Behavior of the RG (Brazilian National Identity Card) with the digital document option.

Breaking change: Face Liveness providers can now be configured in caf-modules-config.json via livenessProviders (string or array). When provided, it must list valid provider(s). Do not use iproov-lite and iproov-full together—iproov-full uses a different version of Protobuf, and combining them will cause duplicate class errors at build time. PayFace requires iproov-lite (Protobuf JavaLite); pairing PayFace with iproov-full causes build-time Protobuf conflicts.

If omitted, the SDK defaults to iproov-lite on both platforms. An empty or invalid value causes a build error on Android; on iOS, an empty value also falls back to iproov-lite, but an invalid value causes a build failure.

Features

• Configurable Face Liveness providers: Choose iproov-lite, iproov-full, payface, and/or facetec from caf-modules-config.json instead of relying on implicit native defaults.

Updates

• Liveness provider configuration:
  • New livenessProviders field in caf-modules-config.json for Android and iOS.
  • Documented Protobuf JavaLite vs Protobuf Java mapping for iproov-lite vs iproov-full.
  • Clarified multi-provider setups using an array, and the PayFace + iProov Lite requirement.
• iProov Liveness Provider: Documentation and defaults updated to reflect the new provider selection model.
• Android ProGuard / R8: If R8 reports missing classes for lint stubs shipped with the SDK, add the following to proguard-rules.pro:

  -dontwarn com.android.tools.lint.**
  -dontwarn io.caf.sdk.common.jvmshared.lint.**
  

• Updated iProov Liveness Provider: Update iProov provider version.
• Updated iOS minimum deployment target: Updated to 15.0.

Features

• New CafSecurity module: Added a new module with security validations

  • New configuration flag: enableSecurityModule in CafSdkConfiguration with default value true

• PayFace (Fortface) Provider Integration: Optional Face Liveness provider now available

  • New property payFaceDebugMode in CafFaceLivenessConfig to enable debug mode for the PayFace provider.

Fixes

• DocumentDetector

  • Fixed crashes in Document Detector module: Resolved multiple crashes related to activity lifecycle management, including initialization, pause, and resume states.
  • Fixed crashes related to camera lifecycle: Improved camera resource management and thread lifecycle to prevent crashes during SDK shutdown and state transitions.
  • Fixed crashes in UI components: Resolved theme compatibility issues and fragment transaction exceptions to ensure proper UI behavior.
  • Fixed crashes in network requests: Corrected response body handling to prevent errors when reading network responses.
  • Fixed crashes in data access: Improved cursor initialization and validation before accessing database data.
  • Fixed ANR in Document Controller: Optimized document controller instance checks to prevent application not responding issues.
  • Internal improvements and corrections: Additional stability enhancements and bug fixes.

• FaceLiveness

  • Fixed sessions creation erros.
  • Fixed color tint on remote images in the Instructions screen.

Updates

• Proguards rules: Add Payface proguards rules.

Highlights

• First Flutter SDK Release: Complete Flutter implementation of the CAF SDK for identity verification
• Unified SDK: Single package containing all CAF modules (Face Liveness and Document Detector) with both core and UI variants
• Flutter-Native Integration: Seamless integration with Flutter's widget system and state management
• Cross-Platform Support: Full support for both Android and iOS platforms
• Type-Safe Configuration: Strongly typed Dart configuration classes for better development experience

Features

• Module Configuration System:

  • caf-modules-config.json: Configuration file in project root to specify which modules to include
  • Available modules:
    • documentDetector: Enable/disable Document Detector module
    • faceLiveness: Enable/disable Face Liveness module
    • documentDetectorUI: Enable/disable Document Detector UI module
    • faceLivenessUI: Enable/disable Face Liveness UI module
  • Example configuration:

    {
      "documentDetector": true,
      "faceLiveness": true,
      "documentDetectorUI": false,
      "faceLivenessUI": false
    }
    

• Core SDK Features:

  • CafSdk Class: Main SDK class for initialization and configuration
  • Event Stream: Real-time event handling through Dart streams
  • Module Management: Sequential execution of modules with configurable presentation order
  • Error Handling: Comprehensive error types and failure handling
  • Configuration Builder: Type-safe configuration using builder pattern

• Face Liveness Module:

  • Core Module: CafFaceLivenessConfiguration for programmatic control
  • UI Module: CafFaceLivenessUIConfiguration with customizable instruction screens
  • Features: Authentication URLs, certificate pinning, debug mode, retry attempts
  • Customization: Instruction screens with images, titles, descriptions, and steps

• Document Detector Module:

  • Core Module: CafDocumentDetectorConfiguration for programmatic control
  • UI Module: CafDocumentDetectorUIConfiguration with full UI customization
  • Document Types: Support for RG, CNH, Passport, RNE, CTPS, and more
  • Upload Support: File upload with compression, format control, and size limits
  • Proxy Configuration: Support for proxy servers with authentication
  • Message Customization: Customizable user messages throughout the flow

• Advanced Configuration:

  • Color Theming: Complete UI color customization through CafColorConfiguration
  • Security Settings: Development flags, debug mode, and security controls
  • Flow Control: Manual capture, timeouts, retry attempts, and popup controls
  • Instruction Screens: Customizable instruction screens for both modules

Technical Implementation

• Flutter Integration:

  • Method Channels: Native communication through Flutter's method channel system
  • Stream-Based Events: Real-time event handling using Dart streams
  • State Management: Proper lifecycle management with StatefulWidget support
  • Error Handling: Comprehensive error handling with typed exceptions

• Platform Support:

  • Android: Full support with ProGuard/R8 rules and Maven repository configuration
  • iOS: Complete integration with CocoaPods and native iOS modules
  • Permissions: Proper permission handling for camera and network access

• Performance:

  • Selective Module Loading: Only load enabled modules to optimize bundle size
  • Memory Management: Proper resource cleanup and memory management
  • Network Optimization: Efficient network communication with retry mechanisms

Installation and Setup

• Package Installation: Simple installation via flutter pub add caf_sdk
• Module Configuration: Easy module selection through JSON configuration file
• Platform Setup: Clear instructions for Android and iOS platform configuration
• Permission Management: Comprehensive permission setup for both platforms

Documentation

• Complete Examples: Full implementation examples for both basic and advanced usage
• Configuration Guide: Detailed configuration options for all modules
• Event Handling: Comprehensive event handling examples and patterns
• Error Reference: Complete error types and failure scenarios documentation

Breaking Changes

• First Release: This is the first release of the Flutter SDK, so there are no breaking changes from previous versions.

Known Issues

• iOS Simulator: Some features may not work properly in iOS Simulator due to camera limitations
• Android Emulator: Camera-dependent features require physical devices for testing
• Network Requirements: All modules require internet connectivity for proper operation