Skip to main content
POST
Purchase number

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Body

application/json
phone_number
string
required
Example:

"+972551234567"

Response

200 - application/json

Purchase result. Israeli numbers always start as pending_requirements — they are never active at purchase time. Activation happens later, once regulatory requirements clear (usually 1–3 business days), promoted by a background job.

success
boolean
phoneNumber
string
monthlyPrice
integer

Monthly cost in cents

currency
string
status
enum<string>

Always pending_requirements at purchase time for Israeli numbers.

Available options:
pending_requirements
message
string

Human-readable status note (e.g. regulatory-review notice).