Skip to main content

PyPI version Build Status

Python Client for Twilio Authy Two-Factor Authentication (2FA) API

Documentation for Python usage of the Authy API lives in the official Twilio documentation.

The Authy API supports multiple channels of 2FA:

  • One-time passwords via SMS and voice.
  • Soft token (TOTP via the Authy App)
  • Push authentication via the Authy App

If you only need SMS and Voice support for one-time passwords, we recommend using the Twilio Verify API instead.

More on how to choose between Authy and Verify here.

Authy Quickstart

For a full tutorial, check out either of the Python Authy Quickstarts in our docs:

Authy Python Installation

Install with pip:

$ pip install authy

OR

Download the source code and run the following command from your terminal:

$ python setup.py install

Note that you may need admin permissions to run the above commands.

Usage

To use the Authy client, import AuthyApiClient and initialize it with your production API Key found in the Twilio Console:

from authy.api import AuthyApiClient
authy_api = AuthyApiClient('your_api_key')

authy api key in console

2FA Workflow

  1. Create a user
  2. Send a one-time password
  3. Verify a one-time password

OR

  1. Create a user
  2. Send a push authentication
  3. Check a push authentication status

Phone Verification

Phone verification now lives in the Twilio API and has Python support through the official Twilio helper libraries.

Legacy (V1) documentation here. Verify V1 is not recommended for new development. Please consider using Verify V2.

Contributing

Install development dependencies with pip:

sudo pip install -r requirements.txt

To run tests:

make test

or

make testfile tests/<test_case_file>

Copyright

Copyright (c) 2011-2020 Authy Inc. See LICENSE for further details.

Metadata

Release files for authy 2.2.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for authy 2.2.6
File Size Uploaded
authy-2.2.6.tar.gz 11.0 kB Details

Release files / authy-2.2.6.tar.gz

Download URL authy-2.2.6.tar.gz
Size 11.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1b0e28e5cadaa6979e33cf0d335d2a0594e681b17d8cf7e915ee71d065764442
BLAKE2b-256 checksum
How to use checksums
2347d9ac2aefe1281135ad8b9d22a3e60ceedbd4c3b0445288d9a343204bde1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/2.7.15

Release history Release notifications | RSS feed

This release

2.2.6 This release

1 release file

2.2.5

1 release file

2.2.4

1 release file

2.2.3

1 release file

2.2.2

1 release file

2.2.1

1 release file

2.2.0

1 release file

2.1.5

1 release file

2.1.4

1 release file

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.0.0

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page