This is a handy dashboard to help you out while you're developing with Twilio Verify. Using the dashboard you can:
- Send verifications via multiple channels and locales
- Check/approve verifications
- Cancel verifications
- See a verification status
There are also helpful error messages and links to help you troubleshoot common issues.
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.
Create a Verify Service in the Twilio Console
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 |
start-verify.js expects the following parameters:
| Parameter | Description | Required |
|---|---|---|
to |
Either an email or phone number in E.164 format | Yes |
channel |
'sms', 'call', or 'email'. Default is 'sms' | No |
locale |
Localization language. See supported languages. Default is 'en' | No |
check-verify.js expects the following parameters:
| Parameter | Description | Required |
|---|---|---|
to |
Either an email or phone number in E.164 format or the Verification SID | Yes |
verification_code |
Populated by SendGrid email template | Yes |
status-verify.js expects the following parameters:
| Parameter | Description | Required |
|---|---|---|
to |
Either an email or phone number in E.164 format or the Verification SID | Yes |
update-verify.js expects the following parameters:
| Parameter | Description | Required |
|---|---|---|
to |
Either an email or phone number in E.164 format or the Verification SID | Yes |
service-details.js does not expect any parameters.
- Install the Twilio CLI
- Install the serverless toolkit
twilio plugins:install @twilio-labs/plugin-serverless- Initiate a new project
twilio serverless:init verify-dashboard --template=verify-dashboard && cd verify-dashboard
- Add your environment variables to
.env:
Make sure variables are populated in your .env file. See Environment variables.
- Start the server :
npm start
- Open the web page at https://localhost:3000/index.html and enter your phone number or email to test
ℹ️ Check the developer console and terminal for any errors, make sure you've set your environment variables.
Deploy your functions and assets with the following command. Note: you must run these commands from inside your project folder. More details in the docs.
With the Twilio CLI:
twilio serverless:deploy