Authy Push Authentications

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

1
# Download the SDK from https://github.com/twilio/authy-python
2
from authy.api import AuthyApiClient
3

4
# Your API key from twilio.com/console/authy/applications
5
# DANGER! This is insecure. See https://twil.io/secure
6
authy_api = AuthyApiClient('api_key')
7

8
details = {
9
    'username': 'Bill Smith',
10
    'location': 'California, USA',
11
    'Account Number': '981266321'
12
}
13

14
hidden_details = {
15
    'transaction_num': 'TR139872562346'
16
}
17

18
logos = [
19
    dict(res='default', url='https://example.com/logos/default.png'), 
20
    dict(res='low', url='https://example.com/logos/low.png')
21
]
22

23
response = authy_api.one_touch.send_request(
24
    authy_id,
25
    "Login requested for a CapTrade Bank account.",
26
    seconds_to_expire=120,
27
    details=details,
28
    hidden_details=hidden_details,
29
    logos=logos)
30

31
if response.ok():
32
    print(response.get_uuid())
33
else:
34
    print(response.errors())

1
{
2
  "approval_request": {
3
    "uuid": "c31f7620-9726-0135-6e6f-0ad8af7cead6"
4
  },
5
  "success": true
6
}

This request generates a push notification that looks like this:

Expand image

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:

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}

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.

Expand image