Skip to main content

Run a portability check

POST 
/portability_checks

Runs a portability check, returning the results immediately.

Request​

Body

required

    phone_numbers string[]

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

Responses​

201: PortabilityCheck Response

Schema

    data

    object[]

  • Array [

    • record_type string

    Identifies the type of the resource.

    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

  • ]

401: Unauthorized

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

Request samples

curl -L 'https://api.telnyx.com/v2/portability_checks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "phone_numbers": [
    "+13035550000",
    "+13035550001",
    "+13035550002"
  ]
}'

Response samples

{
  "data": [
    {
      "record_type": "portability_check_result",
      "fast_portable": true,
      "not_portable_reason": "No coverage",
      "phone_number": "+13125550123",
      "portable": true
    }
  ]
}