Port numbers in

Submit a port-in for one or more existing numbers from another carrier. Creates the carrier order(s), attaches the end-user (current account) info plus the LOA and invoice documents, and submits to the losing carrier. The transfer PIN is forwarded to the carrier and never stored. Ported numbers arrive voice-ready (and SMS-ready where the order supports messaging).

Run the portability check (POST /v1/phone-numbers/port-in/check) and upload the two documents (POST /v1/phone-numbers/port-in/documents) first — uploaded documents must be attached to an order within 30 minutes or the carrier deletes them, so upload right before this call. The carrier may split the numbers into several orders (by country, number type, losing carrier); orders carries per-order results, and a partial failure still returns 201 with the failed orders' error set (they stay as cancellable drafts).

Non-US/CA numbers additionally need the country-specific values from GET /v1/phone-numbers/port-in/requirements, passed via requirements, and must be submitted one country per request. When required information is still missing after submission, the order is kept as a resumable draft whose error / declineReason names the gaps.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Request Body

phoneNumbersarray<string>

E.164 numbers to port in.

Items1 <= items <= 50

endUser

End-user / current-carrier account info that authorizes the port. The losing carrier matches every field against its records and rejects the whole port on a mismatch — enter values exactly as they appear on the carrier bill.

loaDocumentIdstring

Document id from POST /v1/phone-numbers/port-in/documents (kind=loa).

invoiceDocumentIdstring

Document id from POST /v1/phone-numbers/port-in/documents (kind=invoice).

focDatetimeRequested?string

Requested port date; the carrier confirms the actual FOC later. US/CA default is one week out (shifted off weekends); international orders are scheduled into the carrier's next allowed porting window at or after this date.

Formatdate-time

customerReference?string

Lengthlength <= 100

portType?string

Whether the losing account ports all its numbers (full) or keeps some (partial).

Default"full"

Value in"full" | "partial"

requirements?

Country-specific requirement values for international ports (from GET /v1/phone-numbers/port-in/requirements). Not needed for US/CA. The LOA and invoice requirements are satisfied automatically by loaDocumentId/invoiceDocumentId, and address-type requirements by the endUser service address.

Itemsitems <= 30

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.phonenumbers.createPhoneNumberPortIn({  body: {    phoneNumbers: [      'string',    ],    endUser: {      entityName: 'Example',      authPersonName: 'Example',      accountNumber: 'string',      streetAddress: 'string',      locality: 'string',      postalCode: 'string',      countryCode: 'US',    },    loaDocumentId: 'loadocument_abc123',    invoiceDocumentId: 'invoicedocument_abc123',  },});console.log(data);

{
  "id": "string",
  "telnyxPortingOrderId": "string",
  "status": "draft",
  "phoneNumbers": [
    "string"
  ],
  "orders": [
    {
      "id": "string",
      "telnyxPortingOrderId": "string",
      "status": "string",
      "phoneNumbers": [
        "string"
      ],
      "error": "string"
    }
  ]
}

{
  "error": "string",
  "type": "invalid_request_error",
  "code": "string",
  "param": "string",
  "platform": "string",
  "platformError": {},
  "details": {}
}

{
  "error": "Unauthorized"
}

Empty

Port numbers in

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Request Body

phoneNumbersarray<string>

E.164 numbers to port in.

Items1 <= items <= 50

endUser

loaDocumentIdstring

Document id from POST /v1/phone-numbers/port-in/documents (kind=loa).

invoiceDocumentIdstring

Document id from POST /v1/phone-numbers/port-in/documents (kind=invoice).

focDatetimeRequested?string

Formatdate-time

customerReference?string

Lengthlength <= 100

portType?string

Whether the losing account ports all its numbers (full) or keeps some (partial).

Default"full"

Value in"full" | "partial"

requirements?

Itemsitems <= 30

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.phonenumbers.createPhoneNumberPortIn({
  body: {
    phoneNumbers: [
      'string',
    ],
    endUser: {
      entityName: 'Example',
      authPersonName: 'Example',
      accountNumber: 'string',
      streetAddress: 'string',
      locality: 'string',
      postalCode: 'string',
      countryCode: 'US',
    },
    loaDocumentId: 'loadocument_abc123',
    invoiceDocumentId: 'invoicedocument_abc123',
  },
});
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.phonenumbers.createPhoneNumberPortIn({  body: {    phoneNumbers: [      'string',    ],    endUser: {      entityName: 'Example',      authPersonName: 'Example',      accountNumber: 'string',      streetAddress: 'string',      locality: 'string',      postalCode: 'string',      countryCode: 'US',    },    loaDocumentId: 'loadocument_abc123',    invoiceDocumentId: 'invoicedocument_abc123',  },});console.log(data);

{
  "id": "string",
  "telnyxPortingOrderId": "string",
  "status": "draft",
  "phoneNumbers": [
    "string"
  ],
  "orders": [
    {
      "id": "string",
      "telnyxPortingOrderId": "string",
      "status": "string",
      "phoneNumbers": [
        "string"
      ],
      "error": "string"
    }
  ]
}

{
  "error": "string",
  "type": "invalid_request_error",
  "code": "string",
  "param": "string",
  "platform": "string",
  "platformError": {},
  "details": {}
}

{
  "error": "Unauthorized"
}

Empty

Port numbers in

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

409

422

Port numbers in

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

409

422

application/json

application/json

application/json

application/json

application/json

application/json