IDV Mobile Integration

What is IDV Mobile

IDV (Identity Verification) is the flow that allows verifying and authenticating a person's identity through the capture and validation of biometric traits.

The flow is configured beforehand on the Facephi platform and is executed in the application using its identifier (flowId).

Required dependencies

Below is the list of dependencies for the available components to integrate an IDV Flow in iOS. Install only the capture components that have been licensed.

CocoaPods

// CORE
pod 'FPHISDKMainComponent', '~> $VERSION'
pod 'FPHISDKTrackingComponent', '~> $VERSION'
// COMPONENTES DE CAPTURA
pod 'FPHISDKSelphIDComponent', '~> $VERSION'
pod 'FPHISDKSelphiComponent', '~> $VERSION'
pod 'FPHISDKNFCComponent', '~> $VERSION'
pod 'FPHISDKCaptureComponent', '~> $VERSION'
pod 'FPHISDKVideoRecordingComponent', '~> $VERSION'

Swift Package Manager (SPM)

// CORE
[email protected]:facephi-clienters/SDK-SdkPackage-SPM.git
[email protected]:facephi-clienters/SDK-TrackingPackage-SPM.git
// COMPONENTES DE CAPTURA
[email protected]:facephi-clienters/SDK-SelphidMBSDRComponent-SPM.git
[email protected]:facephi-clienters/SDK-Selphi_component-SPM.git
[email protected]:facephi-clienters/SDK-NFC_component-SPM.git
[email protected]:facephi-clienters/SDK-VideoRecording-SPM.git
[email protected]:facephi-clienters/SDK-CapturePackage-SPM.git

Optional dependencies

The SDK has several libraries that add functionality.

• Status -> Allows the SDK to display tutorial and diagnostic screens for each component, improving the user experience.

• Tokenize -> Some services require the sending of tokenized assets. This library adds the tokenized values to the component's response.

CocoaPods

pod 'FPHISDKStatusComponent', '~> $VERSION'
pod 'FPHISDKTokenizeComponent', '~> $VERSION'

Swift Package Manager (SPM)

[email protected]:facephi-clienters/SDK-StatusPackage-SPM.git
[email protected]:facephi-clienters/SDK-TokenizePackage-SPM.git

Initialize the SDK

The SDK works through a main controller (SDKController), which must be initialized correctly before any Flow can be launched.

Facephi will provide the apiKey license required for initialization.

After successful initialization, the application will have access to all the Flows configured for that project.

SDKController.shared.initSdk(
        licensingUrl: SdkConfigurationManager.LICENSING_URL,
        apiKey: SdkConfigurationManager.APIKEY_LICENSING_IDV,
        output: { sdkResult in
            if sdkResult.finishStatus == .STATUS_OK {
                self.log("Automatic License set correctly")
            } else {
                self.log("An error occurred while trying to obtain the License: \(sdkResult.errorType)")
            }
        },
        trackingController: trackingController,
        tokenizeController: tokenizeController,
        statusController: statusController,
        analyticsOutput: { time, component, type, info  in
            self.log("Analytics: \(Date()) \(component) - \(type) - \(info)")
        })

Launch an IDV flow

The IDV flow is launched using a FlowController, indicating:

• The Flow ID configured on the platform (flowId).

• The Customer ID (customerId).

• The Authentication ID (authenticationId). Only necessary if we are dealing with an authentication Flow.

• The list of controllers that can participate in the process.

Common controller examples:

• SelphiController → Face Capture.

• SelphIDController → Document capture.

• StartVideoRecordingController / StopVideoRecordingController → Process recording.

public func launchFlow(viewController: UIViewController, output: @escaping (SdkFlowResult) -> Void) {
        let selphidController = SelphIDController(data: nil, output: {
            print("SelphidController output: \($0.errorType)")
        }, viewController: viewController)
        
        let selphiController = SelphiController(data: nil, output: {
            print("SelphiController output: \($0.errorType)")
        }, viewController: viewController)
        
        let startVideoRecordingController = VideoRecordingController(viewController: viewController, output: {
            print("videoRecordingController output: \($0.errorType)")
        })
        
        let stopVideoRecordingController = StopVideoRecordingController(videoRecordingController: startVideoRecordingController, output: {
            print("stopVideoRecordingController output: \($0.errorType)")
        })
        
        let controllers: [IFlowableController] =
        [selphidController, selphiController, startVideoRecordingController, stopVideoRecordingController]
        
        let flowConfigurationData = FlowConfigurationData(
            id: 340260c3-0428-41d7-91c7-13c2a122cfc3,
            controllers: controllers,
            customerId: SdkConfigurationManager.customerId,
            authenticationId: authenticationId) // Parámetro opcional
        
        let flowController = SdkConfigurationManager.offlineFlow ? FlowOfflineController(flowConfigurationData: flowConfigurationData, output: output): FlowController(flowConfigurationData: flowConfigurationData, output: output)
        self.flowController = flowController
        SDKController.shared.launch(controller: flowController)
}

Check available flows

If you need to obtain the available flows before launching one of them, use:

SDKController.shared.getFlowIds()

The function returns a list with the Flow identifier and their operation type.