Building the SDK

Creating a CafSmartAuth SDK instance

To create a CafSmartAuth instance, use the CafBuilder class. This class provides a set of methods to configure the SDK instance.

Builder Properties

Property
Type
Description
Required

mobileToken

String

Mobile token provided by the platform.

Builder Methods

Method
Type
Description
Required

setStage(_:)

CAFStage

Defines the environment stage (e.g., .prod, .beta). Default is .prod.

setEmailURL(_:)

URL

Sets the email authentication URL. Must use HTTPS protocol.

setPhoneURL(_:)

URL

Sets the phone authentication URL. Must use HTTPS protocol.

setPlatform(_:)

CafSdkPlatform

Sets the platform on which the SDK is running. Default is .nativeIos.

setLivenessSettings(_:)

CafFaceLivenessSettings

Sets the face liveness authentication settings.

Example

import CafSmartAuth

let smartAuth: CafSmartAuthSdk?

private func setupCafSmartAuth() {
    smartAuth = CafSmartAuthSdk.CafBuilder(mobileToken: "myMFAToken")
        .setStage(.prod)
        .setEmailURL(URL(string: "https://myEmailUrl.com")) // Not mandatory
        .setPhoneURL(URL(string: "https://myPhoneUrl.com")) // Not mandatory
        .setLivenessSettings(
            CafFaceLivenessSettings(
                faceLivenessToken: "myFaceAuthToken",
                useLoadingScreen: false,
                filter: .lineDrawing
            )
        ).build()
}

Last updated

Logo

2023 © Caf. - All rights reserved