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 Profiles API

Reusable per-channel verification configuration and message templates.

Telnyx Verify API Verify Profiles 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 Profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 4 paths, and defines 3 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 4 paths 3 schemas 1 DELETE3 GET2 PATCH2 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 Profiles 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 4 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Verify Profiles 8

Reusable per-channel verification configuration and message templates.

GET
/verify_profiles
List all Verify profiles
listVerifyProfiles → 200401
POST
/verify_profiles
Create a Verify profile
createVerifyProfile body → 200401
GET
/verify_profiles/{verify_profile_id}
Retrieve Verify profile
retrieveVerifyProfile 1 param → 200401404
PATCH
/verify_profiles/{verify_profile_id}
Update Verify profile
updateVerifyProfile 1 param body → 200401404
DELETE
/verify_profiles/{verify_profile_id}
Delete Verify profile
deleteVerifyProfile 1 param → 200401404
GET
/verify_profiles/templates
Retrieve Verify profile message templates
listVerifyProfileTemplates → 200401
POST
/verify_profiles/templates
Create message template
createVerifyProfileTemplate body → 200401
PATCH
/verify_profiles/templates/{template_id}
Update message template
updateVerifyProfileTemplate 1 param body → 200401404

Schemas 3

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

VerifyProfile
object
9 properties
Errors
object
1 property
VerifyProfileMessageTemplate
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Telnyx Verify API publishes across the network.

Telnyx Verify API Number Lookup API
Telnyx Verify API Verify API