Sign in
Phone Numbers

Check portability

Pre-flight portability check: whether each number can be ported in, whether it qualifies for FastPort, and its current carrier and line type where the carrier lookup knows them, BEFORE the user commits to a port order (LOA, invoice, service address). Read-only; creates no order and bills nothing.

Works without an API key for one number per request. Keyless calls are what the checker at https://zernio.com/port-your-number makes: they must come from that page (a browser bot check rejects scripted callers with 401), are limited per IP (3 a minute, 10 a day) and by a shared daily budget (429 once spent), because each check runs a paid carrier lookup. Each portable keyless result carries a claimId and a claimUrl: a signup link that opens the dashboard's port form with the number filled in. Send an API key to check up to 50 numbers without those limits.

post/v1/phone-numbers/port-in/check

Request body

phoneNumbersstring[] required

E.164 numbers to check, e.g. +13035550000. At most one without an API key.

claimLinksboolean

true adds claimId and claimUrl to portable results even when you send an API key, e.g. to hand a user a signup link that opens the port form with their number.

Response

Per-number portability.

Changes

Changed in 1 of the 56 revisions of this API.7

  • 2c04683ce6947See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog