API Documentation
Integrate SMS verification into your applications
Getting Started
Base URL: https://vrenum.onrender.com/api
All authenticated endpoints require a Bearer token in the Authorization header.
API access requires a Pro tier or above. Generate API keys from your API Keys page.
Authentication
Include your token in every request:
Authorization: Bearer your_access_token
Or use an API key:
X-API-Key: nsk_live_your_api_key
Authentication
POST
/api/auth/register
Create a new account
POST
/api/auth/login
Login and receive JWT token
GET
/api/auth/me
Auth Required
Get current user info
POST
/api/auth/logout
Auth Required
Revoke current token
SMS Verification
POST
/api/verify/create
Auth Required
Request a new SMS verification number
GET
/api/verify/status/{id}
Auth Required
Check verification status and retrieve SMS code
GET
/api/verify/{id}/messages
Auth Required
Get messages received for a verification
GET
/api/verify/history
Auth Required
List past verifications
Wallet & Payments
GET
/api/v1/wallet/stats
Auth Required
Get wallet balance and spending stats
POST
/api/v1/wallet/paystack/initialize
Auth Required
Initialize a Paystack payment to add credits
GET
/api/v1/wallet/history
Auth Required
Transaction history with filtering
GET
/api/v1/wallet/export/csv
Auth Required
Export transactions as CSV
Tiers & Billing
GET
/api/v1/billing/tiers
List all available tiers
GET
/api/v1/billing/tiers/current
Auth Required
Get your current tier and quota usage
Countries & Services
GET
/api/countries
List available countries
GET
/api/services
List all available services
API Keys
GET
/api/keys
Pro+
List your API keys
Requires Pro tier or above
POST
/api/keys/generate
Pro+
Generate a new API key
Requires Pro tier or above
DELETE
/api/keys/{id}
Pro+
Revoke an API key
Requires Pro tier or above
Rate Limits
API requests are rate-limited per tier:
• Freemium/PAYG: 60 requests/minute
• Pro: 300 requests/minute
• Custom: 1000 requests/minute
Rate limit headers are included in every response: X-RateLimit-Remaining, X-RateLimit-Reset
Need Help?
Check our FAQ or contact support.
Interactive API explorer available at /docs (Swagger UI) when running locally.