Twilio Verify Push Sample Backend

This project can be used as a sample backend for Verify Push and to issue push authentication challenges in combination with the Android or iOS SDKs.

How to use the template

The best way to use the Function templates is through the Twilio CLI as described below. If you'd like to use the template without the Twilio CLI, check out our usage docs.

Pre-requisites

• Create a Verify Service
• Set up and run the sample app for either Android or iOS

Environment variables

This project requires some environment variables to be set. To keep your tokens and secrets secure, make sure to not commit the .env file in git. When setting up the project with twilio serverless:init ... the Twilio CLI will create a .gitignore file that excludes .env from the version history.

In your .env file, set the following values:

Variable	Meaning	Required
ACCOUNT_SID	Find in the console	Yes
AUTH_TOKEN	Find in the console	Yes
VERIFY_SERVICE_SID	Create one here	Yes

Function Parameters

access-token.js expects the following parameters:

Parameter	Description	Required
identity	Unique user ID, avoid PII	Yes

list-factors.js expects the following parameters:

Parameter	Description	Required
identity	Unique user ID, avoid PII	Yes

create-challenge.js expects the following parameters:

Parameter	Description	Required
identity	Unique user ID, avoid PII	Yes
factor	Factor SID	Yes
message	Verification message	Yes
details	Arbitrary key value pairs to demo additional verification context	Yes

challenge-status.js expects the following parameters:

Parameter	Description	Required
identity	Unique user ID, avoid PII	Yes
sid	Challenge SID	Yes

Create a new project with the template

1. Install the Twilio CLI
2. Install the serverless toolkit

twilio plugins:install @twilio-labs/plugin-serverless

3. Initiate a new project

twilio serverless:init verify-sample-backend --template=verify-push-backend && cd verify-sample-backend

4. Add your environment variables to .env:

Make sure variables are populated in your .env file. See Environment variables.

5. Start the server :

twilio serverless:start

5. Open the web page at https://localhost:3000/index.html and enter the required fields to send a challenge

ℹ️ Check the developer console and terminal for any errors, make sure you've set your environment variables.

Deploying

Deploy your functions and assets with either of the following commands. Note: you must run these commands from inside your project folder. More details in the docs.

With the Twilio CLI:

twilio serverless:deploy