Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Verify Ruby on Rails Quickstart


With just a few lines of code, your Rails application can verify phone numbers and add an additional layer of security with Twilio Verify.

This Ruby Verify Quickstart will teach you how to do this using our Verify REST API, the Twilio Ruby helper library, and Ruby on Rails(link takes you to an external page) to ease development.

In this Quickstart, you will learn how to:

  1. Sign up for Twilio
  2. Set up your development environment
  3. Send your first SMS phone verification
  4. Check verification codes
(information)

Info

Short on time? Spin up a low-code, fully editable verification demo in less than 2 minutes using Twilio's Code Exchange and Quick Deploy here(link takes you to an external page).


Sign up for Twilio

sign-up-for-twilio page anchor

If you already have a Twilio account, you're all set here! Feel free to jump to the next step.

Before you can send an SMS from Python, you'll need to sign up for a Twilio account(link takes you to an external page) or sign into your existing account.

You can sign up for a free Twilio trial account here(link takes you to an external page).

  • When you sign up, you'll be asked to verify your personal phone number. This helps Twilio verify your identity and also allows you to send test verification messages to your phone from your Twilio account while in trial mode. This phone verification step is exactly what you'll learn how to build in this tutorial!
  • Once you verify your number, you'll be asked to create a project. For the sake of this tutorial, you can click on the "Learn and Explore" template. Give your project a name, or just click "skip remaining steps" to continue with the default.
  • Once you get through the project creation flow, you'll arrive at your project dashboard in the Twilio Console(link takes you to an external page) . This is where you'll be able to access your Account SID, authentication token, create a verification service, and more.

Do I need a phone number?

do-i-need-a-phone-number page anchor

If you've sent SMS with Twilio in the past, you might remember needing to buy a phone number. With Twilio Verify, we take care of that for you! The Verify API selects the best routes for quickly and reliably delivering verification codes globally.

Verify uses Services for configuration. To send a Verify API request you will need both your Twilio Credentials and a Service SID. You can create and update a Service in two ways:

  1. In the Verify Console(link takes you to an external page)
  2. With the Verify API

Services can be used to edit the name (which shows up in the message template), set the code length (4-10 characters), enable settings like the "do not share warning" and more.

Now that you have a Twilio account and a verification service, you can start writing some code! To make things even easier, we'll next install Twilio's official helper for Ruby applications.


Install Ruby and the Twilio Helper Library

install-ruby-and-the-twilio-helper-library page anchor

If you've gone through one of our other Ruby Quickstarts already and have Ruby and the Twilio Ruby helper library installed, you can skip this step and get straight to sending your first verification.

To start a phone verification, you'll need to have Ruby and the Twilio Ruby helper library installed.

If you're using Mac, you probably already have Ruby installed but an older version. You can use homebrew(link takes you to an external page) to install the latest version using the following command:


_10
brew install ruby

If you're on a Linux machine, you can install it using your default package manager, for example for Ubuntu:


_10
sudo apt-get install ruby-full

For other distributions, you can find the command in this listing(link takes you to an external page).

You can check if Ruby is installed and which version by opening up a terminal and running the following command:


_10
ruby --version

You should see something like:


_10
$ ruby --version
_10
ruby 2.6.3p62 (2019-04-16 revision 67580) [x86_64-darwin18]

Windows users can use RubyInstaller(link takes you to an external page).

Twilio's Ruby SDK supports older versions of Ruby. But for this quickstart, we recommend using at least Ruby 2.3 for compatibility with some of the dependencies used.

Send an SMS verification code

send-an-sms-verification-code page anchor

Sends a one-time passcode to a user's phone number

Ruby

_17
# Download the helper library from https://www.twilio.com/docs/ruby/install
_17
require 'rubygems'
_17
require 'twilio-ruby'
_17
_17
# Find your Account SID and Auth Token at twilio.com/console
_17
# and set the environment variables. See http://twil.io/secure
_17
account_sid = ENV['TWILIO_ACCOUNT_SID']
_17
auth_token = ENV['TWILIO_AUTH_TOKEN']
_17
@client = Twilio::REST::Client.new(account_sid, auth_token)
_17
_17
verification = @client.verify
_17
.v2
_17
.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_17
.verifications
_17
.create(to: '+15017122661', channel: 'sms')
_17
_17
puts verification.status

