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 response = await client.portingOrders.actionRequirements.initiate('id', {
  porting_order_id: 'porting_order_id',
  params: { first_name: 'John', last_name: 'Doe' },
});

console.log(response.data);

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "porting_action_requirement",
    "porting_order_id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "requirement_type_id": "53970723-fbff-4f46-a975-f62be6c1a585",
    "action_type": "document_upload",
    "action_url": "https://example.com/action",
    "status": "created",
    "cancel_reason": null,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

POST

porting_orders

{porting_order_id}

action_requirements

{id}

initiate

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.portingOrders.actionRequirements.initiate('id', {
  porting_order_id: 'porting_order_id',
  params: { first_name: 'John', last_name: 'Doe' },
});

console.log(response.data);

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "porting_action_requirement",
    "porting_order_id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "requirement_type_id": "53970723-fbff-4f46-a975-f62be6c1a585",
    "action_type": "document_upload",
    "action_url": "https://example.com/action",
    "status": "created",
    "cancel_reason": null,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

porting_order_id

string

required

The ID of the porting order

string

required

The ID of the action requirement

Body

application/json

Parameters for initiating the action requirement

params

object

required

Required information for initiating the action requirement for AU ID verification.

Show child attributes

params.first_name

string

required

The first name of the person that will perform the verification flow.

Example:

"John"

params.last_name

string

required

The last name of the person that will perform the verification flow.

Example:

"Doe"

Response

Successful response

data

object

Show child attributes

data.id

string

Identifies the action requirement

Example:

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

data.record_type

enum<string>

Identifies the type of the resource

Available options:

porting_action_requirement

Example:

"porting_action_requirement"

data.porting_order_id

string

The ID of the porting order this action requirement belongs to

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.requirement_type_id

string

The ID of the requirement type

Example:

"53970723-fbff-4f46-a975-f62be6c1a585"

data.action_type

string

The type of action required

Example:

"document_upload"

data.action_url

string | null

Optional URL for the action

Example:

"https://example.com/action"

data.status

enum<string>

Current status of the action requirement

Available options:

created,

pending,

completed,

cancelled,

failed

Example:

"created"

data.cancel_reason

string | null

Reason for cancellation if status is 'cancelled'

Example:

null

data.created_at

string<date-time>

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

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string<date-time>

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

Example:

"2018-02-02T22:25:27.521Z"

List action requirements for a porting order List all associated phone numbers

⌘I

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Initiate an action requirement

Authorizations

Path Parameters

Body

Response