Skip to main content
Interim hand-authored reference. This page is authored directly from the Seam Android SDK public Kotlin sources. The long-term plan is to generate these pages from KDoc via Dokka.
The Seam Android SDK exposes a reactive, coroutine-friendly API built around StateFlow properties and suspend functions. Use SeamSDK as the single entry point for all SDK operations.

​
Quick Start

// 1. Initialize at app launch (suspend — call from a coroutine)
SeamSDK.initialize(context, "seam_cst_...")

// 2. Activate to begin credential sync
SeamSDK.getInstance().activate()

// 3. Observe credentials
SeamSDK.getInstance().credentials.collect { credentials ->
    // Update your UI
}

​
Classes

SeamSDK

The main entry point for the Seam Android SDK. Manages SDK lifecycle, credential synchronization, unlock operations, and StateFlow-based status updates.

​
Data Classes

SeamCredential

An immutable snapshot of a single access credential — its name, location, expiry, supported unlock proximities, and any active errors.

​
Enumerations

UnlockProximity

The required physical proximity for an unlock attempt: TOUCH, NEARBY, or REMOTE.

​
Sealed Classes

SeamUnlockEvent

Events emitted to the unlockStatus StateFlow as an unlock operation progresses from scanning through access granted, timeout, or reader error.

SeamError

Errors thrown by SeamSDK methods for initialization, activation, credential, and network failures.

SeamCredentialError

Credential-specific errors that appear in SeamCredential.errors or are thrown wrapped in SeamError.CredentialErrors.

SeamRequiredUserInteraction

Actions the user must take to resolve a SeamCredentialError.UserInteractionRequired error — OTP authorization, enabling internet or Bluetooth, or granting permissions.