Phone Numbers

Country porting requirements

Changed on

The country-specific information a port-in needs BEYOND the LOA, invoice, and account/address details, such as an ID copy, proof of address, a tax id, or a porting code. Call it after the portability check (which returns each number's countryCode and phoneNumberType), render the fields, and pass the collected values as the create request's requirements. US/CA return an empty list.

get/v1/phone-numbers/port-in/requirements

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/phone-numbers/port-in/requirements
  • Auth: HTTP bearer

Query parameters

countrystring required

ISO country of the numbers being ported (a supported port-in country).

numberType'local' | 'mobile' | 'national' | 'toll_free'

The portability check's phoneNumberType. Requirements differ by type.

Response

Requirement fields for the country/type combination.

countrystring
numberTypestring
supportedboolean

false when the combination includes a step that can't be completed through the API (e.g. an in-person identity verification). Porting it needs support.

Changes

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

    • warning

      added the new account enum value to the / response property for the response status

  • d556591af3f6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status