Stytch Android/com.stytch.sdk.b2b.otp/OTP/SMS

SMS

interface SMS

Provides all possible ways to call SMS OTP endpoints

Types

Link copied to clipboard
data class AuthenticateParameters(val organizationId: String, val memberId: String, val code: String, val setMFAEnrollment: SetMFAEnrollment? = null, val sessionDurationMinutes: UInt = Constants.DEFAULT_SESSION_TIME_MINUTES)

A data class wrapping the parameters needed to authenticate an SMS OTP

Link copied to clipboard
data class SendParameters(val organizationId: String, val memberId: String, val mfaPhoneNumber: String? = null, val locale: String? = null)

A data class wrapping the parameters needed to send an SMS OTP

Functions

Link copied to clipboard
abstract suspend fun authenticate(parameters: OTP.SMS.AuthenticateParameters): SMSAuthenticateResponse
abstract fun authenticate(parameters: OTP.SMS.AuthenticateParameters, callback: (SMSAuthenticateResponse) -> Unit)

Authenticate a one-time passcode (OTP) sent to a user via SMS.

Link copied to clipboard
abstract suspend fun send(parameters: OTP.SMS.SendParameters): BasicResponse
abstract fun send(parameters: OTP.SMS.SendParameters, callback: (BasicResponse) -> Unit)

Send a one-time passcode (OTP) to a user using their phone number via SMS.