Telnyx Verify API

Two factor authentication API

Documentation Provider Profile APIs.io OpenAPI GitHub

Telnyx Verify API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Verify. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 12 paths, and defines 36 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

16 operations 12 paths 36 schemas 1 DELETE5 GET2 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

2.0.0

Base URL

https://api.telnyx.com/v2

Authentication

HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer

Contact

support@telnyx.com

Resource Areas

Authentication & Security 6

Telnyx Verify API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 16

Across 12 paths, the API surfaces 16 operations — 1 DELETE, 5 GET, 2 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Verify 16

Two factor authentication API

GET

/verifications/by_phone_number/{phone_number}

List verifications by phone number

ListVerifications 1 param → 200400

POST

/verifications/by_phone_number/{phone_number}/actions/verify

Verify verification code by phone number

VerifyVerificationCodeByPhoneNumber 1 param body → 200400

POST

/verifications/call

Trigger Call verification

CreateVerificationCall body → 200400

POST

/verifications/flashcall

Trigger Flash call verification

CreateFlashcallVerification body → 200400

POST

/verifications/sms

Trigger SMS verification

CreateVerificationSms body → 200400

POST

/verifications/whatsapp

Trigger WhatsApp verification

CreateWhatsappVerification body → 200400

GET

/verifications/{verification_id}

Retrieve verification

RetrieveVerification 1 param → 200400

POST

/verifications/{verification_id}/actions/verify

Verify verification code by ID

VerifyVerificationCodeById 1 param body → 200400

GET

/verify_profiles

List all Verify profiles

ListProfiles 2 params → 200400

POST

/verify_profiles

Create a Verify profile

CreateVerifyProfile body → 200400

GET

/verify_profiles/templates

Retrieve Verify profile message templates

ListProfileMessageTemplates → 200400500

POST

/verify_profiles/templates

Create message template

CreateMessageTemplate body → 200400

PATCH

/verify_profiles/templates/{template_id}

Update message template

UpdateMessageTemplate 1 param body → 200400

DELETE

/verify_profiles/{verify_profile_id}

Delete Verify profile

DeleteProfile 1 param → 200400

GET

/verify_profiles/{verify_profile_id}

Retrieve Verify profile

GetVerifyProfile 1 param → 200400

PATCH

/verify_profiles/{verify_profile_id}

Update Verify profile

UpdateVerifyProfile 1 param body → 200400

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are VerifyProfileResponse (14 properties), Verification (10 properties), VerifyProfileWhatsAppResponse (8 properties), UpdateVerifyProfileSMSRequest (6 properties). Each schema is shown below with its type and property counts.

ListVerificationsResponse

object

2 properties 2 required

VerifyProfileFlashcallResponse

object

2 properties

CreateVerifyProfileSettingsWhatsAppRequest

object

5 properties

RetrieveVerificationResponse

object

1 property 1 required

VerifyProfileWhatsAppResponse

object

8 properties

UpdateVerifyProfileSettingsWhatsAppRequest

object

5 properties

VerificationStatus

string

The possible statuses of the verification request.

CreateVerifyProfileSMSRequest

object

6 properties

VerifyVerificationCodeRequestById

object

2 properties

CreateVerificationResponse

object

1 property 1 required

CreateMessageTemplateRequest

object

The request body when creating a message template.

1 property 1 required

CreateVerificationRequestSMS

object

The request body when creating a verification.

4 properties 2 required

verify_Meta

object

4 properties 4 required

VerifyProfileSMSResponse

object

6 properties

UpdateMessageTemplateRequest

object

The request body when updating a message template.

1 property 1 required

CreateVerifyProfileSettingsRequest

object

3 properties

VerifyProfileResponse

object

14 properties

VerifyProfileResponseDataWrapper

object

1 property

verify_Errors

object

1 property

VerifyProfileCallResponse

object

5 properties

UpdateVerifyProfileCallRequest

object

5 properties

ListVerifyProfilesResponse

object

A paginated list of Verify profiles

2 properties 2 required

UpdateVerifyProfileSMSRequest

object

6 properties

VerifyProfileMessageTemplateResponse

object

2 properties

CreateVerifyProfileCallRequest

object

5 properties

CreateVerificationRequestCall

object

The request body when creating a verification.

5 properties 2 required

MessageTemplateResponseDataWrapper

object

1 property

verify_Error

object

5 properties 2 required

VerificationRecordType

string

The possible verification record types.

CreateVerificationRequest

object

The request body when creating a verification.

3 properties 2 required

VerificationProfileRecordType

string

The possible verification profile record types.

ListVerifyProfileMessageTemplateResponse

object

A list of Verify profile message templates

1 property 1 required

VerifyVerificationCodeRequestByPhoneNumber

object

2 properties 2 required

VerificationType

string

The possible types of verification.

Verification

object

10 properties

VerifyVerificationCodeResponse

object

1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API

AE Profile APIs.io

Telnyx Addresses API

AE Profile APIs.io

Telnyx Advanced Number Orders API

AE Profile APIs.io

Telnyx Assistants API

AE Profile APIs.io

Telnyx Audio API

AE Profile APIs.io

Telnyx Audit Logs API

AE Profile APIs.io

Telnyx Authentication Providers API

AE Profile APIs.io

Telnyx AutoRechargePreferences API

AE Profile APIs.io

Telnyx Billing API

AE Profile APIs.io

Telnyx Billing Groups API

AE Profile APIs.io

Telnyx Brands API

AE Profile APIs.io

Telnyx Bucket SSL Certificate API

AE Profile APIs.io

#Verify

← Back to T APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Telnyx Verify API

Metadata

Authentication & Security 6

Paths & Operations 16

Schemas 36

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Telnyx Verify API

Metadata

Authentication & Security 6

Paths & Operations 16

Schemas 36

Specification

Source

More from Telnyx 12

API Details

Provider

Explore more