Sign In via SMS OTP

An SMS OTP (one-time password) is a secure authorization method where a numeric or alphanumeric code is sent to a mobile phone number.

Nhost supports OTP via SMS with Twilio.

Configuration

You need a Twilio account to use this feature because all SMS’ are sent through Twilio.

Enable the Phone Number (SMS) sign-in method in the Nhost Dashboard under Settings -> Sign-In Methods -> Phone Number (SMS).

You need to configure the following:

• Account SID
• Auth Token
• Messaging Service SID (or a Twilio phone number)

Sign In

Signing in users with a phone number is a two-step process:

Request OTP

The user will receive the OTP on the phone number specified.

JavaScript

await nhost.auth.signIn({
  phoneNumber: '+11233213123'
})

Dart

await nhost.auth.signIn(
  phoneNumber: '+11233213123'
)

Sign In with OTP

To sign in the user, pass in the OTP received on the previous step.

JavaScript

await nhost.auth.signIn({
  phoneNumber: '+11233213123',
  otp: '123456'
})

Dart

await nhost.auth.signIn(
  phoneNumber: '+11233213123',
  otp: '123456'
)

Note

A user account is created the first time a phone number is used

Note

Phone numbers should start with + (not 00) to follow the E.164 formatting standard

Other SMS Providers

We only support Twilio for now. If you want support for another SMS provider, please create an issue on GitHub.