Skip to main content
POST
phone.number.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
phoneNumber
string
required

Phone number in E.164 format, such as +14155550100.

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

Response

The result

phoneNumber
string
required

Phone number in E.164 format, such as +14155550100.

Pattern: ^\+[1-9]\d{6,14}$
status
enum<string>
required

Current number lifecycle state.

Available options:
pending_payment,
pending_regulatory,
regulatory_declined,
provisioning,
verifying,
active,
suspended,
releasing,
released
trunkAttached
boolean
required

Whether external call routing is attached.

country
string

Two-letter country code.

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

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free
action
object

Action needed to continue verification.