v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Phone Numbers

Country porting requirements

The country-specific information a port-in needs BEYOND the LOA, invoice, and account/address details — e.g. 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

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.