Endpoint
Overview
Rent a temporary US phone number to receive a single SMS verification code. The price depends on the service and is deducted from your balance immediately. If the rental fails (for example, no numbers available), the charge is refunded automatically. After renting, pollGET /sms/code for the code, or POST /sms/cancel to cancel and get refunded.
Supported Services & Pricing
Supported services:apple, google, instagram, tiktok. Prices adjust with availability and may change at any time — fetch current prices from GET /sms/services.
The
cost field in the response is the exact amount charged, and a cancel or failed rental always refunds that exact amount.Request Body
The service the verification code is for:
apple, google, instagram, or tiktok.Response
Rental responses do not use the
ok envelope — success is a plain JSON object; errors are {"error": "..."} with a non-200 status. See Response.The rented phone number. Use it in the service’s signup/verification flow.
Credits charged for this rental.
The service the rental is for.
Rental transaction ID — needed to poll for the code or cancel.
Errors
| Status | Error | Meaning |
|---|---|---|
| 400 | Unsupported service. Supported: 'apple', 'google', 'instagram', 'tiktok' | Unsupported service value |
| 402 | Insufficient balance | Not enough credits (no charge made) |
| 409 | No numbers available right now | Upstream has no numbers; charge refunded |
| 502 | Service temporarily unavailable | Upstream failure; charge refunded |
| 503 | Number rental is not configured | Rental is disabled on this deployment |