Title here
Summary here
Retail API
đź“ť Overview
The Retail API enables you to embed SMS verification into your own mobile or web app while we handle customers, balances, and activations. It offers endpoints to create users, top up balances, assign phone numbers, receive OTPs, retry or cancel activations, and track usage history—all with billing triggered only upon successful SMS reception.
🔑 Key Features
- Create and manage customer accounts
- Add or deduct balance per customer
- Order temporary phone numbers
- Create activations for customers
- Retrieve received SMS text and OTP code
- Retry failed SMS activations
- Get SMS text and OTP code
- Get active activations
- Cancel active activations
- Retrieve activation history
- Check customer balance
- View customer transaction history
- List supported countries
- List eligible services
- Fetch pricing by country or service
- Enforce per-activation price cap
- Supports sandbox & production
- Billing only on received SMS
đź•® Documentation
Retail API reference
OpenAPI / Swagger
Tip
- Manage your customers in Retail section of web dashboard .
- Use the sandbox environment for testing without incurring costs.
Retail Customers Success Rate Note
We may pause retail customer accounts to prevent abuse and ensure fair usage for all customers. You can change a customer’s account status from the dashboard. The customer will be notified by email when their account is paused.
Prev
Activation APINext
Alternative API