REST API v2.4 Reference

API Documentation & Developer Sandbox

Integrate virtual phone number allocation and SMS OTP verification into your apps and automation scripts.

API Overview

The iVAS OTP API is organized around REST standards. All requests accept JSON or URL-encoded form data and return standard JSON responses with predictable HTTP status codes.

Base API URL: /public/api

HTTPS / HTTP

Authentication

Authenticate all API requests by providing your private API key in the request header or query string.

Option 1 (Recommended): Custom Header

X-API-Key: otp_live_your_secret_key

Option 2: Bearer Token

Authorization: Bearer otp_live_your_secret_key

Option 3: Query Parameter

/public/api/balance?api_key=otp_live_your_secret_key

Interactive Live API Console

Test actual API endpoints directly against the backend server

Live Sandbox

API Key Default demo key preloaded. You can replace with your key.

Endpoint Action

Server Response (JSON):

// Click "Send API Request" to test endpoint...

POST

/api/request

Allocates and reserves an active virtual number for your specified service and country. Automatically deducts the service cost from your wallet balance.

Request Parameters (JSON or POST):

Field	Type	Required	Description
service	string	Yes	Service code (e.g. whatsapp, telegram, google)
country	string	No	ISO-2 country code (default: US)

GET

/api/status

Poll the current status of an order. Returns waiting_otp, completed, expired, or cancelled.

GET

/api/otp

Quick fetch endpoint. If SMS has arrived, directly returns the extracted OTP code and complete SMS message text.

POST

/api/cancel

Cancels an active request that hasn't received an OTP yet. Releases the number and refunds the full held balance immediately back to your wallet.