Verify Push is in Public Beta.
Twilio Verify Push SDK helps you verify users by adding a low-friction, secure, cost-effective, "push verification" factor into your own mobile application. It works by registering your user's iOS devices as a secure key via public-key cryptography. When your app backend needs to verify that the user is who they say they are, you challenge the user to prove that they still possess their secure key (iOS device).
In short order, you can run the Verify Push iOS SDK in your existing iOS app and verify a user via push verification using Verify Push API.
This Verify Push Quickstart will walk you through the entire process step-by-step, starting with setting up your Twilio account all the way through verifying a user using your existing iOS app and backend.
In this Quickstart, you will learn how to:
- Sign up for Twilio
- Configure Push Credential and Verify Service
- Embed the client SDK into your iOS app
- Setup your app backend
- Register a user and their device in Verify Push
- Configure webhooks
- Verify a user
By the end of this Quickstart, you’ll have a solid foundation for implementing Verify Push within your iOS app and backend for your specific use cases.
Want a technical overview first?Technical Overview
Check out the Verify Push SDK Technical Overview to view its data model, sequence diagrams, and security FAQs.
Want to see an example?Run Sample App
Want to start with Android?Android Quickstart
Add Verify Push to your Android app with the Android SDK quickstart.
You can sign up for a free Twilio trial account here.
- When you sign up, you'll be asked to verify your personal phone number. This helps Twilio verify your identity.
- Once you verify your number, you'll be asked to create a project. For the sake of this tutorial, you can click on the "Learn and Explore" template. Give your project a name, or just click "skip remaining steps" to continue with the default.
- Once you get through the project creation flow, you'll arrive at your project dashboard in the Twilio Console. This is where you'll be able to access your Account SID, an authentication token, create a Push Credential, create a Verify Service and more.
For Verify Push to send push notifications to your iOS app, you will need to create an Apple Push Notification (APN) Push Credential that contains your APN certificate and private key. Follow these steps to do it in the Twilio Console.
Do you need to set up APNs for your iOS app? Follow these step-by-step directions for Configuring iOS Push Notifications to setup your project with APNs.
- Click the
+button to add a new credential and a form will pop-up:
- Enter a friendly name, such as "Verify Quickstart App Credentials"
APN push credentialsas type
- Enter the
Certificate and Private key.
- Check the sandbox option if it is for sandbox APNs
- Click the
- Note: Although Verify Push uses Twilio Notify for sending push notifications, you do not need to create your own Notify Service
- Go to Twilio Console > Verify > Services and create a new Service:
- Alternatively, you can select any existing Service. For this quickstart, select a Service that isn't being used in production right now (e.g. not actively sending SMS OTPs to your users) so that you don't accidentally cause a production issue.
- Go to the Service's Settings and select the Credential SID(s) that you want this Service to use for sending push notifications. One SID can be selected for your Android app (FCM) and one for your iOS app (APN). For web apps, select the FCM credential SID:
Follow the installation steps in the README file of the Twilio Verify iOS repo. The installation steps will explain how to add the iOS library to your project and setup your iOS app to work with Apple Push Notification service (APNs).
You should already have access to this repo, but if you don't, contact your Verify Push Private Beta program manager to request access.
After you import the Twilio Verify iOS library, you can start to integrate your existing app with Verify Push.
To get started, you will need to create an instance of the
TwilioVerify class, using its
Builder. Do this by typing or pasting in the code sample.
The SDK should be used from a Swift class.
Your iOS app needs to obtain an Access Token (technically an Enrollment JWE, similar to a JSON Web Token (JWT)) to make direct requests to the Verify Push API in the future. This Access Token request needs to be brokered by your app backend. To do this, you need to:
1. Expose an API endpoint in your app backend for your iOS app to request the Access Token
2. Have your app backend request an Access Token from Verify Push API
3. Return the Access Token,
Verify Service SID to the iOS app
Check out our Sample Node.js Backend for an implementation example. In a production web application, you would restrict access token retrieval to the currently authenticated user, using whatever type of authentication your service already uses.
In the sidebar to the right (or below) is sample code for requesting an access token from the Verify Push API in all languages supported by Twilio helper libraries. You will need the Verify
service_sid, as well as the user id (such as a GUID or the user's primary key in your database table) you use as the
identity with this Verify service.
Do not use Personally Identifiable Information for
identity. Use an immutable user identifier like a UUID, GUID, or SID.
Verify Push uses
identity as a unique identifier of a user. You should not use directly identifying information (aka personally identifiable information or PII) like a person's name, home address, email or phone number, etc., as
identity because the systems that will process this attribute assume it is not directly identifying information.
Both steps are done simultaneously by creating a factor from a factor payload, and verifying the factor. Do this by typing or pasting in the code samples.
Configure a webhook callback for your app backend to be notified of events such as when a
Factor has been verified or when a
Challenge has been approved, so that it knows to advance the user to the next step in your flow. This is more real-time and efficient than constantly polling the Verify Push API for the
status of a
Follow the steps in this Verify Webhooks page.
Congratulations! Verify Push consists of two user sequences, and you've just completed the first one: user and device registration. The second sequence is to challenge and verify (authenticate) a user with their registered device. Read on for the step-by-step instructions.
Your web application backend needs to call the Verify Push API to create a
Challenge using the
Factor that you've just created. When the challenge is created, Verify Push sends a push notification to the registered device using the configured Push Credential.
The code in the sidebar to the right/bottom demonstrates how to create those challenges using the Twilio helper libraries.
You may choose to put Personally Identifiable Information (PII) or other sensitive information in
hidden_details. The data in each param will be stored per its retention policy listed in the
Your iOS app needs to read the contents of the push notification payload to obtain the
Typically, you would do this either directly in the
AppDelegate class, or you would create a new class that handled incoming push notifications that you reference in your
The following code sample runs when there is an incoming push notification, and if the type is
verify_push_challenge, reads the parameters out of the notification.
Once your app receives the push notification containing the
challengeSid, it needs to retrieve the
challenge details that correspond to that sid. Type or paste the sample code.
In an actual implementation, your iOS app should either display the Challenge details to the user and request confirmation that the Challenge is expected, or silently approve the Challenge, because your app already knows that the user is trying to login on the same device as the registered device that is being challenged.
In either case, the next step is for your app to call the Verify Push API directly and update the Challenge
denied. Type or paste the sample code into your iOS app.
Once Verify Push API receives a Challenge update from your iOS app, it will forward the update by sending a webhook callback (
challenge.denied) to your app backend, so that it knows to take your user to the next step in your flow. If you don't have a webhook configured, you can poll the Verify Push API for the
status of the
This completes the second user sequence of Verify Push: Challenge and verify a user.
Now that you've verified your first user, check out the following resources to continue your Verify Push journey with Twilio:
- Add Verify Push to your Android app by following the Android SDK Quickstart
- Prepare to go-live by reviewing Verify Push Best Practices for Production use
- Explore adding Verify's other verification channels beyond Push
We can't wait to see what you build!