Twilio Verify v2
This is the public Twilio REST API.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is the public Twilio REST API.
Endpoints 57
VerifyV2AccessToken
- POSTCreate a new enrollment Access Token for the Entity
/v2/Services/:ServiceSid/AccessTokensCreate a new enrollment Access Token for the Entity - GETFetch an Access Token for the Entity
/v2/Services/:ServiceSid/AccessTokens/:SidFetch an Access Token for the Entity
VerifyV2Bucket
- GETRetrieve a list of all Buckets for a Rate Limit.
/v2/Services/:ServiceSid/RateLimits/:RateLimitSid/Buckets?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Buckets for a Rate Limit. - POSTCreate a new Bucket for a Rate Limit
/v2/Services/:ServiceSid/RateLimits/:RateLimitSid/BucketsCreate a new Bucket for a Rate Limit - GETFetch a specific Bucket.
/v2/Services/:ServiceSid/RateLimits/:RateLimitSid/Buckets/:SidFetch a specific Bucket. - POSTUpdate a specific Bucket.
/v2/Services/:ServiceSid/RateLimits/:RateLimitSid/Buckets/:SidUpdate a specific Bucket. - DELETEDelete a specific Bucket.
/v2/Services/:ServiceSid/RateLimits/:RateLimitSid/Buckets/:SidDelete a specific Bucket.
VerifyV2Challenge
- GETRetrieve a list of all Challenges for a Factor.
/v2/Services/:ServiceSid/Entities/:Identity/Challenges?FactorSid=string&Status=pending&Order=asc&PageSize=1&Page=0&PageToken=stringRetrieve a list of all Challenges for a Factor. - POSTCreate a new Challenge for the Factor
/v2/Services/:ServiceSid/Entities/:Identity/ChallengesCreate a new Challenge for the Factor - GETFetch a specific Challenge.
/v2/Services/:ServiceSid/Entities/:Identity/Challenges/:SidFetch a specific Challenge. - POSTVerify a specific Challenge.
/v2/Services/:ServiceSid/Entities/:Identity/Challenges/:SidVerify a specific Challenge.
VerifyV2Entity
- GETRetrieve a list of all Entities for a Service.
/v2/Services/:ServiceSid/Entities?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Entities for a Service. - POSTCreate a new Entity for the Service
/v2/Services/:ServiceSid/EntitiesCreate a new Entity for the Service - GETFetch a specific Entity.
/v2/Services/:ServiceSid/Entities/:IdentityFetch a specific Entity. - DELETEDelete a specific Entity.
/v2/Services/:ServiceSid/Entities/:IdentityDelete a specific Entity.
VerifyV2Factor
- GETFetch a specific Factor.
/v2/Services/:ServiceSid/Entities/:Identity/Factors/:SidFetch a specific Factor. - POSTUpdate a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param.
/v2/Services/:ServiceSid/Entities/:Identity/Factors/:SidUpdate a specific Factor. This endpoint can be used to Verify a Factor if passed an AuthPayload param. - DELETEDelete a specific Factor.
/v2/Services/:ServiceSid/Entities/:Identity/Factors/:SidDelete a specific Factor. - GETRetrieve a list of all Factors for an Entity.
/v2/Services/:ServiceSid/Entities/:Identity/Factors?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Factors for an Entity.
VerifyV2Form
- GETFetch the forms for a specific Form Type.
/v2/Forms/:FormTypeFetch the forms for a specific Form Type.
VerifyV2MessagingConfiguration
- GETRetrieve a list of all Messaging Configurations for a Service.
/v2/Services/:ServiceSid/MessagingConfigurations?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Messaging Configurations for a Service. - POSTCreate a new MessagingConfiguration for a service.
/v2/Services/:ServiceSid/MessagingConfigurationsCreate a new MessagingConfiguration for a service. - GETFetch a specific MessagingConfiguration.
/v2/Services/:ServiceSid/MessagingConfigurations/:CountryFetch a specific MessagingConfiguration. - POSTUpdate a specific MessagingConfiguration
/v2/Services/:ServiceSid/MessagingConfigurations/:CountryUpdate a specific MessagingConfiguration - DELETEDelete a specific MessagingConfiguration.
/v2/Services/:ServiceSid/MessagingConfigurations/:CountryDelete a specific MessagingConfiguration.
VerifyV2NewFactor
- POSTCreate a new Factor for the Entity
/v2/Services/:ServiceSid/Entities/:Identity/FactorsCreate a new Factor for the Entity - POSTCreate a new Passkeys Factor for the Entity
/v2/Services/:ServiceSid/Passkeys/FactorsCreate a new Passkeys Factor for the Entity
VerifyV2Notification
- POSTCreate a new Notification for the corresponding Challenge
/v2/Services/:ServiceSid/Entities/:Identity/Challenges/:ChallengeSid/NotificationsCreate a new Notification for the corresponding Challenge
VerifyV2RateLimit
- GETRetrieve a list of all Rate Limits for a service.
/v2/Services/:ServiceSid/RateLimits?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Rate Limits for a service. - POSTCreate a new Rate Limit for a Service
/v2/Services/:ServiceSid/RateLimitsCreate a new Rate Limit for a Service - GETFetch a specific Rate Limit.
/v2/Services/:ServiceSid/RateLimits/:SidFetch a specific Rate Limit. - POSTUpdate a specific Rate Limit.
/v2/Services/:ServiceSid/RateLimits/:SidUpdate a specific Rate Limit. - DELETEDelete a specific Rate Limit.
/v2/Services/:ServiceSid/RateLimits/:SidDelete a specific Rate Limit.
VerifyV2Safelist
- POSTAdd a new phone number to SafeList.
/v2/SafeList/NumbersAdd a new phone number to SafeList. - GETCheck if a phone number exists in SafeList.
/v2/SafeList/Numbers/:PhoneNumberCheck if a phone number exists in SafeList. - DELETERemove a phone number from SafeList.
/v2/SafeList/Numbers/:PhoneNumberRemove a phone number from SafeList.
VerifyV2Service
- GETRetrieve a list of all Verification Services for an account.
/v2/Services?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Verification Services for an account. - POSTCreate a new Verification Service.
/v2/ServicesCreate a new Verification Service. - GETFetch specific Verification Service Instance.
/v2/Services/:SidFetch specific Verification Service Instance. - POSTUpdate a specific Verification Service.
/v2/Services/:SidUpdate a specific Verification Service. - DELETEDelete a specific Verification Service Instance.
/v2/Services/:SidDelete a specific Verification Service Instance.
VerifyV2Template
- GETList all the available templates for a given Account.
/v2/Templates?FriendlyName=string&PageSize=1&Page=0&PageToken=stringList all the available templates for a given Account.
VerifyV2Verification
- POSTCreate a new Verification using a Service
/v2/Services/:ServiceSid/VerificationsCreate a new Verification using a Service - GETFetch a specific Verification
/v2/Services/:ServiceSid/Verifications/:SidFetch a specific Verification - POSTUpdate a Verification status
/v2/Services/:ServiceSid/Verifications/:SidUpdate a Verification status
VerifyV2VerificationAttempt
- GETList all the verification attempts for a given Account.
/v2/Attempts?DateCreatedAfter=2024-01-01T00:00:00Z&DateCreatedBefore=2024-01-01T00:00:00Z&ChannelData.To=string&Country=string&Channel=sms&VerifyServiceSid=string&VerificationSid=string&Status=converted&PageSize=1&Page=0&PageToken=stringList all the verification attempts for a given Account. - GETFetch a specific verification attempt.
/v2/Attempts/:SidFetch a specific verification attempt.
VerifyV2VerificationAttemptsSummary
- GETGet a summary of how many attempts were made and how many were converted.
/v2/Attempts/Summary?VerifyServiceSid=VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2022-03-02T21:02:33Z&DateCreatedBefore=2022-03-02T21:02:33Z&Country=CO&Channel=sms&DestinationPrefix=+57305Get a summary of how many attempts were made and how many were converted.
VerifyV2VerificationCheck
- POSTchallenge a specific Verification Check.
/v2/Services/:ServiceSid/VerificationCheckchallenge a specific Verification Check.
VerifyV2Webhook
- GETRetrieve a list of all Webhooks for a Service.
/v2/Services/:ServiceSid/Webhooks?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Webhooks for a Service. - POSTCreate a new Webhook for the Service
/v2/Services/:ServiceSid/WebhooksCreate a new Webhook for the Service - GETFetch a specific Webhook.
/v2/Services/:ServiceSid/Webhooks/:SidFetch a specific Webhook. - POSTUpdateWebhook
/v2/Services/:ServiceSid/Webhooks/:Sid - DELETEDelete a specific Webhook.
/v2/Services/:ServiceSid/Webhooks/:SidDelete a specific Webhook.
VerifyV2NewChallenge
- POSTCreate a Passkeys Challenge
/v2/Services/:ServiceSid/Passkeys/ChallengesCreate a Passkeys Challenge
- POSTVerify a Passkeys Factor
/v2/Services/:ServiceSid/Passkeys/VerifyFactorVerify a Passkeys Factor - POSTApprove a Passkeys Challenge
/v2/Services/:ServiceSid/Passkeys/ApproveChallengeApprove a Passkeys challenge
API details
- Base URL
https://verify.twilio.com- Authentication
- HTTP Basic authentication (username and password)
A bearer token in the Authorization header - Operations
- 57 operations on 33 pathsPOST 25GET 24DELETE 8
- Main resources
- VerifyV2Bucket 5VerifyV2MessagingConfiguration 5VerifyV2RateLimit 5VerifyV2Service 5VerifyV2Webhook 5VerifyV2Challenge 4VerifyV2Entity 4VerifyV2Factor 4VerifyV2Safelist 3VerifyV2Verification 3
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
1.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Twilio's published OpenAPI description (twilio/twilio-oai) (MIT)
How to test the Twilio Verify v2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio Verify v2 collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create a new enrollment Access Token for the Entity” (POST /v2/Services/:ServiceSid/AccessTokens), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio Verify v2?
This is the public Twilio REST API. It is listed under Communication and has 57 endpoints.
Who publishes the Twilio Verify v2?
It is listed from Twilio's public API description (an OpenAPI document), not published by Twilio on Swastik Codes. Anyone who controls twilio.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Twilio Verify v2?
Requests go to https://verify.twilio.com. Endpoint paths are added to this base URL.
How do I authenticate with the Twilio Verify v2?
It accepts 2 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header.
How many endpoints does the Twilio Verify v2 have?
57 operations on 33 paths (25 POST, 24 GET, 8 DELETE). The largest groups are VerifyV2Bucket, VerifyV2MessagingConfiguration, VerifyV2RateLimit, VerifyV2Service.
Is forking the Twilio Verify v2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.