Skip to main content
POST
phone.number.availability.check

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>

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free
sms
boolean
default:false

Check only the SMS-capable pool.

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
available
boolean
required

Whether deliverable inventory exists.

addressConstraint
enum<string>
required

Required geographic match for the registration address.

Available options:
geo,
country,
none
areas
string[]
required

Required address areas.

Maximum string length: 200
areaOptions
object[]
required

Available areas.

monthlyPriceUsd
number

What you are charged per month, in US dollars: the current price of a new number of this country and type. It is checked again when you buy.

Required range: x >= 0
preOrderable
boolean

Whether an out-of-stock pair can be pre-ordered.