Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Verify API Verify API

Trigger and check OTP / 2FA verifications over SMS, call, flash call, and WhatsApp.

Telnyx Verify API Verify API is one of 3 APIs that Telnyx Verify API 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, API documentation, and an API reference.

This API exposes 8 operations across 8 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.

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

8 operations 8 paths 5 schemas 2 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Telnyx Verify API Verify API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Telnyx API v2 key passed as Authorization: Bearer YOURAPIKEY. Create keys in the Telnyx Mission Control Portal under Auth / API Keys.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Verify 8

Trigger and check OTP / 2FA verifications over SMS, call, flash call, and WhatsApp.

POST
/verifications/sms
Trigger SMS verification
createVerificationSms body → 200401
POST
/verifications/call
Trigger Call verification
createVerificationCall body → 200401
POST
/verifications/flashcall
Trigger Flash call verification
createVerificationFlashcall body → 200401
POST
/verifications/whatsapp
Trigger WhatsApp verification
createVerificationWhatsapp body → 200401
GET
/verifications/by_phone_number/{phone_number}
List verifications by phone number
listVerificationsByPhoneNumber 1 param → 200401
POST
/verifications/by_phone_number/{phone_number}/actions/verify
Verify verification code by phone number
verifyByPhoneNumber 1 param body → 200401404
GET
/verifications/{verification_id}
Retrieve verification
retrieveVerification 1 param → 200401404
POST
/verifications/{verification_id}/actions/verify
Verify verification code by ID
verifyById 1 param body → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are TriggerVerificationRequest (3 properties), VerifyCodeRequest (2 properties), VerifyResultResponse (1 property), Errors (1 property). Each schema is shown below with its type and property counts.

VerifyCodeRequest
object
2 properties 1 required
VerificationResponse
object
1 property
Errors
object
1 property
VerifyResultResponse
object
1 property
TriggerVerificationRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-verify-verify-api-openapi.yml Raw ↑

Other APIs Telnyx Verify API publishes across the network.

Telnyx Verify API Number Lookup API
Telnyx Verify API Verify Profiles API