Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const requirement = await client.requirements.retrieve('a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa'); console.log(requirement.data);

{ "data": { "record_type": "requirement", "country_code": "FR", "locality": "Nice", "phone_number_type": "local", "action": "ordering", "requirements_types": [ { "acceptance_criteria": { "time_limit": "Current and not expired", "locality_limit": "Issued by the same country that the phone number belongs to", "acceptable_values": [ "US" ], "max_length": 20, "min_length": 16, "acceptable_characters": "abcdef0123456789" }, "description": "Proves the customer has a physical address in the same locality as the phone number", "example": "Utility bill, internet bill, phone bill, or lease", "type": "document", "name": "Proof of Address", "record_type": "requirement_type", "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "created_at": "2021-04-09T22:25:27.521Z", "updated_at": "2021-04-12T20:20:20.020Z" } ], "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "created_at": "2021-04-09T22:25:27.521Z", "updated_at": "2021-04-12T20:20:20.020Z" } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Uniquely identifies the requirement_type record

Response

Successful response

data

object

Show child attributes

data.record_type

string

Identifies the type of the resource.

Example:

"requirement"

data.country_code

string

The 2-character (ISO 3166-1 alpha-2) country code where this requirement applies

Example:

"FR"

data.locality

string

The locality where this requirement applies

Example:

"Nice"

data.phone_number_type

enum<string>

Indicates the phone_number_type this requirement applies to. Leave blank if this requirement applies to all number_types.

Available options:

local,

national,

toll_free

Example:

"local"

data.action

enum<string>

Indicates whether this requirement applies to branded_calling, ordering, porting, or both ordering and porting

Available options:

both,

branded_calling,

ordering,

porting

Example:

"ordering"

data.requirements_types

object[]

Lists the requirement types necessary to fulfill this requirement

Show child attributes

data.requirements_types.acceptance_criteria

object

Specifies objective criteria for acceptance

Show child attributes

data.requirements_types.acceptance_criteria.time_limit

string

Specifies time-based acceptance criteria

Example:

"Current and not expired"

data.requirements_types.acceptance_criteria.locality_limit

string

Specifies geography-based acceptance criteria

Example:

"Issued by the same country that the phone number belongs to"

data.requirements_types.acceptance_criteria.acceptable_values

string[]

Specifies the list of strictly possible values for the requirement. Ignored when empty

data.requirements_types.acceptance_criteria.max_length

integer

Maximum length allowed for the value

Example:

20

data.requirements_types.acceptance_criteria.min_length

integer

Minimum length allowed for the value

Example:

16

data.requirements_types.acceptance_criteria.acceptable_characters

string

Specifies the allowed characters as a string

Example:

"abcdef0123456789"

data.requirements_types.description

string

Describes the requirement type

Example:

"Proves the customer has a physical address in the same locality as the phone number"

data.requirements_types.example

string

Provides one or more examples of acceptable documents

Example:

"Utility bill, internet bill, phone bill, or lease"

data.requirements_types.type

enum<string>

Defines the type of this requirement type

Available options:

document,

address,

textual

Example:

"document"

data.requirements_types.name

string

A short descriptive name for this requirement_type

Example:

"Proof of Address"

data.requirements_types.record_type

string

Identifies the type of the resource

Example:

"requirement_type"

data.requirements_types.id

string<uuid>

Identifies the associated document

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.requirements_types.created_at

string

ISO 8601 formatted date-time indicating when the resource was created.

Example:

"2021-04-09T22:25:27.521Z"

data.requirements_types.updated_at

string

ISO 8601 formatted date-time indicating when the resource was last updated.

Example:

"2021-04-12T20:20:20.020Z"

data.id

string<uuid>

Identifies the associated document

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.created_at

string

ISO 8601 formatted date-time indicating when the resource was created.

Example:

"2021-04-09T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date-time indicating when the resource was last updated.

Example:

"2021-04-12T20:20:20.020Z"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup