Get subscription in-porting

Error

A valid request URL is required to generate request examples

{
  "msisdn": "+15551234567",
  "status": "PENDING",
  "direction": "INBOUND",
  "details": {
    "firstName": "<string>",
    "lastName": "<string>",
    "address": {
      "street1": "500 S Main St",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "street2": "Apt 1",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "accountNumber": "<string>",
    "passcode": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "scheduledAt": "2023-12-25",
  "updatedAt": "2023-11-07T05:31:56Z"
}

GET

subscriptions

{subscriptionId}

in-porting

Error

A valid request URL is required to generate request examples

{
  "msisdn": "+15551234567",
  "status": "PENDING",
  "direction": "INBOUND",
  "details": {
    "firstName": "<string>",
    "lastName": "<string>",
    "address": {
      "street1": "500 S Main St",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "street2": "Apt 1",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "accountNumber": "<string>",
    "passcode": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "scheduledAt": "2023-12-25",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-Api-Key

string

header

required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

subscriptionId

string

required

The unique identifier of the subscription.

Response

Porting information retrieved successfully.

A request to port a number into or out of the system.

msisdn

string

required

The phone number to be ported, in E.164 format.

Example:

"+15551234567"

status

enum<string>

required

Current status of the porting process.

Available options:

PENDING,

IN_PROGRESS,

SCHEDULED,

COMPLETED,

FAILED

direction

enum<string>

required

The direction of the number porting, either inbound (to us) or outbound (from us).

Available options:

INBOUND,

OUTBOUND

details

USPortingDetails · object

required

description: Detailed information required for the porting process, varying by country and provider.

USPortingDetails
SwedishPortingDetails

Show child attributes

details.firstName

string

required

The first name of the person requesting the port.

details.lastName

string

required

The last name of the person requesting the port.

details.address

object

required

Show child attributes

details.address.street1

string

required

The first line of the address, typically street and house number.

Example:

"500 S Main St"

details.address.city

string

required

The city or municipality of the address.

Example:

"Natick"

details.address.zip

string

required

The zip code of the address.

Depending on the country, this may be referred to as a postal code or postcode.

Specifically for US addresses, the zip can include the optional four-digit extension (e.g., '27604-5121').

Example:

"01701"

details.address.country

string

required

The two-letter country abbreviation (e.g., 'US' for United States, 'SE' for Sweden).

Example:

"US"

details.address.street2

string

The second line of the address, typically apartment, suite, unit, building, floor, etc.

Example:

"Apt 1"

details.address.state

string

For countries that use states or regions, the state or administrative area code (e.g., 'CA' for California in the United States).

Example:

"CA"

details.address.region

string

A province, region, or territory name, applicable in certain countries (e.g., 'Ontario' in Canada, 'Sindh' in Pakistan).

details.address.attention

string

An optional line for specifying a person, department, or attention to a specific entity within an address.

details.accountNumber

string

The account number with the current provider.

If not provided here, must be provided in the future for activation on-demand.

details.passcode

string

The passcode or pin associated with the account at the current provider.

If not provided here, must be provided in the future for activation on-demand.

createdAt

string<date-time>

required

The timestamp when the porting request was created.

scheduledAt

string<date>

The date when the porting is scheduled to occur.

updatedAt

string<date-time>

The timestamp of the last update to the porting request.

Get eSIM QR code Update subscription porting details

⌘I

Getting started

Overview

API reference

Authorizations

Path Parameters

Response