Skip to main content
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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
id
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.

Response

Successful response

​
data
object