Verify Phone Verification Python Django Quickstart

(warning)

Warning

Verify v1 API has reached End of Sale. It 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. v2 has an improved developer experience and new features, including:

Twilio helper libraries in multiple languages
PSD2 Secure Customer Authentication Support
Improved Visibility and Insights

Existing customers will not be impacted at this time until Verify v1 API has reached End of Life. For more information about migration, see Migrating from 1.x to 2.x.

Phone Verification is an important, high-confidence step in a registration flow to verify that a user has the device they claim to have. Adding Twilio Verify to your application to validate new accounts will greatly reduce your number of fraudulent registrations and protect future application users from having their numbers registered by scammers.

This quickstart guides you through creating a Python, Django app that requires a Phone Verification step to create an account. Two channels of Phone Verification are demoed: SMS and Voice.

Ready to add Twilio Verify to a demo app and keep the bad actors away?

Sign Into (or Create) a Twilio Account

Either sign up for a free Twilio trial, or sign into an existing Twilio account.

Create a New Account Security Application

Once logged in, visit the Verify Console. Click on the red 'Create New Application' (or big red plus ('+') if you already created one) to create a new Verify application then name it something memorable.

Twilio will redirect you to the Settings page next:

Click the eyeball icon to reveal your Production API Key, and copy it somewhere safe. You will use the API Key during the application setup step below.

Clone and Setup the Verification Application

Start by cloning our Django repository. Enter the directory and use pip to install all of our dependencies:

pip install -r requirements.txt

Open the file .env.example
Change ACCOUNT_SECURITY_API_KEY to the API Key from the above step
Now, save the file as .env

Enter an Application API Key

Enter the API Key from the Verify console and optionally change the port.

1# You can get/create one here :
2# https://www.twilio.com/console/authy/applications
3ACCOUNT_SECURITY_API_KEY='ENTER_SECRET_HERE'

Run the app migrations to get everything up to date:

./manage.py migrate

That's all the setup you'll need.

Now, launch the application with:

./manage.py runserver

Assuming your API Key is correctly entered, you'll soon get a message that the app is up!

Use the Django Twilio Verify Demo

Keeping your phone at your side, visit the Phone Verification page of the demo at http://localhost:8000/verification/

Enter a Country Code and Phone Number, then choose which channel to request verification over, 'SMS' or 'CALL' (Voice). Finally, hit the blue 'Request Verification' button and wait.

You'll either receive a phone call or an SMS with the verification token. If you requested a phone call, as an additional security feature you may need to interact to proceed (enter a number on the phone keypad).

Phone Verification Start Verification

1from authy.api import AuthyApiClient
2from django.conf import settings
3from django.shortcuts import render, redirect
4
5from .forms import VerificationForm, TokenForm
6
7
8authy_api = AuthyApiClient(settings.ACCOUNT_SECURITY_API_KEY)
9
10
11def phone_verification(request):
12    if request.method == 'POST':
13        form = VerificationForm(request.POST)
14        if form.is_valid():
15            request.session['phone_number'] = form.cleaned_data['phone_number']
16            request.session['country_code'] = form.cleaned_data['country_code']
17            authy_api.phones.verification_start(
18                form.cleaned_data['phone_number'],
19                form.cleaned_data['country_code'],
20                via=form.cleaned_data['via']
21            )
22            return redirect('token_validation')
23    else:
24        form = VerificationForm()
25    return render(request, 'phone_verification.html', {'form': form})
26
27
28def token_validation(request):
29    if request.method == 'POST':
30        form = TokenForm(request.POST)
31        if form.is_valid():
32            verification = authy_api.phones.verification_check(
33                request.session['phone_number'],
34                request.session['country_code'],
35                form.cleaned_data['token']
36            )
37            if verification.ok():
38                request.session['is_verified'] = True
39                return redirect('verified')
40            else:
41                for error_msg in verification.errors().values():
42                    form.add_error(None, error_msg)
43    else:
44        form = TokenForm()
45    return render(request, 'token_validation.html', {'form': form})
46
47
48def verified(request):
49    if not request.session.get('is_verified'):
50        return redirect('phone_verification')
51    return render(request, 'verified.html')

Either way you requested the passcode, enter the token into the Verification entry form and click 'Verify Phone':

Phone Verification Check Verification

1from authy.api import AuthyApiClient
2from django.conf import settings
3from django.shortcuts import render, redirect
4
5from .forms import VerificationForm, TokenForm
6
7
8authy_api = AuthyApiClient(settings.ACCOUNT_SECURITY_API_KEY)
9
10
11def phone_verification(request):
12    if request.method == 'POST':
13        form = VerificationForm(request.POST)
14        if form.is_valid():
15            request.session['phone_number'] = form.cleaned_data['phone_number']
16            request.session['country_code'] = form.cleaned_data['country_code']
17            authy_api.phones.verification_start(
18                form.cleaned_data['phone_number'],
19                form.cleaned_data['country_code'],
20                via=form.cleaned_data['via']
21            )
22            return redirect('token_validation')
23    else:
24        form = VerificationForm()
25    return render(request, 'phone_verification.html', {'form': form})
26
27
28def token_validation(request):
29    if request.method == 'POST':
30        form = TokenForm(request.POST)
31        if form.is_valid():
32            verification = authy_api.phones.verification_check(
33                request.session['phone_number'],
34                request.session['country_code'],
35                form.cleaned_data['token']
36            )
37            if verification.ok():
38                request.session['is_verified'] = True
39                return redirect('verified')
40            else:
41                for error_msg in verification.errors().values():
42                    form.add_error(None, error_msg)
43    else:
44        form = TokenForm()
45    return render(request, 'token_validation.html', {'form': form})
46
47
48def verified(request):
49    if not request.session.get('is_verified'):
50        return redirect('phone_verification')
51    return render(request, 'verified.html')

And with that, your demo app is protected with Twilio's Phone Verification! You can now log out to try the untried channel.

What's Next?

Your demo app is now keeping fraudulent users from registering with your business and polluting your database. Next, check out all of the variables and options available to you in the Phone Verification API Reference. Also, to protect your customers in an ongoing manner (with this same codebase) try the Python Django Authy Two-Factor Authentication Quickstart.

After that, visit the Docs for more Account Security demos and tutorials and web applications using all of Twilio's products.