Get Started

// Enable core library desugaring in your build.gradle
android {
    compileOptions {
        coreLibraryDesugaringEnabled true
        // other compile options if any
    }
}

dependencies {
    implementation project(path: ':liveness-release')
    implementation 'com.amplifyframework:core:2.30.1'
    implementation 'com.amplifyframework.ui:liveness:1.7.1'
    implementation 'androidx.compose.material3:material3:1.4.0'
    implementation 'androidx.compose.material:material-icons-extended:1.7.8'
    implementation 'com.amplifyframework:aws-auth-cognito:2.30.1'
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.5'
}

// 1. Create LivenessTestConfig with your access token and service URL
LivenessTestConfig config = new LivenessTestConfig(
    Provider.V2,
    "https://d1.cynopsis.co/service",
    1L, // your domain ID
    "YOUR_ACCESS_TOKEN"
);

// 2. Setup LivenessOnLoad callback to handle SDK ready or failure state
LivenessOnLoad livenessOnLoad = new LivenessOnLoad() {
    @Override
    public void succeed(String message) {
        // SDK initialized successfully
        setLivenessCustomization();
    }

    @Override
    public void failed(String message) {
        // SDK initialization failed
    }
};

// Initialize the LivenessTest
LivenessTest liveness = new LivenessTest(this, config, livenessOnLoad);

// 3. Start liveness detection with custom delegate to receive results
LivenessTestDelegate livenessTestDelegate = new LivenessTestDelegate() {
    @Override
    public void onResponse(LivenessTestResults response) {
        switch (response.getStatus()) {
            case PASSED:
                // Success: handle result
                break;
            case ERROR:
            case FAILED:
                // Handle error or failed attempt
                break;
        }
    }
};
liveness.startLiveness(livenessTestDelegate);

// 4. Customization color (optional)
private void setLivenessCustomization() {
    LivenessV2Customization customization = new LivenessV2Customization().getDefault();

    customization.setBackground(0xFFf2e8cf);
    customization.setPrimary(0xffbc4749);
    customization.setOnPrimary(0xFFf2e8cf);
    customization.setOnBackground(0xffbc4749);

    LivenessTestV2GlobalState.setCustomization(customization);
}

import Liveness

class ViewController: UIViewController {

    // 1. Prepare session credentials and configuration
    let credentials = LivenessCredentials(
        serviceBaseUrl: "YOUR_SERVICE_BASE_URL",      // e.g. "https://util.cynopsis.co/service"
        accessToken: "YOUR_ACCESS_TOKEN",             // OAuth token from onboarding
        domainId: "YOUR_DOMAIN_ID",                   // Provided by Cynopsis
        provider: "V2"                                // Use "V2"
    )

    // 2. (Optional) Set up color customization
    func customColorConfig() -> LivenessColorConfiguration {
        let config = LivenessColorConfiguration()
        config.background = 0xFFf2e8cf
        config.primary = 0xffbc4749
        config.onPrimary = 0xFFf2e8cf
        config.onBackground = 0xffbc4749
        return config
    }

    // 3. Start liveness detection and handle results
    func startLivenessCheck() {
        _ = LivenessTestV2Processor(
            fromVC: self,
            config: credentials,
            complete: { result in
                switch result.status {
                case .PASSED:
                    // Success: handle result
                    print("Liveness passed: \(result)")
                case .FAILED, .ERROR:
                    // Handle failed attempt or error
                    print("Liveness failed: \(result.message ?? "Unknown error")")
                default:
                    break
                }
            },
            customization: customColorConfig()
        )
    }
}