Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const requirementTypes = await client.requirementTypes.list();

console.log(requirementTypes.data);

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

requirement_types

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const requirementTypes = await client.requirementTypes.list();

console.log(requirementTypes.data);

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

filter

object

Consolidated filter parameter for requirement types (deepObject style). Originally: filter[name]

Show child attributes

filter[name]

object

Show child attributes

filter[name][contains]

string

Filters requirement types to those whose name contains a certain string.

Example:

"utility bill"

sort

enum<string>[]

Consolidated sort parameter for requirement types (deepObject style). Originally: sort[] 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.

Available options:

name,

created_at,

updated_at,

-name,

-created_at,

-updated_at

Example:

["name"]

Response

Successful response

data

object[]

Show child attributes

data.acceptance_criteria

object

Specifies objective criteria for acceptance

Show child attributes

data.acceptance_criteria.time_limit

string

Specifies time-based acceptance criteria

Example:

"Current and not expired"

data.acceptance_criteria.locality_limit

string

Specifies geography-based acceptance criteria

Example:

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

data.acceptance_criteria.acceptable_values

string[]

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

data.acceptance_criteria.max_length

integer

Maximum length allowed for the value

Example:

20

data.acceptance_criteria.min_length

integer

Minimum length allowed for the value

Example:

16

data.acceptance_criteria.acceptable_characters

string

Specifies the allowed characters as a string

Example:

"abcdef0123456789"

data.description

string

Describes the requirement type

Example:

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

data.example

string

Provides one or more examples of acceptable documents

Example:

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

data.type

enum<string>

Defines the type of this requirement type

Available options:

document,

address,

textual

Example:

"document"

data.name

string

A short descriptive name for this requirement_type

Example:

"Proof of Address"

data.record_type

string

Identifies the type of the resource

Example:

"requirement_type"

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"

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List all requirement types

Authorizations

Query Parameters

Response