Skip to main content
POST
phone.number.purchase-status

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
ref
string
required

The ref returned by phone.number.purchase or phone.number.identity.submit.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

status
enum<string>
required

Active only after activation is confirmed.

Available options:
active,
verification_required,
pending
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
phoneNumber
string

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

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

Action needed to continue verification.

monthlyPriceUsd
number

What you are charged per month, in US dollars: the price fixed when the number activated, or before that the price quoted when you ordered it.

Required range: x >= 0