Skip to main content
POST
/
tools
/
check-porting-eligibility
{
  "msisdn": "+15551234567",
  "eligible": true,
  "networkProviderId": "tmobile-us",
  "requirements": {
    "accountNumber": "REQUIRED",
    "passcode": "REQUIRED",
    "address.zip": "VERIFIED"
  },
  "ineligibilityReason": "Number not found or not portable"
}

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.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum length: 256

Body

application/json

Phone number to check for porting eligibility.

Request to check if a phone number is eligible for porting.

​
msisdn
string<phone>
required

The phone number to check for porting eligibility.

Example:

"+15551234567"

Response

Porting eligibility check completed.

Result of number porting eligibility check.

​
msisdn
string<phone>
required

The phone number that was checked.

Example:

"+15551234567"

​
eligible
boolean
required

Whether the number is eligible for porting.

Example:

true

​
networkProviderId
string

The identifier for the current network provider, if detectable

Example:

"tmobile-us"

​
requirements
object

Information that may or must be collected from the user before porting the number, if any.

Typically varies between carriers, countries, and customer types.

Example:
{
  "accountNumber": "REQUIRED",
  "passcode": "REQUIRED",
  "address.zip": "VERIFIED"
}
​
ineligibilityReason
string

Reason why number is not eligible (only present if eligible is false).

Example:

"Number not found or not portable"

⌘I