Rate this page:

Authy API

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.

As part of Twilio's Trusted Activation offerings, the Twilio Authy API makes it simple to add a second factor of authentication or passwordless logins to your web application. It supports OTP sent via voice and SMS, TOTP generated in the free Authy app (or any compatible authenticator app like Google Authenticator) and push authentication via the free Authy app. To start working with the API, first create an application in the console and get the API Key.


All URLs in the reference documentation use the following base URL:

All requests to the Authy REST API are served over HTTPS. Unencrypted HTTP is not supported.

Authy API Keys

All HTTP requests to the Authy REST API /protected endpoints are protected with an API Secret you pass as an HTTP header X-Authy-API-Key, e.g.:

curl '' \
-H "X-Authy-API-Key: $AUTHY_API_KEY"

The API Key can be found in the Authy section of the Twilio Console after clicking through to your Authy application.

Account security API Key

Supported Formats

The Authy API currently supports JSON and XML formats. When making API calls, you will need to specify json or xml format.

Authy Workflow

This guide shows the 3 steps to completing a basic two-factor verification via SMS. Follow the links for more documentation on advanced features such as sending Push Authentications, registering users without needing their phone number or email, PSD2 compliance, and more.

First, create an Authy Application in the Twilio Console and grab the API Key as demonstrated above.

Loading Code Sample...
        The AUTHY_ID from this step is necessary to send One-Time Passwords

        Step 1: Create an Authy User

        The AUTHY_ID from this step is necessary to send One-Time Passwords

        An Authy Application is the set of common configurations used to create and check one-time passcodes and manage push authentications. This includes features like:

        • Application Name (used in the one-time password message templates)
        • Token Length
        • ...and more

        One application can be used to send multiple tokens, it is not necessary to create a new application each time.

        Authy Users documentation.

        Loading Code Sample...

              Step 2: Send an SMS with a One-Time Password

              This will send a token to the end user through the specified channel. Supported channels are sms or call.

              If the user has the Authy App, by default, the API will not send the 2FA code via SMS or voice. Instead, a push notification will go to the device, prompting the user to start their app to get the code. You can override this behavior.

              One-time Password documentation.

              Loading Code Sample...

                    Step 3: Verify the Token

                    This will check whether the user-provided token is correct. The first time you verify a user you will need to force verification to complete the user registration process.

                    Token Success in response Message in response
                    Correct true Token is valid.
                    Incorrect false Token is invalid

                    One-time Password documentation.

                    Authy Helper Libraries

                    We maintain helper libraries to abstract these API calls for all of our standard web languages.

                    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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

                    Loading Code Sample...

                          Thank you for your feedback!

                          Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                          Sending your feedback...
                          🎉 Thank you for your feedback!
                          Something went wrong. Please try again.

                          Thanks for your feedback!