Stytch Consumer SDK/com.stytch.sdk.consumer/StytchConsumer

StytchConsumer

interface StytchConsumer : StytchClient

The main entry point for the Stytch Consumer SDK.

Properties

authenticationStateFlow

abstract val authenticationStateFlow: StateFlow<ConsumerAuthenticationState>

A StateFlow that emits the current authentication state whenever it changes.

abstract val biometrics: BiometricsClient

Biometric authentication.

abstract val crypto: CryptoClient

Crypto wallet authentication.

abstract val dfp: DFPClient

Device fingerprinting (DFP) integration.

abstract val magicLinks: MagicLinksClient

Magic link authentication.

abstract val oauth: OAuthClient

OAuth authentication (browser-based and native provider flows).

abstract val otp: OtpClient

OTP (one-time passcode) authentication via SMS, email, or WhatsApp.

abstract val passkeys: PasskeysClient

Passkey (WebAuthn) authentication.

abstract val passwords: PasswordsClient

Password-based authentication.

abstract val session: SessionClient

Session management.

abstract val totp: TOTPClient

TOTP (time-based one-time passcode) authentication.

abstract val user: UserClient

User account management.

Functions

abstract suspend fun authenticate(url: String, sessionDurationMinutes: Int?): DeeplinkAuthenticationStatus

Authenticates a Stytch deeplink URL, dispatching to the appropriate auth method based on the token type embedded in the URL. Returns DeeplinkAuthenticationStatus.ManualHandlingRequired for password reset tokens, which must be handled by the caller.

authenticationStateObserver

abstract fun authenticationStateObserver(callback: (authenticationState: ConsumerAuthenticationState) -> Unit): JsCleanup

Registers a callback that is invoked whenever the authentication state changes. Returns a JsCleanup that stops the observer when JsCleanup.stop is called.

getPKCECodePair

abstract suspend fun getPKCECodePair(): PKCECodePair?

Returns the current PKCE code pair if one has been generated and not yet consumed.

abstract suspend fun hydrate(sessionToken: String)

Hydrates a session from a given session token

abstract fun parseDeeplink(url: String): DeeplinkToken?

Parses a URL and returns the Stytch token it contains, or null if the URL is not a recognized Stytch deeplink.