Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Verify API (Beta)

Twilio's new Verify API is currently available as a Public Beta product. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Public Beta products are not covered by a Twilio SLA.

As part of Twilio's account security offerings, the Twilio Verify API makes it simple to add phone verification to your web application. It supports codes sent via voice and SMS.

Base URL

All URLs referenced in the documentation have the following base:

https://verify.twilio.com/v2/

The Twilio REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

Authentication

HTTP requests to the REST API are protected with HTTP Basic authentication. To learn more about how Twilio handles authentication, please refer to our security documentation. In short, you will use your Twilio account SID as the username and your auth token as the password for HTTP Basic authentication.

curl -XPOST https://verify.twilio.com/v2/Services \
    -d FriendlyName=MyServiceName \
    -u '[YOUR ACCOUNT SID]:[YOUR AUTH TOKEN]'

You can find your account SID and auth token in your console.

Phone Verification Workflow

There are 3 steps to completing a phone verification:

1. First, Create a Verification Service

Create a Service in one of two ways:

  1. In the Twilio Verify Console
  2. Using the API

A Verification Service is the set of common configurations used to create and check verifications. This includes features like:

  • Friendly Name (used in the Verification message templates)
  • Code Length
  • ...and more

2. Using your Service SID from Step 1, Send a Verification Token

This will send a token to the end user through the specified channel (e.g. SMS).

3. Check the Verification Token

This will check whether the user-provided token is correct.

Check out the linked docs to try it for yourself!

We're actively looking to improve our new Verify API and its documentation. If you have any thoughts, comments, questions, or feedback, rate this page and leave us a note. We really do read these!

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.