Verification Attempts Summary
Info The Verification Attempts Summary API is currently in the Public Beta release stage!
Please note that Verification Attempts Summary API currently only supports SMS , WhatsApp , and Voice channels.
The Verification Attempts Summary API allows you to summarize verification attempts generated by your Verify V2 services.
A verification attempt is a communication attempt with the end user that contains a verification code and uses one of the channels supported by Twilio Verify. A single verification may generate one or more verification attempts.
This API contains one endpoint:
Get a Verification Attempts Summary
: Returns a summary of verification attempts including total conversions and conversion rate percentage
You can list, filter, and fetch verification attempts using the Verification Attempts API .
Verification Attempts Summary API currently supports only the SMS, Call & WhatsApp channel.
Verification Attempts Summary API provides a built-in rate limit of 100 requests per minute. If you reach this limit, you will start receiving HTTP 429 "Too Many Requests" responses.
Verification Attempts Summary API has a timeout value of 15 seconds. However, its 99th percentile is within 1 second.
Verification Attempts Summary Response Properties These properties are returned in the JSON response output.
Property name Type PII Description
Total of attempts made according to the provided filters
Total of attempts made that were confirmed by the end user, according to the provided filters.
Total of attempts made that were not confirmed by the end user, according to the provided filters.
conversion_rate_percentage number Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100.
Get a Verification Attempts Summary GET https://verify.twilio.com/v2/Attempts/Summary
Returns a summary of verification attempts that match the selected query parameters.
Property name Type Required PII Description
VerifyServiceSid SID<VA> Optional Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
Pattern: ^VA[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
DateCreatedAfter string<date-time> Optional Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
DateCreatedBefore string<date-time> Optional Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
Country string<iso-country-code> Optional Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
Channel enum<string> Optional Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are SMS
, CALL
and WHATSAPP
Possible values: sms
call
email
whatsapp
DestinationPrefix string Optional Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
Fetch Verification Attempts Summary _18 // Download the helper library from https://www.twilio.com/docs/node/install
_18 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18 // Find your Account SID and Auth Token at twilio.com/console
_18 // and set the environment variables. See http://twil.io/secure
_18 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18 const authToken = process.env.TWILIO_AUTH_TOKEN;
_18 const client = twilio(accountSid, authToken);
_18 async function fetchVerificationAttemptsSummary() {
_18 const verificationAttemptsSummary = await client.verify.v2
_18 .verificationAttemptsSummary()
_18 console.log(verificationAttemptsSummary.totalAttempts);
_18 fetchVerificationAttemptsSummary();
_10 "total_attempts": 11,
_10 "total_converted": 9,
_10 "total_unconverted": 2,
_10 "conversion_rate_percentage": "81.818181818",
_10 "url": "https://verify.twilio.com/v2/Attempts/Summary"
Fetch Verification Attempts Summary by Verify Service SID _18 // Download the helper library from https://www.twilio.com/docs/node/install
_18 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18 // Find your Account SID and Auth Token at twilio.com/console
_18 // and set the environment variables. See http://twil.io/secure
_18 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18 const authToken = process.env.TWILIO_AUTH_TOKEN;
_18 const client = twilio(accountSid, authToken);
_18 async function fetchVerificationAttemptsSummary() {
_18 const verificationAttemptsSummary = await client.verify.v2
_18 .verificationAttemptsSummary()
_18 .fetch({ verifyServiceSid: "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" });
_18 console.log(verificationAttemptsSummary.totalAttempts);
_18 fetchVerificationAttemptsSummary();
_10 "total_attempts": 11,
_10 "total_converted": 9,
_10 "total_unconverted": 2,
_10 "conversion_rate_percentage": "81.818181818",
_10 "url": "https://verify.twilio.com/v2/Attempts/Summary"
Fetch Verification Attempts Summary by Country _18 // Download the helper library from https://www.twilio.com/docs/node/install
_18 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18 // Find your Account SID and Auth Token at twilio.com/console
_18 // and set the environment variables. See http://twil.io/secure
_18 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18 const authToken = process.env.TWILIO_AUTH_TOKEN;
_18 const client = twilio(accountSid, authToken);
_18 async function fetchVerificationAttemptsSummary() {
_18 const verificationAttemptsSummary = await client.verify.v2
_18 .verificationAttemptsSummary()
_18 .fetch({ country: "CO" });
_18 console.log(verificationAttemptsSummary.totalAttempts);
_18 fetchVerificationAttemptsSummary();
_10 "total_attempts": 11,
_10 "total_converted": 9,
_10 "total_unconverted": 2,
_10 "conversion_rate_percentage": "81.818181818",
_10 "url": "https://verify.twilio.com/v2/Attempts/Summary"