The Verification Attempts API is currently in the Public Beta release stage!
Please note that Verification Attempts API currently only supports SMS, WhatsApp, and Voice channels.
The Verification Attempts API allows you to list and filter verification attempts generated by your Verify V2 services in the last 30 days.
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 two endpoints:
List Multiple Verification Attempts
: Returns a list of verification attempts that match the selected query parameters. Each verification attempt includes information such as channel specific data, conversion status, and price.
You can get a summary of verification attempts including total conversions and conversion rate percentage using the Verification Attempts Summary API.
Verification Attempts API currently supports the SMS, Call and WhatsApp channel.
Rate limits
Verification Attempts 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.
Timeouts
Verification Attempts API has a timeout value of 15 seconds. However, its 99th percentile is within 1 second.
Pagination
Verification Attempts API has a default value of 50 items per page. The number of items per page can be controlled by the PageSize query string parameter. Valid values range from 1 to 1000 items per page.
Verification Attempt Response Properties
These properties are returned in the JSON response output. The values of some fields may change over time to reflect their current status, most notably message_status and price.
This field will reflect the current calculated price of the message. It may change depending on the message's outbound status and delivery outcome. Pricing is dependent on a number of factors including carriers used, verification delivery attempt count and number of message segments for each SMS. Final pricing data may not be available until 24 hours after message delivery.
Please note that for some countries (e.g. China) or carriers, we may not be able to fetch message_status and price info.
A string specifying the conversion status of the verification. A conversion happens when the user is able to provide the correct code. Possible values are CONVERTED and UNCONVERTED.
An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available here.
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.
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.
Filter used to query Verification Attempts by conversion status. Valid values are UNCONVERTED, for attempts that were not converted, and CONVERTED, for attempts that were confirmed.