Verify Ruby on Rails Quickstart

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 or sign into your existing account.

You can sign up for a free Twilio trial account here.

• 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. This is where you'll be able to access your Account SID, authentication token, create a verification service, and more.

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
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.

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 to install the latest version using the following command:

brew install ruby

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

sudo apt-get install ruby-full

For other distributions, you can find the command in this listing.

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

ruby --version

You should see something like:

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

Windows users can use RubyInstaller.

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.

1
# Download the helper library from https://www.twilio.com/docs/ruby/install
2
require 'rubygems'
3
require 'twilio-ruby'
4

5
# Find your Account SID and Auth Token at twilio.com/console
6
# and set the environment variables. See http://twil.io/secure
7
account_sid = ENV['TWILIO_ACCOUNT_SID']
8
auth_token = ENV['TWILIO_AUTH_TOKEN']
9
@client = Twilio::REST::Client.new(account_sid, auth_token)
10

11
verification = @client
12
               .verify
13
               .v2
14
               .services('VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
15
               .verifications
16
               .create(
17
                 channel: 'sms',
18
                 to: '+15017122661'
19
               )
20

21
puts verification.status

1
{
2
  "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3
  "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5
  "to": "+15017122661",
6
  "channel": "sms",
7
  "status": "pending",
8
  "valid": false,
9
  "date_created": "2015-07-30T20:00:00Z",
10
  "date_updated": "2015-07-30T20:00:00Z",
11
  "lookup": {},
12
  "amount": null,
13
  "payee": null,
14
  "send_code_attempts": [
15
    {
16
      "time": "2015-07-30T20:00:00Z",
17
      "channel": "SMS",
18
      "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
19
    }
20
  ],
21
  "sna": null,
22
  "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
23
}

1
# Download the helper library from https://www.twilio.com/docs/ruby/install
2
require 'rubygems'
3
require 'twilio-ruby'
4

5
# Find your Account SID and Auth Token at twilio.com/console
6
# and set the environment variables. See http://twil.io/secure
7
account_sid = ENV['TWILIO_ACCOUNT_SID']
8
auth_token = ENV['TWILIO_AUTH_TOKEN']
9
@client = Twilio::REST::Client.new(account_sid, auth_token)
10

11
verification_check = @client
12
                     .verify
13
                     .v2
14
                     .services('VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
15
                     .verification_checks
16
                     .create(
17
                       to: '+15017122661',
18
                       code: '123456'
19
                     )
20

21
puts verification_check.status

1
{
2
  "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3
  "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5
  "to": "+15017122661",
6
  "channel": "sms",
7
  "status": "approved",
8
  "valid": true,
9
  "amount": null,
10
  "payee": null,
11
  "sna_attempts_error_codes": [],
12
  "date_created": "2015-07-30T20:00:00Z",
13
  "date_updated": "2015-07-30T20:00:00Z"
14
}

Start by cloning our Rails repository.

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.

You'll need to have bundler installed in your Ruby environment, simply run the command:

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:

1
cd verify-v2-quickstart-rails
2

3
bundle install

Copy .env.example to .env. This is where we'll store sensitive data in environment variables.

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:

1
rails db:migrate
2
rails server

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

Navigate to http://localhost:3000/register. You should see a registration form that looks like this:

Expand image

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':

Expand image

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:

• Email
• TOTP
• Push