Phone Auth with Twilio

In this guide we'll show you how to authenticate your users with SMS based One-Time Password (OTP) tokens.

There are two reasons to use Supabase SMS OTP tokens:

You want users to log in with a phone number and password, and verify the phone number on signup with SMS
You want users to log in with a phone number ONLY (i.e. passwordless login)

What you'll need:

Twilio account (sign up)
Supabase project (create one here)
Mobile phone capable of receiving SMS

SMS Authentication can be done with either Twilio Verify or Twilio Programmable Messaging. Twilio Verify is a specialized OTP solution and is recommended for most developers that need over-the-phone authentication. Alternatively you can use Twilio Programmable Messaging which offers generic SMS sending support.

Twilio Verify#

To set up Twilio Verify, you will need to:

Create a new verification service in the Twilio dashboard.
Switch Phone Provider to Twilio Verify
Configure the Twilio Verify Service ID field using the Verification Service ID obtained in 1.

When using Twilio Verify, OTPs are generated by Twilio. This means that:

Unlike other providers, the OTP expiry duration and message content fields are not configurable via the Supabase dashboard. Please head to Twilio Verify to configure these settings.
The token remains the same during its validity period until the verification is successful. This means if your user make another request within that period, they will receive the same token.
Twilio Verify has a separate set of rate limits that apply. Visit Twilio's Rate Limit and Timeouts page to find out more.

caution

At this time, Twilio Verify is only supported on the whatsapp and sms channels.

Twilio (Programmable Messaging)#

In this section we'll cover:

Finding your Twilio credentials
Using OTP with password based logins
Using OTP as a passwordless sign-in mechanism

What you'll need:

