Skip to main content
POST
phone.number.port-requirements.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
country
string
required

Two-letter country code.

Pattern: ^[A-Z]{2}$
type
enum<string>
default:local

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free

Response

The result

country
string
required

Two-letter country code.

Pattern: ^[A-Z]{2}$
type
enum<string>
required

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free
supported
boolean
required

Whether all steps can be completed through the API.

fields
object[]
required

Additional porting requirements.