DEVELOPER PLATFORM · REST API
Virtual number API for real SMS verification.
Connect your platform to OTP Pool. Check your balance, discover live number offers, buy an activation and retrieve its SMS code through one REST API.
/activation/countries
List countries with purchasable number routes.
/activation/services
List services with live number stock.
/activation/offers
Get route IDs, operators, stock and payable USD prices.
/activations
Buy a number using an offer ID and idempotency UUID.
{ "data": { "balance": "…" } }
01 / BUILD WITH CONFIDENCE
One API for the number lifecycle.
Use the same wallet and live supplier inventory as the OTP Pool dashboard. Every offer includes its payable USD price, available stock and route ID.
Live number inventory
Browse purchasable services, countries, operators and payable prices.
Scoped integration keys
Grant balance, catalogue, order or billing access as needed.
Complete activation flow
Purchase, poll for SMS and request supplier-confirmed cancellation.
02 / QUICKSTART
Your first virtual number in four steps.
Create a scoped key, inspect live offers, submit an idempotent purchase and poll the activation until an SMS code arrives.
Create a scoped key
Name your integration and grant only the access it needs.
Make your first call
Request the account endpoint from your backend.
Order and poll
Choose a live offer, buy with an idempotency UUID and poll for the SMS code.
curl 'https://otppool.com/api/v1/third-party/account' \ -H 'Accept: application/json' \ -H 'X-API-Key: YOUR_API_KEY'
curl 'https://otppool.com/api/v1/third-party/activation/offers?limit=20' \ -H 'Accept: application/json' \ -H 'X-API-Key: YOUR_API_KEY'
curl 'https://otppool.com/api/v1/third-party/topups?per_page=15' \ -H 'Accept: application/json' \ -H 'X-API-Key: YOUR_API_KEY'
03 / SECURITY
Keep access scoped and server-side.
Pass a scoped key as X-API-Key or a Bearer token over HTTPS. Never expose it in browser code or a public repository.
Your key, your scopes
Create up to five active keys. Grant only the access needed; revoke keys in your dashboard.
Manage API keys →Server-side by default
Keep keys in a secret manager. Browser code can expose them, even when the UI masks them.
X-API-Key: YOUR_API_KEY # or Authorization: Bearer YOUR_API_KEY
04 / REST API V1
Live SMS activation endpoints.
Browse purchasable routes, create activations, read SMS status and cancel eligible orders. Every endpoint lists its method and required key scope.
| Endpoint | Scope | What it returns |
|---|---|---|
GET/account | account.read | Read account profile and balance. |
GET/countries | catalog.read | List enabled countries with optional filters. |
GET/services | catalog.read | List enabled services and platforms. |
GET/offers | catalog.read | Browse site catalogue offers; use activation/offers to buy numbers. |
GET/activation/countries | catalog.read | List countries with purchasable number routes. |
GET/activation/services | catalog.read | List services with live number stock. |
GET/activation/offers | catalog.read | Get route IDs, operators, stock and payable USD prices. |
POST/activations | orders.write | Buy a number using an offer ID and idempotency UUID. |
GET/activations | orders.read | List your activations and their current states. |
GET/activations/{id} | orders.read | Read a number, SMS text and verification code. |
POST/activations/{id}/cancel | orders.write | Request cancellation before SMS arrives. |
GET/topups | billing.read | Read paginated top-up history. |
GET/transactions | billing.read | Read paginated balance entries. |
05 / PRODUCT DISCOVERY
Find numbers ready to purchase.
Filter live offers by service or country. Prices and stock can change, so use the returned offer ID and check the purchase response before confirming an order.
countries
List enabled countries with optional filters.
services
List enabled services and platforms.
offers
Browse site catalogue offers; use activation/offers to buy numbers.
06 / ACCOUNT & BILLING
Reconcile payments and balance movement.
Read paginated top-ups and transactions with a billing-scoped key.
topups
Read paginated top-up history.
transactions
Read paginated balance entries.
Billing endpoints are read-only. Confirm top-up status before treating a payment as credited.
07 / RELIABILITY
Predictable errors and safe retries.
Handle validation, authentication and rate-limit responses explicitly. Reuse the same UUID when retrying a purchase; do not create a second order after an uncertain result.
Access
Check the key, its active state and required scope.
Validation
Review query parameters before retrying.
Rate limits
Use the Retry-After header when limited and poll SMS status about every five seconds.
08 / CHOOSE YOUR WORKFLOW
Choose the right integration route.
Automate the complete SMS activation flow from your server, or manage the same wallet and orders manually in the OTP Pool dashboard.
| Task | Third-party API | Customer dashboard |
|---|---|---|
| Read account balance | Available | Available |
| Browse current catalogue | Available | Available |
| Review billing history | Available | Available |
| Order a number or retrieve SMS | Available | Available |
09 / ANSWERS
Frequently asked questions
Balance, live activation countries, services and offers, number purchases, activation status, cancellation, top-ups and transactions are available.
10 / ENDPOINT REFERENCE
Full reference, with a live tester.
Review current paths, scopes and request examples. Send manual calls in the API docs workspace.
Start your SMS API integration.
Create a scoped key, inspect a live offer and test the activation flow in the interactive reference.