Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
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?

Authy Push Authentications

Before sending a One-Time Password:

  1. Create an Authy Application (see Applications documentation)
  2. Create a User (see Users documentation)

Push authentication offers seamless user experience for second-factor and passwordless authentication and offers the highest level of cryptographic security. All requests are fully encrypted, end to end and allow for non-repudiated transactions.

For users with the ability to install an app on their mobile device or computer, these ApprovalRequests can be sent and verified through our REST API. For information on other channels such as SMS or soft tokens, see the Authy API One-time Passwords documentation.

Create an Approval Request

This will create a new approval request for the given Authy ID and send it to the end user along with a push notification to the Authy Mobile app(s), Desktop app(s), and any SDK-driven apps. Only the subject of the transaction is sent through Google or Apple push channels. If push notifications fail or delay, the user can still retrieve pending transactions by opening the Authy app or an SDK app manually.

POST https://api.authy.com/onetouch/{FORMAT}/users/{AUTHY_ID}/approval_requests

URL

Name Type Description
FORMAT String The format to expect back from the REST API call. json, or xml.
AUTHY_ID Integer The Authy ID of the user to send a Push Authentication. Create an Authy ID by registering a user.

Parameters

Name Description
message
String
Shown to the user when the push notification arrives. (📇 PII )
details
Hash (optional)
Dictionary containing any ApprovalRequest details you'd like to present to the user to assist their decision to approve or deny a transaction. We automatically add a timestamp to transactions. See below for an example on how to use details. (📇 PII )
hidden_details
Hash (optional)
Dictionary containing the approval request details hidden to user. This information will be preserved in transaction records but not presented to the user, so it may be useful for your business logic and routing. (📇 PII )
logos
Hash (optional)
A dictionary containing override logos that will be shown to user in the push authentication transaction details. By default, we send the logos uploaded through the console. (🏢 not PII )
seconds_to_expire
Integer (optional)
The number of seconds a transaction is valid without user response (pending) before expiring. Defaults to 86400 (one day); 0 will never expire. This should not be set too low as users need time to evaluate a request. (🏢 not PII )

Response

Name Description
approval_request
Hash
Hash containing the keys & values for the ApprovalRequest. (📇 PII )
uuid
String
Unique transaction ID of the ApprovalRequest. You'll need the uuid to query the request status or tie future callbacks to this ApprovalRequest. (🏢 not PII )
created_at
Datetime
The date and time that we created the ApprovalRequest. (🏢 not PII )
status
String
Tracks the current state of the ApprovalRequest between pending a user response, approved, denied, or expired. (🏢 not PII )
        
        
        
        

        This request generates a push notification that looks like this:

        Authy push authentication request from Cap Trade bank

        Use a Custom Logo in an Approval Request

        By default, all the ApprovalRequests created will be shown to the user using the logo defined in your application in the console. However, you can provide a custom image at the time of the request.

        The logos parameter is expected to be an array of objects, each object with two fields: res (for resolution) and url (the location where you host your logo). If you include the logos parameter, we expect it to include a res with value default.

        Options for the res field are:

        default fallback logo if logo for device resolution is not provided
        low for devices with low resolution
        med for devices with medium resolution
        high for devices with high resolution

        All image URLs must be served over HTTPS and not HTTP. Due to mobile platform restrictions, image requests must be over a secure channel.

        Check Approval Request Status

        There are two ways for you to check on ApprovalRequest status. You can poll the endpoint below for the status of an ApprovalRequest or you can use a webhook callback. Polling is the quickest way to get started using and testing the endpoint.

        In order to implement polling, you can hit the following endpoint repeatedly until the status changes. We suggest polling once per second for the best user experience.

        GET https://api.authy.com/onetouch/{FORMAT}/approval_requests/{PUSH_UUID}
        

        URL

        Name Description
        FORMAT
        String
        The format to expect back from the REST API call. json or xml.
        PUSH_UUID
        UUID
        The approval request ID. (Obtained from the response to an ApprovalRequest) (🏢 not PII )

        Response

        Name Description
        approval_request
        Hash
        Hash containing the status of the approval request and other attributes as you can see in the example below. Possible values of nested status key are pending, expired, approved, or denied. "device" key only included in response when status is approved or denied. (📇 PII )
              
              
              
              

              Push Authentication Callbacks

              In your final application, we recommend exposing a URL to Twilio and using webhooks. With a webhook, we will call your URL immediately when a user reacts to an ApprovalRequest. Webhooks are a more scalable solution than polling. For redundancy you can implement both webhook callbacks and long-polling.

              Learn more about how to validate incoming Twilio Authy API requests and how to implement Authy Webhooks. You can set a callback URL in the Push Authentication tab of your Authy Application in the console.

              Authy push authentication callback in console settings

              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.