Output

_23
{
_23
"sid": "VEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23
"service_sid": "VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23
"to": "+15017122661",
_23
"channel": "sms",
_23
"status": "pending",
_23
"valid": false,
_23
"date_created": "2015-07-30T20:00:00Z",
_23
"date_updated": "2015-07-30T20:00:00Z",
_23
"lookup": {},
_23
"amount": null,
_23
"payee": null,
_23
"send_code_attempts": [
_23
{
_23
"time": "2015-07-30T20:00:00Z",
_23
"channel": "SMS",
_23
"attempt_sid": "VLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_23
}
_23
],
_23
"sna": null,
_23
"url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Verifications/VEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_23
}

Check a verification code

check-a-verification-code page anchor

Checks the one-time passcode sent to the user. The provided code is correct if the response 'status' parameter is 'approved'.

Ruby

_17
# Download the helper library from https://www.twilio.com/docs/ruby/install
_17
require 'rubygems'
_17
require 'twilio-ruby'
_17
_17
# Find your Account SID and Auth Token at twilio.com/console
_17
# and set the environment variables. See http://twil.io/secure
_17
account_sid = ENV['TWILIO_ACCOUNT_SID']
_17
auth_token = ENV['TWILIO_AUTH_TOKEN']
_17
@client = Twilio::REST::Client.new(account_sid, auth_token)
_17
_17
verification_check = @client.verify
_17
.v2
_17
.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_17
.verification_checks
_17
.create(to: '+15017122661', code: '123456')
_17
_17
puts verification_check.status

Output

_14
{
_14
"sid": "VEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"service_sid": "VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14
"to": "+15017122661",
_14
"channel": "sms",
_14
"status": "approved",
_14
"valid": true,
_14
"amount": null,
_14
"payee": null,
_14
"sna_attempts_error_codes": [],
_14
"date_created": "2015-07-30T20:00:00Z",
_14
"date_updated": "2015-07-30T20:00:00Z"
_14
}


Clone and Setup the Verification Application

clone-and-setup-the-verification-application page anchor

Start by cloning our Rails repository.(link takes you to an external page)


_10
git clone git@github.com:TwilioDevEd/verify-v2-quickstart-rails.git

If you don't have git installed or prefer to download the source code you can grab a zip file of the project here(link takes you to an external page).

Set up your environment and install dependencies

set-up-your-environment-and-install-dependencies page anchor

You'll need to have bundler(link takes you to an external page) installed in your Ruby environment, simply run the command:


_10
gem install bundler

Once it's installed, you'll be able to install all the quickstart's dependencies by navigating to its directory and running bundler:


_10
cd verify-v2-quickstart-rails
_10
_10
bundle install

Copy .env.example to .env. This is where we'll store sensitive data in environment variables.(link takes you to an external page)


_10
cp .env.example .env

The application will automatically read and load those environments variables from the .env file. Finally, all that's left to do is run the migrations which will prepare an SQLite database automatically for you and start the development server:


_10
rails db:migrate
_10
rails server

If your credentials are set up correctly you'll soon get a message that the app is up!


Use the Rails Twilio Verify Demo

use-the-rails-twilio-verify-demo page anchor

Navigate to http://localhost:3000/register(link takes you to an external page). You should see a registration form that looks like this:

sign up form with phone verification.

Enter your phone number and choose which channel to request verification over. Finally hit the green Sign Up button and wait. You'll either receive a phone call or an SMS with the verification token. If you requested a phone call, as an additional security feature you may need to interact to proceed (the call will tell you to enter a number on the phone keypad).

Enter the token into the Verification entry form and click 'Verify':

verification entry form.

And with that, your demo app is protected with Twilio's Phone Verification!


Your demo app is now keeping fraudulent users from registering with your business and polluting your database. Next, check out all of the variables and options available to you in the Verify API Reference.

After that, check out adding additional verification channels supported by the Verify API like:

(information)

Info

Lastly, to protect your service against fraud, view our guidance on Preventing Toll Fraud when using Verify.


Rate this page: