Skip to main content

Verify phone number portability

POST 
/origination/porting/portability_checks

Verifies the portability of a list of phone numbers.

Example request body

{
  "phone_numbers": [
    {
      "phone_number": "+13125354200"
    },
    {
      "phone_number": "+13125354500"
    }
  ]
}

Request ​

Body

required

List of phone numbers to check portability on

    phone_numbers

    undefined[]

    required

    List of phone numbers to check phone numbers

  • Array [

    • phone_number stringrequired

    E164 formatted phone number

  • ]

    • List of phone numbers to check phone numbers

Responses ​

201: Portability check response

Schema

  • Array [

    • phone_numbers

    undefined[]

    required

    List of phone numbers to check phone numbers on

  • Array [

    • raw_number stringrequired

    The phone number as it was submitted

    e164_number string

    The phone number parsed into e164 format

    portable booleanrequired

    Is the number portable?

    portability_status string

    Possible values: [pending, confirmed, provisional]

    Specifies whether Telnyx was able to confirm portability for the rate center for this number

    carrier_name string

    The underlying carrier associated with the phone number

    coverage_category stringrequired

    Possible values: [nanp_generic, nanp_toll_free, international, invalid]

    Category of phone number. 'nanp_toll_free' indicates a toll free number on the North American Numbering Plan (NANP). 'nanp_generic' indicates a non toll-free NANP phone number. 'international' indicates a non-NANP phone number.

    non_portable_reason string

    Possible values: [invalid_phone_number, lrn_data_not_found, no_coverage, already_being_ported, telnyx_number]

    Reason the phone number is not portable

  • ]

    • List of phone numbers to check phone numbers on

  • ]

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Request samples

curl -L 'https://api.telnyx.com/origination/porting/portability_checks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "phone_numbers": [
    {
      "phone_number": "string"
    }
  ]
}'

Response samples

[
  {
    "phone_numbers": [
      {
        "raw_number": "string",
        "e164_number": "string",
        "portable": true,
        "portability_status": "pending",
        "carrier_name": "string",
        "coverage_category": "nanp_generic",
        "non_portable_reason": "invalid_phone_number"
      }
    ]
  }
]