Telnyx Requirement Types API
Types of requirements for international numbers and porting orders
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-requirement-types-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Telnyx Requirement Types API
version: 2.0.0
contact:
email: support@telnyx.com
x-endpoint-cost: light
x-refined-note:
- x-latency-category differs across the merged source definitions and was not carried
description: 'Operations tagged Requirement Types across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Requirement Types
description: Types of requirements for international numbers and porting orders
paths:
/requirement_types:
get:
summary: List all requirement types
description: List all requirement types ordered by created_at descending
operationId: ListRequirementTypes
x-latency-category: responsive
tags:
- Requirement Types
parameters:
- $ref: '#/components/parameters/FilterRequirementTypesConsolidated'
- $ref: '#/components/parameters/SortRequirementTypesConsolidated'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DocReqsRequirementTypeList'
meta:
$ref: '#/components/schemas/PaginationMeta'
'422':
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10027'
title: Unprocessable Entity
detail: The server understood the syntax of the request but was unable to process the instructions.
default:
$ref: '#/components/responses/documents_GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/requirement_types/{id}:
get:
summary: Retrieve a requirement types
description: Returns the details of a single requirement type by its identifier, describing a kind of documentation needed for regulatory purposes.
operationId: RetrieveRequirementType
x-latency-category: responsive
tags:
- Requirement Types
parameters:
- $ref: '#/components/parameters/DocReqsRequirementTypeId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DocReqsRequirementType'
'422':
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10027'
title: Unprocessable Entity
detail: The server understood the syntax of the request but was unable to process the instructions.
default:
$ref: '#/components/responses/documents_GenericErrorResponse'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
schemas:
Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/billing-group_Error'
type: object
PaginationMeta:
type: object
properties:
total_pages:
type: integer
example: 3
total_results:
type: integer
example: 55
page_number:
type: integer
example: 2
page_size:
type: integer
example: 25
DocReqsRequirementTypeList:
type: array
items:
$ref: '#/components/schemas/DocReqsRequirementType'
billing-group_Error:
type: object
required:
- code
- title
properties:
code:
type: integer
format: int32
title:
type: string
detail:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
properties: {}
additionalProperties: true
DocReqsRequirementType:
type: object
properties:
acceptance_criteria:
description: Specifies objective criteria for acceptance
type: object
properties:
time_limit:
description: Specifies time-based acceptance criteria
example: Current and not expired
type: string
readOnly: false
locality_limit:
description: Specifies geography-based acceptance criteria
example: Issued by the same country that the phone number belongs to
type: string
readOnly: false
acceptable_values:
description: Specifies the list of strictly possible values for the requirement. Ignored when empty
type: array
items:
type: string
example: US
readOnly: false
max_length:
description: Maximum length allowed for the value
type: integer
example: 20
readOnly: false
min_length:
description: Minimum length allowed for the value
type: integer
example: 16
readOnly: false
acceptable_characters:
description: Specifies the allowed characters as a string
type: string
example: abcdef0123456789
readOnly: false
description:
description: Describes the requirement type
example: Proves the customer has a physical address in the same locality as the phone number
type: string
readOnly: false
example:
description: Provides one or more examples of acceptable documents
example: Utility bill, internet bill, phone bill, or lease
type: string
readOnly: false
type:
description: Defines the type of this requirement type
example: document
type: string
enum:
- document
- address
- textual
readOnly: false
name:
description: A short descriptive name for this requirement_type
example: Proof of Address
type: string
readOnly: true
record_type:
description: Identifies the type of the resource
example: requirement_type
type: string
readOnly: true
id:
description: Identifies the associated document
type: string
format: uuid
readOnly: true
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
created_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was created.
readOnly: true
example: '2021-04-09T22:25:27.521Z'
updated_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was last updated.
readOnly: true
example: '2021-04-12T20:20:20.020Z'
documents_Error:
properties:
code:
type: string
detail:
type: string
meta:
additionalProperties: true
type: object
source:
properties:
parameter:
description: Indicates which query parameter caused the error.
type: string
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
type: object
title:
type: string
required:
- code
- title
type: object
documents_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/documents_Error'
type: array
type: object
Errors_2:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
type: object
Error:
required:
- code
- title
properties:
code:
type: string
x-format: int64
title:
type: string
detail:
type: string
description: A human-readable explanation of the error.
description:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
format: json-pointer
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
additionalProperties: true
example:
title: Invalid street address
source:
pointer: /street_address
code: '20207'
description: The street address provided is invalid.
type: object
parameters:
DocReqsRequirementTypeId:
name: id
in: path
description: Uniquely identifies the requirement_type record
example: a38c217a-8019-48f8-bff6-0fdd9939075b
required: true
schema:
type: string
format: uuid
SortRequirementTypesConsolidated:
name: sort
in: query
required: false
description: 'Consolidated sort parameter for requirement types (deepObject style). Originally: sort[]'
schema:
type: array
items:
type: string
enum:
- name
- created_at
- updated_at
- -name
- -created_at
- -updated_at
example:
- name
description: Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a `-` in front of the field name.
FilterRequirementTypesConsolidated:
name: filter
in: query
style: deepObject
explode: true
required: false
description: 'Consolidated filter parameter for requirement types (deepObject style). Originally: filter[name]'
schema:
type: object
additionalProperties: false
properties:
name:
type: object
additionalProperties: false
properties:
contains:
type: string
example: utility bill
description: Filters requirement types to those whose name contains a certain string.
responses:
documents_GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
example:
errors:
- code: '10007'
title: Unexpected error
detail: An unexpected error occured.
documents_GenericErrorResponse_2:
content:
application/json:
schema:
$ref: '#/components/schemas/documents_Errors'
description: Unexpected error
DocReqsRequirementTypeResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/DocReqsRequirementType'
type: object
description: Successful response
DocReqsListRequirementTypesResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/DocReqsRequirementTypeList'
meta:
$ref: '#/components/schemas/PaginationMeta'
type: object
description: Successful response
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
Payment:
type: apiKey
in: header
name: Authorization
description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
agent-memory_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
bearerAuth:
type: http
scheme: bearer
branded-calling_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
collections_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
number-reputation_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
oauthClientAuth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
authorizationCode:
authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
tokenUrl: https://api.telnyx.com/v2/oauth/token
refreshUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
description: OAuth 2.0 authentication for Telnyx API and MCP integrations
outbound-voice-profiles_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
pronunciation-dicts_bearerAuth:
type: http
scheme: bearer
description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
rcs-registration_bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
stored-payment-transactions_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
transcriptions-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
web-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
pay-connectors_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key, not the processor bearer token.
telnyxApiKey:
type: http
scheme: bearer
description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
categories:
- communication
- developer-tools
docs:
apiReference: https://developers.telnyx.com
homepage: https://telnyx.com
llms: https://telnyx.com/llms.txt