Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Send Email Verifications with Authy and Twilio SendGrid


(warning)

Warning

As of November 2022, Twilio no longer provides support for Authy SMS/Voice-only customers. Customers who were also using Authy TOTP or Push prior to March 1, 2023 are still supported. The Authy API is now closed to new customers and will be fully deprecated in the future.

For new development, we encourage you to use the Verify v2 API.

Existing customers will not be impacted at this time until Authy API has reached End of Life. For more information about migration, see Migrating from Authy to Verify for SMS(link takes you to an external page).

Here's your checklist for setting up your account to send email verifications with Authy and SendGrid. Detailed instructions for each step are included below.

  1. [SendGrid] Create or log in to your SendGrid account
  2. [SendGrid] Create a SendGrid API Key
  3. [SendGrid] Set up domain authentication
  4. [SendGrid] Create an email template
  5. [Authy] Create an Authy application(link takes you to an external page)
  6. [Authy] Create an email integration and connect to your Authy application
  7. [Authy] Create an Authy user
  8. [Authy] Send an email verification code
  9. [Authy] Check an email verification code

The initial configuration in Steps 1-6 only needs to be done once. You can then use your email-configured Authy application to send verification emails through the API.

Set up your SendGrid account

set-up-your-sendgrid-account page anchor

Create a SendGrid account(link takes you to an external page) or log in to your existing account(link takes you to an external page). Email verifications use the SendGrid transactional email API.

Create a SendGrid API Key

create-a-sendgrid-api-key page anchor

Next, Create a SendGrid API Key(link takes you to an external page) via the API or in the SendGrid dashboard

(warning)

Warning

We strongly recommend generating SendGrid API Keys with limited scopes(link takes you to an external page).

Create an API Key in one of two ways:

Option 1: Create an API Key with the SendGrid API(link takes you to an external page).

Option 2: Create an API Key in the SendGrid UI(link takes you to an external page). For permissions, select "Restricted Access" and choose the following limited scopes:

Access DetailsAccess Level
Mail Send (nested under Mail Send category)Full Access
Scheduled Send (nested under Mail Send category)No Access
Template EngineRead Access
(information)

Info

Save your SendGrid API Key - you'll need it to set up your verification email integration.

Set up Domain Authentication

set-up-domain-authentication page anchor

Domain authentication allows you to send an email from your company's domain without "via sendgrid.net". Head over to the SendGrid docs to learn about how to set up domain authentication(link takes you to an external page) then authenticate your domain in the SendGrid dashboard.(link takes you to an external page)

(warning)

Warning

It can take up to 48 hours for the records to verify after you upload them into your DNS host. You can still continue set-up and testing while domain authentication is pending by using Single Sender Verification(link takes you to an external page). Single sender verification allows you to send from a single email address that you confirm ownership of by clicking a verification link in the email's inbox. Read Sender Identity(link takes you to an external page) for more information on the differences between domain authentication and single sender verification.

Create an Email Template

create-an-email-template page anchor

Navigate to the SendGrid Dynamic Templates page(link takes you to an external page) and create a new template. In this process you will name and create or select a design for your template. For more information on creating and working with dynamic templates, reference the SendGrid documentation(link takes you to an external page).

Use at least one of the first three variables below to include the verify code in your email template.

Available VariablesDescription
{{twilio_code}}The 4-10 digit numeric One Time Passcode. OTP only, no descriptive text.
{{twilio_message}}Contains both internationalized descriptive text and OTP. i.e. "Your MyServiceName verification code is: 123456" or "Su codigo de verificacion para MyServiceName es: 123456" . Default language is English, override language using the Locale parameter.
{{twilio_message_without_code}}Contains the internationalized descriptive text only. i.e. "Your MyServiceName verification code is" or "Su codigo de verificacion para MyServiceName es" .
{{twilio_service_name}}[Optional] the Friendly Name of the Service.

Find Template ID

find-template-id page anchor

You can find a list of your templates and their unique IDs on the SendGrid Dynamic Templates page(link takes you to an external page). A template ID is 64 characters with one dash (d-uuid) and is required for creating a Verify email integration.

(information)

Info

Need template design help? Check out SendGrid's free and open source library of transactional email templates for robust and responsive designs: https://sendgrid.com/blog/open-source-transactional-email-templates/(link takes you to an external page)

Example SendGrid HTML Template with variables

example-sendgrid-html-template-with-variables page anchor

_40
<html>
_40
<head>
_40
<style type="text/css">
_40
body, p, div {
_40
font-family: Helvetica, Arial, sans-serif;
_40
font-size: 14px;
_40
}
_40
a {
_40
text-decoration: none;
_40
}
_40
</style>
_40
<title></title>
_40
</head>
_40
<body>
_40
<center>
_40
<p>
_40
Example 1 - just the code (no localization in the message):
_40
</p>
_40
<p>
_40
The verification code is: <strong>{{twilio_code}}</strong>
_40
</p>
_40
<p>
_40
Example 2 - use the code in a clickable link to trigger a verification check:
_40
</p>
_40
<p>
_40
<a href="https://your-company.com/signup/email/verify?token={{twilio_code}}"
_40
style="background-color:#ffbe00; color:#000000; display:inline-block; padding:12px 40px 12px 40px; text-align:center; text-decoration:none;"
_40
target="_blank">Verify Email Now</a>
_40
</p>
_40
<p>
_40
Example 3 - entire localized message and code:
_40
</p>
_40
<p>
_40
<strong>{{twilio_message}}</strong>
_40
</p>
_40
<p><a href="https://sendgrid.com/blog/open-source-transactional-email-templates/">Check out more templates</a></p>
_40
<span style="font-size: 10px;"><a href=".">Email preferences</a></span>
_40
</center>
_40
</body>
_40
</html>

This will produce an email that looks like:

verify email template.
(information)

Info

We recommend using "email preferences" instead of "unsubscribe" for transactional emails like these. Read more: Should you include an unsubscribe link in your transactional email messages?(link takes you to an external page)


Create an Authy email integration

create-an-authy-email-integration page anchor

Head to the Email Integration(link takes you to an external page) section of the Twilio Authy console and click the red button to create a new integration. Name your integration, this can be changed later. Fill in:

Connect your email integration to your Authy application in one of two ways:

Option 1: From your email integration, check the applications[s] you want to associate with that email integration. A single email integration can be used for multiple services.

select authy application email integration.

OR

Option 2: From the settings tab on your Authy application in the Twilio console, select the email integration. Each Authy application can only have one email integration.

Email Integration select from verify service.

Send an email verification

send-an-email-verification page anchor

Now the exciting part! Send your first email verification with the following code:

Send a one-time passcode via email

send-a-one-time-passcode-via-email page anchor
curl

_10
# create a user first to get their Authy ID
_10
# https://www.twilio.com/docs/authy/api/users
_10
_10
curl -i -XPOST "https://api.authy.com/protected/json/email/{AUTHY_ID}" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9"

Output

_10
{
_10
"success": true,
_10
"message": "Email token was sent",
_10
"email": "recipient@foo.com",
_10
"email_id": "EMa364aa751cc280d8c22772307e2c5760"
_10
}


Emails will always be sent to the email you provided when you added the user to your Application. If you added the user without providing email and phone number you will need to provide one.

To update an email you need the following code:

curl

_10
curl -X POST "https://api.authy.com/protected/json/users/{AUTHY_ID}/update" \
_10
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9" \
_10
--data-urlencode email="newemail@domain.com" \

Output

_10
{
_10
"message": "User was updated successfully",
_10
"success": true
_10
}


Rate this Page: