Skip to main content
All SMS OTP SDK methods require you to initiate an action first. Check out our guide on SMS authentication for more details.

​
Enroll SMS

Start enrollment for a new SMS OTP authenticator by sending the user an SMS containing an OTP code. This method is typically used when you’ve not yet verified the user’s phone number. 
await authsignal.sms.enroll(phoneNumber: "+64270000000")
If you’ve already verified a user’s phone number independently of Authsignal, you can alternatively use a Server SDK to [enroll the user programmatically]/advanced-usage/programmatic-authenticator-management).

​
Parameters

​
phoneNumber
string
The user’s phone number in E.164 format e.g. +14155552671.

​
Response

​
response
AuthsignalResponse<void>

​
Challenge SMS

Start an SMS challenge by sending the user an SMS containing an OTP code. 
await authsignal.sms.challenge()

​
Response

​
response
AuthsignalResponse<void>

​
Verify SMS

Finish enrolling or re-authenticating a new or existing SMS OTP authenticator by verifying the code submitted by the user. 
await authsignal.sms.verify(code: "123456")

​
Parameters

​
code
string
The OTP code inputted by the user.

​
Response

​
response
AuthsignalResponse<VerifyResponse>
​
data
VerifyResponse