Phone Number Porting API

Determining portability of phone numbers using API

Run a portability check

Runs a portability check, returning the results immediately.

SecuritybearerAuth
Request
Request Body schema: application/json
required
phone_numbers
Array of strings

The list of +E.164 formatted phone numbers to check for portability

Responses
201

PortabilityCheck Response

Response Schema: application/json
Array of objects (PortabilityCheckDetails)
Array
fast_portable
boolean

Indicates whether this phone number is FastPort eligible

not_portable_reason
string

If this phone number is not portable, explains why. Empty string if the number is portable.

phone_number
string

The +E.164 formatted phone number this result is about

portable
boolean

Indicates whether this phone number is portable

record_type
string

Identifies the type of the resource.

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

post/portability_checks
Request samples
application/json
{
  • "phone_numbers": [
    • "+13035550000",
    • "+13035550001",
    • "+13035550002"
    ]
}
Response samples
application/json
{
  • "data": [
    • {
      • "fast_portable": true,
      • "not_portable_reason": "No coverage",
      • "phone_number": "+13125550123",
      • "portable": true,
      • "record_type": "portability_check_result"
      }
    ]
}