API Reference

1. MetricFingerprint

Singleton object for UI SDK initialization and configuration.

Methods

Method Name	Arguments	Description
init()	(context, theme, clientKey, secretKey, environment)	Initialize with client credentials
init()	(context, theme, authenticator, environment)	Initialize with custom authenticator
isInitialized()	None	Check if SDK is initialized
reset()	None	Reset SDK configuration

2. FingerprintAuthContract

Activity Result Contract for launching fingerprint authentication flow.

Usage

val launcher = registerForActivityResult(FingerprintAuthContract()) { result ->
    // Handle result
}
launcher.launch(FingerprintAuthRequest(token = "token"))

3. FingerprintAuthRequest

Request data class for launching SDK.

data class FingerprintAuthRequest(
    val token: String  // Verification token (required)
)

4. FingerprintAuthResult

Sealed class for Activity Result.

sealed class FingerprintAuthResult {
    data class Success(
        val name: String,  // Customer name
        val suid: String   // Customer SUID (System User ID)
    ) : FingerprintAuthResult()
    
    data class Error(
        val message: String  // Error message
    ) : FingerprintAuthResult()
    
    object Cancelled : FingerprintAuthResult()
}

5. FingerprintTheme

Theme configuration for UI components

data class FingerprintTheme(
    val companyName: String,  // Company name (required, cannot be blank)
    val logo: Logo,            // Logo source (URL or Drawable)
    val color: String          // Primary color in hex format (required, e.g., "#f7cd46")
)

6. Logo

Sealed class for logo source.

sealed class Logo {
    data class Url(val url: String) : Logo()  // Logo from URL
    data class Drawable(@DrawableRes val drawableRes: Int) : Logo()  // Logo from drawable
}