VoidMobVoidMob Docs

Developers

Build on VoidMob with the REST API and the MCP server. An overview of API keys, authentication, webhooks, idempotency and rate limits.


The SMS, eSIM and proxy services you use in the dashboard are also available from code: through the REST API, or through the MCP server for AI agents.

REST API

  • Base URL: https://dashboard.voidmob.com/api/v1
  • Authentication: send your key as Authorization: Bearer <key>. Keys start with vmk_live_ followed by 32 characters
  • Format: JSON in and out. Responses are wrapped as { "success": true, "data": ... }, or { "success": false, "error": ... } on failure
  • Billing: purchases through the API are paid from your wallet balance, the same as in the dashboard

What It Covers

AreaWhat you can do
SMS verificationsList services with quoted prices, rent numbers, read codes, cancel, reuse
Long-term rentalsRent for 3 to 30 days, read messages, re-rent, turn auto-renew on or off
Dedicated numbersList countries, buy monthly numbers, read messages, turn auto-renew on or off
eSIMBrowse the catalog, buy eSIMs, get the QR code, check usage, buy top-ups
ProxiesBuy shared GB plans and Standard dedicated proxies, manage proxy lists, top up, renew, rotate IPs, regenerate passwords
AccountCheck your balance and rate limits

Premium dedicated proxies are bought and set up in the dashboard. The API can list them and rotate their IP, but it doesn't return their connection details.

API Keys

API access is open to every account. Create keys yourself in the dashboard under Developers > API Keys. A new key is shown only once, so store it somewhere safe right away. You can revoke a key at any time. To rotate a key, create a new one, deploy it, then revoke the old one.

A key can be restricted to an IP allowlist. Contact support to set one up.

Webhooks

Register HTTPS endpoints under Developers > Webhooks (or through the API) to receive signed POST requests when something changes: a code arrives, a rental renews, a proxy becomes ready or runs low on data, an eSIM top-up is added, and more. Each delivery carries an X-VoidMob-Signature header (HMAC-SHA256) that you verify with the endpoint's signing secret. Failed deliveries are retried with backoff.

Webhooks fire for orders created through the API. Orders placed in the dashboard don't send webhook events.

Idempotency and Rate Limits

  • Idempotency: most write requests require an Idempotency-Key header, so a retried request takes effect only once
  • Rate limits: limits apply per account, per minute, and all your keys share them. Every response includes X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a 429 response includes Retry-After. Need a higher limit? Contact us

Proxy Connections from Code

Proxy lists work the same from code as from the dashboard: see the Connection Guide. For one credential across the whole shared pool, the API also offers Flex mode. Request its credentials with POST /v1/proxies/:id/flex_credentials, then connect to proxy.voidmob.com:10092 and set location, session and rotation per request through username parameters. Flex credentials are only available through the API.

MCP Server for AI Agents

The open-source MCP server, @voidmob/mcp, lets AI agents such as Claude or Cursor rent numbers, read codes, buy eSIMs and manage proxies with your API key. Setup and the full tool list are on the MCP server page.

Full API Reference

On this page