Twilio - Verify API

by twilio.com

HTTP BasicHTTPSPhone

Overview

This is the public Twilio REST API.

Twilio - Verify is a phone API from twilio.com. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 53 endpoints.

At a glance

Authentication: HTTP Basic
HTTPS: Yes
CORS: Unknown
Category: Phone
Base URL: https://verify.twilio.com
Version: 1.42.0
Endpoints: 53
OpenAPI: Specification ↗
Spec updated: 2023-04-20

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://verify.twilio.com/v2/Attempts" \
  -H "Accept: application/json" \
  -H "Authorization: Basic BASE64_USER_PASSWORD"

JavaScript

const response = await fetch("https://verify.twilio.com/v2/Attempts", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://verify.twilio.com/v2/Attempts",
    headers={
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/v2/Attempts`	List all the verification attempts for a given Account.
GET	`/v2/Attempts/Summary`	Get a summary of how many attempts were made and how many were converted.
GET	`/v2/Attempts/{Sid}`	Fetch a specific verification attempt.
GET	`/v2/Forms/{FormType}`	Fetch the forms for a specific Form Type.
POST	`/v2/SafeList/Numbers`	Add a new phone number to SafeList.
GET	`/v2/SafeList/Numbers/{PhoneNumber}`	Check if a phone number exists in SafeList.
DELETE	`/v2/SafeList/Numbers/{PhoneNumber}`	Remove a phone number from SafeList.
GET	`/v2/Services`	Retrieve a list of all Verification Services for an account.
POST	`/v2/Services`	Create a new Verification Service.
POST	`/v2/Services/{ServiceSid}/AccessTokens`	Create a new enrollment Access Token for the Entity
GET	`/v2/Services/{ServiceSid}/AccessTokens/{Sid}`	Fetch an Access Token for the Entity
GET	`/v2/Services/{ServiceSid}/Entities`	Retrieve a list of all Entities for a Service.
POST	`/v2/Services/{ServiceSid}/Entities`	Create a new Entity for the Service
GET	`/v2/Services/{ServiceSid}/Entities/{Identity}`	Fetch a specific Entity.
DELETE	`/v2/Services/{ServiceSid}/Entities/{Identity}`	Delete a specific Entity.
GET	`/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges`	Retrieve a list of all Challenges for a Factor.
POST	`/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges`	Create a new Challenge for the Factor
POST	`/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications`	Create a new Notification for the corresponding Challenge
GET	`/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}`	Fetch a specific Challenge.
POST	`/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}`	Verify a specific Challenge.
GET	`/v2/Services/{ServiceSid}/Entities/{Identity}/Factors`	Retrieve a list of all Factors for an Entity.
POST	`/v2/Services/{ServiceSid}/Entities/{Identity}/Factors`	Create a new Factor for the Entity
GET	`/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}`	Fetch a specific Factor.
POST	`/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}`	Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param.
DELETE	`/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}`	Delete a specific Factor.
GET	`/v2/Services/{ServiceSid}/MessagingConfigurations`	Retrieve a list of all Messaging Configurations for a Service.
POST	`/v2/Services/{ServiceSid}/MessagingConfigurations`	Create a new MessagingConfiguration for a service.
GET	`/v2/Services/{ServiceSid}/MessagingConfigurations/{Country}`	Fetch a specific MessagingConfiguration.
POST	`/v2/Services/{ServiceSid}/MessagingConfigurations/{Country}`	Update a specific MessagingConfiguration
DELETE	`/v2/Services/{ServiceSid}/MessagingConfigurations/{Country}`	Delete a specific MessagingConfiguration.
GET	`/v2/Services/{ServiceSid}/RateLimits`	Retrieve a list of all Rate Limits for a service.
POST	`/v2/Services/{ServiceSid}/RateLimits`	Create a new Rate Limit for a Service
GET	`/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets`	Retrieve a list of all Buckets for a Rate Limit.
POST	`/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets`	Create a new Bucket for a Rate Limit
GET	`/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}`	Fetch a specific Bucket.
POST	`/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}`	Update a specific Bucket.
DELETE	`/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}`	Delete a specific Bucket.
GET	`/v2/Services/{ServiceSid}/RateLimits/{Sid}`	Fetch a specific Rate Limit.
POST	`/v2/Services/{ServiceSid}/RateLimits/{Sid}`	Update a specific Rate Limit.
DELETE	`/v2/Services/{ServiceSid}/RateLimits/{Sid}`	Delete a specific Rate Limit.
POST	`/v2/Services/{ServiceSid}/VerificationCheck`	challenge a specific Verification Check.
POST	`/v2/Services/{ServiceSid}/Verifications`	Create a new Verification using a Service
GET	`/v2/Services/{ServiceSid}/Verifications/{Sid}`	Fetch a specific Verification
POST	`/v2/Services/{ServiceSid}/Verifications/{Sid}`	Update a Verification status
GET	`/v2/Services/{ServiceSid}/Webhooks`	Retrieve a list of all Webhooks for a Service.
POST	`/v2/Services/{ServiceSid}/Webhooks`	Create a new Webhook for the Service
GET	`/v2/Services/{ServiceSid}/Webhooks/{Sid}`	Fetch a specific Webhook.
POST	`/v2/Services/{ServiceSid}/Webhooks/{Sid}`	UpdateWebhook
DELETE	`/v2/Services/{ServiceSid}/Webhooks/{Sid}`	Delete a specific Webhook.
GET	`/v2/Services/{Sid}`	Fetch specific Verification Service Instance.
POST	`/v2/Services/{Sid}`	Update a specific Verification Service.
DELETE	`/v2/Services/{Sid}`	Delete a specific Verification Service Instance.
GET	`/v2/Templates`	List all the available templates for a given Account.

Questions

Does the Twilio - Verify API need an API key?

Yes. The Twilio - Verify API uses HTTP Basic authentication; the documentation explains how to get credentials.

Does the Twilio - Verify API support HTTPS?

Yes, the Twilio - Verify API is served over HTTPS.

How many endpoints does the Twilio - Verify API have?

Its OpenAPI description lists 53 endpoints in version 1.42.0. All of them are shown on this page.

What are alternatives to the Twilio - Verify API?

Other Phone APIs include Twilio - Accounts, ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, Twilio - Api, Mobility API, Telnyx API.

Compare alternatives →

Twilio - Accounts

Phone

This is the public Twilio REST API.

HTTP Basic13 endpoints

ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management

Phone

ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.

No auth16 endpoints

Twilio - Api

Phone

This is the public Twilio REST API.

HTTP Basic199 endpoints

Mobility API

Phone

Transit API can be used to obtain time-aggregated data representing moving the people between various spatial points within the Czech Republic. Having A - 'from' and B - 'to' points, the API can return count of people traveling from A to B or people that are from A and traveling to B, etc. The mobility data is based on moving mobile stations in O2 mobile network.

No auth2 endpoints