Authy API Samples for User Registration, Send SMS, Voice Call, Token Verification, OneTouch Approval Request, Phone Verification, etc.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.api.env
.gitignore
LICENSE
README.md
api.env.bat
checkRequestStatus.bat
checkRequestStatus.sh
createApprovalRequest.bat
createApprovalRequest.sh
customPhoneVerification.bat
customPhoneVerification.sh
deleteUser.bat
deleteUser.sh
makeCall.bat
makeCall.sh
phoneVerificationCheck.bat
phoneVerificationCheck.sh
phoneVerificationRequest.bat
phoneVerificationRequest.sh
sendSMS.bat
sendSMS.sh
sendSMS_Ignored.bat
sendSMS_Ignored.sh
userRegistration.bat
userRegistration.sh
userStatus.bat
userStatus.sh
verifyToken.bat
verifyToken.sh

README.md

Two-Factor Authentication with Authy REST APIs

Here you will learn how to use the Authy REST APIs to perform the user registration, send SMS, place a voice call, verify the token, etc.

Learn more about the Authy REST APIs.

Quickstart

Create a Twilio account

Create a free Twilio account and access the Authy dashboard.

You can follow the step by step guide provided here.

Setup the environment

Each one of these scripts is designed to run independently and perform the designated functionality specified on the file name.

  1. First clone this repository and cd into it

    $ git clone git@github.com:mjabali/Authy-API-Samples.git
    $ cd Authy-API-Samples
  2. Update the .api.env file if you are on macOS/Linux or the .api.env.bat file with your user/environment/API information and then load the variables into your environment. If you are using macOS or Linux operating systems, just use the source command to load the variables into your environment.

    $ source .api.env

    If you are using Windows, execute the api.env.bat file on a command prompt session to make sure all variables are loaded into your environment. Make sure you have cURL installed before you run any of the sample scripts on Windows.

  3. If you are using macOS or Linux, you might want to install underscore-cli for simple pretty print of the JSON API response. Follow the link here for detailed installation instructions. API responses are piped into underscore-cli for pretty print of the JSON payload.

Run the sample scripts

Before you run any of the following scripts, make sure you have execution permissions based on your operating system.

I'd recommend you to take a look at the API docs for TOTP - Time-based One Time Password, Phone Intelligence, Phone Verification and the Authy OneTouch to get a good understading about what the following scripts do and how they work.

All the API calls described below require that you send the Authy API Key with your request.

  1. User Registration - userRegistration.sh|.bat - Before you can secure a user's login you need to create an Authy user. Authy requires you to send an email, cellphone and country code for the user to be registered. In response you get an Authy ID which you must then store with your user's profile information in your own application/database.

  2. Send SMS & Force Send SMS - sendSMS_Ignored.sh|.bat / sendSMS.sh|.bat - Probably the most common way of doing Two-Factor Authentication is via SMS. While insecure and not providing the best user experience, you can request a SMS message to be sent to the user with the one time passcode. By default, this call will be ignored if the user has downloaded and registered the Authy mobile app against their phone number (sendSMS_Ignored.sh|.bat). This can be overriden using the force=true option (sendSMS.sh|.bat)

  3. Make Phone Call - makeCall.sh|.bat - For users that don't have a smartphone or having trouble receiving one time passcodes via SMS, Authy allows you to use phone calls instead. By default, this call will be ignored if the user has downloaded and registered the Authy mobile app against their phone number. This can be overriden using the force=true option.

  4. Verify Token - verifyToken.sh|.bat - To verify a token simply pass in the token that the user entered and the Authy ID of the user. The Authy API response will tell you if the token is valid or not.

  5. Create OneTouch Approval Request - createApprovalRequest.sh|.bat - To create an OneTouch approval request, send the details in the request to inform the user and control the expiration time. Then, let the user take an action in the Authy mobile app by pressing 'Approve' or 'Deny'. Authy also provides a mobile SDK where you can provide a similar experience with an 100% branded mobile app.

  6. Check OneTouch Request Status - checkRequestStatus.sh|.bat - It's recommended that you use the OneTouch callback (set up in the Authy application console) to your application requesting the approval request but you can also poll for status updates.

  7. Phone Verification - phoneVerificatioRequest.sh|.bat / phoneVerificationCheck.sh|.bat - The Authy Phone Verification API allows you to verify that the user has the device in their possession. The Authy Phone Verification API lets you request a verification code to be sent to the user and also verify that the code received by the user is valid.

  8. Phone Verification with Custom Message - customPhoneVerification.sh|.bat - If you need to overwrite the default Phone Verification message sent to the users you can request Authy to enable custom messages for you. Once enabled, it will allow you to send any text you want with or without the code. You can inject a Phone Verification code in the message by using the string {{code}}.

  9. Delete User - deleteUser.sh|bat - If you want to remove users from your application you can use the delete API. Note, deleting a user will NOT immediately disable token verifications, as a 24 hour delay is typical before the user is permanently removed from the application.

  10. User Status - userStatus.sh|bat - Retrieves user details such as country code, the last 4 digits of the user's phone number, a list of the user's devices, if the user has registered with the Authy mobile app or the Authy Desktop app and if the user has used a valid code before.

That's it!

Meta

  • No warranty expressed or implied. Software is as is.
  • Apache License
  • Lovingly crafted by Authy Solutions Architecture Team.