A Twilio account (sign up here: https://www.twilio.com/try-twilio)
A Supabase project (create one here: https://supabase.com/dashboard)
A mobile phone capable of receiving SMS

Video#

Steps#

Finding your Twilio credentials#

Start by logging into your Twilio account and starting a new project: https://www.twilio.com/console/projects/create

Give your project a name and verify the mobile number you'll be using to test with. This is the number that will be receiving the SMS OTPs.

Select 'SMS', 'Identity & Verification', and 'With code' as options on the welcome form.

When you're back on the Twilio console screen, you need to scroll down and click 'Get a trial phone number' - this is the number that you'll be sending SMSs from.

You should now be able to see all three values you'll need to get started:

Account SID
Auth Token
Sender Phone Number

Now go to the Auth > Providers page in the Supabase dashboard and select "Phone" from the Auth Providers list (https://supabase.com/dashboard/project/_/auth/providers).

You should see an option to enable Phone Signup:

Toggle it on, and copy the 3 values over from the twilio dashboard. Click save.

Note: for "Twilio Message Service SID" you can use the Sender Phone Number generated above.

Now the backend should be setup, we can proceed to add our client-side code!

SMS custom template

The SMS message sent to a phone containing an OTP code can be customized. This is useful if you need to mention a brand name or display a website address.

Go to Auth > Providers page (under "Configuration") in the Supabase dashboard and select "Phone" from the Auth Providers list (https://supabase.com/dashboard/project/_/auth/providers). Scroll to the very bottom of the "Phone" section to the "SMS Message" input - you can customize the SMS message here.

Use the variable .Code in the template to display the OTP code. Here's an example in the SMS template.

Using OTP with password based logins#

In this scenario we'll be using the user's mobile phone number and a corresponding password as an alternative to signing up with an email address. Note: please thoroughly consider potential security implications when signing up with a combination of phone number and password. Phone numbers are sometimes recycled by phone networks when users cancel their phone contracts or move countries, thereby granting access to the user's account to the subsequent owner of the phone number. In the near future Supabase will support multifactor authentication, which will mitigate this risk, but for now you may want to consider allowing your users to recover their account by some other means in an emergency.

Using supabase-js on the client you'll want to use the same signUp method that you'd use for email based sign ups, but with the phone param instead of the email param:

let { user, error } = await supabase.auth.signUp({
  phone: '+13334445555',
  password: 'some-password',
})

The user will now receive an SMS with a 6-digit pin that you will need to receive from them within 60-seconds before they can login to their account.

You should present a form to the user so they can input the 6 digit pin, then send it along with the phone number to verifyOtp:

let { session, error } = await supabase.auth.verifyOtp({
  phone: '+13334445555',
  token: '123456',
  type: 'sms',
})

If successful the user will now be logged in and you should receive a valid session like:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhdXRoZW50aWNhdGVkIiwiZXhwIjoxNjI3MjkxNTc3LCJzdWIiOiJmYTA2NTQ1Zi1kYmI1LTQxY2EtYjk1NC1kOGUyOTg4YzcxOTEiLCJlbWFpbCI6IiIsInBob25lIjoiNjU4NzUyMjAyOSIsImFwcF9tZXRhZGF0YSI6eyJwcm92aWRlciI6InBob25lIn0sInVzZXJfbWV0YWRhdGEiOnt9LCJyb2xlIjoiYXV0aGVudGljYXRlZCJ9.1BqRi0NbS_yr1f6hnr4q3s1ylMR3c1vkiJ4e_N55dhM",
  "token_type": "bearer",
  "expires_in": 3600,
  "refresh_token": "LSp8LglPPvf0DxGMSj-vaQ"
}

The access token can be sent in the Authorization header as a Bearer token for any CRUD operations on supabase-js. See our guide on Row Level Security for more info on restricting access on a user basis.

Also now that the mobile has been verified, the user can use the number and password to sign in without needing to verify their number each time:

let { user, error } = await supabase.auth.signInWithPassword({
  phone: '+13334445555',
  password: 'some-password',
})

In this scenario you are granting your user's the ability to login to their account without needing to set a password on their account, all they have to do to log in is verify their mobile each time using the OTP.

In javascript we can use the signIn method with a single parameter: phone

let { user, error } = await supabase.auth.signInWithOtp({
  phone: '+13334445555',
})

The second step is the same as the previous section, you need to collect the 6-digit pin from the user and pass it along with their phone number to the verify method:

let { session, error } = await supabase.auth.verifyOtp({
  phone: '+13334445555',
  token: '123456',
  type: 'sms',
})

and the response should also be the same as above:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhdXRoZW50aWNhdGVkIiwiZXhwIjoxNjI3MjkxNTc3LCJzdWIiOiJmYTA2NTQ1Zi1kYmI1LTQxY2EtYjk1NC1kOGUyOTg4YzcxOTEiLCJlbWFpbCI6IiIsInBob25lIjoiNjU4NzUyMjAyOSIsImFwcF9tZXRhZGF0YSI6eyJwcm92aWRlciI6InBob25lIn0sInVzZXJfbWV0YWRhdGEiOnt9LCJyb2xlIjoiYXV0aGVudGljYXRlZCJ9.1BqRi0NbS_yr1f6hnr4q3s1ylMR3c1vkiJ4e_N55dhM",
  "token_type": "bearer",
  "expires_in": 3600,
  "refresh_token": "LSp8LglPPvf0DxGMSj-vaQ"
}

The user does not have a password therefore will need to sign in via this method each time they want to access your service.

WhatsApp OTP Logins#

In some cases, you may wish to use WhatsApp as a delivery channel instead. Here are some examples our users have cited:

You want higher deliverability
You wish for a secure channel
Your users mostly use WhatsApp as a messaging platform

WhatsApp OTPs can be used with Twilio Verify without additional configuration. To make use of WhatsApp OTP with Twilio Programmable Messaging, please complete the following steps:

Go through the Twilio self sign up guide for WhatsApp
Submit a template via the Twilio Guide For Submitting WhatsApp templates

caution

The message template submitted to Twilio must exactly match the SMS Body entered on the Supabase dashboard.

The sign in process with WhatsApp is similar to the sign in process for SMS. Do note the additional whatsapp parameter added:

const { data, error } = await supabase.auth.signInWithOtp({
  phone: '+57336567365',
  options: {
    channel: 'whatsapp',
  },
})

You can also sign up with whatsapp as a channel:

const { data, error } = await supabase.auth.signUp({
  phone: '+57336567365',
  password: 'testsupabasenow',
  options: {
    channel: 'whatsapp',
  },
})

There is no change in the verification process, you should continue to use the sms type for verification

// After receiving a WhatsApp OTP
let { data, error } = await supabase.auth.verifyOtp({
  phone: '+57336567365',
  token: '123456',
  type: 'sms',
})

Resources#

Edit this page on GitHub