CafSDK

Last updated 1 month ago

CafSDK

Welcome to the documentation for CafSDK, a unified and modular iOS SDK that provides robust solutions for document detection and face liveness validation.

Overview

CafSDK is a comprehensive iOS SDK that integrates two primary functionalities:

Document Detection: Powered by the framework and TensorFlow Lite.
Face Liveness Validation: Offered via the module, which supports both iProov and FaceTec 2D providers. These providers can be used independently or in combination, giving you the flexibility to tailor the solution to your needs.

This unified approach allows developers to include only the necessary modules, reducing bloat and simplifying integration.

Features

Modularity: Integrate the full SDK or select individual components.
Ease of Integration: Supports both Swift Package Manager and CocoaPods.
Security and Accuracy: Leverages advanced frameworks (e.g., TensorFlow Lite, iProov, FaceTec) for robust document and face validation.
Scalability: Designed for iOS 13.0+ ensuring modern device compatibility.

Requirements

Deployment Info

Version

iOS Target

13.0+

Xcode

15.4+

Swift

5.10+

Installation

Swift Package Manager (SPM)

To add CafSDK using SPM, include the following dependency in your Package.swift file:

dependencies: [
    .package(url: "https://github.com/combateafraude/caf-ios-sdk.git", from: "0.1.1")
]

Then, add the desired products to your app target:

.target(
    name: "YourApp",
    dependencies: [
        .product(name: "CafSDK", package: "CafSDK"),            // Full SDK
        .product(name: "DocumentDetector", package: "CafSDK"),    // Only DocumentDetector
        .product(name: "CafFaceLiveness", package: "CafSDK"),       // Only CafFaceLiveness
        .product(name: "IproovProvider", package: "CafSDK"),        // Optional iProov provider
        .product(name: "FaceTec2DProvider", package: "CafSDK"),     // Optional FaceTec 2D provider
    ]
)

CocoaPods

To install using CocoaPods, add the following to your Podfile:

# Full SDK
pod 'CafSDK'

# Only DocumentDetector
pod 'CafSDK/DocumentDetector'

# Only CafFaceLiveness
pod 'CafSDK/CafFaceLiveness'

# Optional iProov provider
pod 'CafSDK/IproovProvider'

# Optional FaceTec 2D provider
pod 'CafSDK/FaceTec2DProvider'

Usage

To import and use DocumentDetector or CafFaceliveness in your app, add the following import statement at the top of your Swift files:

import DocumentDetector
import CafFaceliveness

Documentation:

Module Architecture

The unified CafSDK is organized into several modular components:

CafSDK: The umbrella module for core functionalities.
DocumentDetector: Provides secure document detection using TensorFlow Lite.
CafFaceLiveness: Manages face liveness validation.
IproovProvider: Integrates the iProov face liveness solution.
FaceTec2DProvider: Integrates the FaceTec 2D face liveness solution.