Stytch Android/com.stytch.sdk.consumer/StytchClient

StytchClient

The StytchClient object is your entrypoint to the Stytch Consumer SDK and is how you interact with all of our supported authentication products.

Properties

biometrics

var biometrics: Biometrics

Exposes an instance of the Biometrics interface which provides methods for detecting biometric availability, registering, authenticating, and removing biometrics identifiers.

bootstrapData

var bootstrapData: BootstrapData

crypto

var crypto: CryptoWallet

Exposes an instance of the CryptoWallet interface which provides methods for authenticating with a crypto wallet

dfp

val dfp: DFP

Exposes an instance of the DFP interface which provides a method for retrieving a dfp_telemetry_id for use in DFP lookups on your backend server

events

val events: Events

isInitialized

val isInitialized: StateFlow<Boolean>

magicLinks

var magicLinks: MagicLinks

Exposes an instance of the MagicLinks interface whicih provides methods for sending and authenticating users with Email Magic Links.

oauth

var oauth: OAuth

Exposes an instance of the OAuth interface which provides methods for authenticating a user via a native Google OneTap prompt or any of our supported third-party OAuth providers

otps

var otps: OTP

Exposes an instance of the OTP interface which provides methods for sending and authenticating One-Time Passcodes (OTP) via SMS, WhatsApp, and Email.

passkeys

var passkeys: Passkeys

Exposes an instance of the Passkeys interface which provides methods for registering and authenticating with Passkeys.

passwords

var passwords: Passwords

Exposes an instance of the Passwords interface which provides methods for authenticating, creating, resetting, and performing strength checks of passwords.

publicToken

lateinit var publicToken: String

The public token that the StytchClient is configured to use

sessions

var sessions: Sessions

Exposes an instance of the Sessions interface which provides methods for authenticating, updating, or revoking sessions, and properties to retrieve the existing session token (opaque or JWT).

totp

var totp: TOTP

Exposes an instance of the TOTP interface which provides methods for creating, authenticating, and recovering TOTP codes

user

var user: UserManagement

Exposes an instance of the UserManagement interface which provides methods for retrieving an authenticated user and deleting authentication factors from an authenticated user.

Functions

canHandle

fun canHandle(uri: Uri): Boolean

A helper function for determining whether the deeplink is intended for Stytch. Useful in contexts where your application makes use of a deeplink coordinator/manager which requires a synchronous determination of whether a given handler can handle a given URL.

configure

fun configure(context: Context, publicToken: String, callback: (Boolean) -> Unit = {})

This configures the API for authenticating requests and the encrypted storage helper for persisting session data across app launches. You must call this method before making any Stytch authentication requests.

getPKCECodePair

fun getPKCECodePair(): PKCECodePair?

Retrieve the most recently created PKCE code pair from the device, if available

handle

suspend fun handle(uri: Uri, sessionDurationMinutes: UInt): DeeplinkHandledStatus

fun handle(uri: Uri, sessionDurationMinutes: UInt, callback: (response: DeeplinkHandledStatus) -> Unit)

Call this method to parse out and authenticate deeplinks that your application receives. The currently supported deeplink types are: Email Magic Links, Third-Party OAuth, and Password resets.