Skip to main content
llms.txtllms-full.txt
REST API Endpoints
v1 Public REST API

eSIM Provisioning API Reference

Integrate instant global eSIM profile activation directly into your mobile app, travel agency platform, or SaaS checkout.

Base URL: https://api.vsim.dev/v1
Auth Header: Authorization: Bearer vril_live_•••
GET/api/esim/packages
Public / Optional API Key

Retrieve cached eSIM packages with country, carrier, price, and data balance metadata.

Response Preview (200 OK)
{
  "success": true,
  "data": [
    {
      "packageCode": "JP_10GB_30D",
      "country": "Japan",
      "countryCode": "JP",
      "dataMb": 10240,
      "durationDays": 30,
      "retailPriceUsd": 12.00,
      "carrier": "KDDI + SoftBank"
    }
  ]
}
POST/api/esim/orders
Bearer vril_live_••••

Provision a new eSIM order asynchronously. Triggers QR code generation.

Response Preview (200 OK)
{
  "orderNo": "ORD-2026-84920",
  "status": "processing",
  "iccid": "89814400000072184931",
  "qrCodeUrl": "https://cdn.vsim.dev/qr/89814400000072184931.png",
  "activationCode": "LPA:1$smdp.io$89814400000072184931"
}
GET/api/esim/sims/{iccid}
Bearer vril_live_••••

Query real-time data consumption and validity window for an active SIM card.

Response Preview (200 OK)
{
  "iccid": "89814400000072184931",
  "status": "ACTIVE",
  "totalDataBytes": 10737418240,
  "usedDataBytes": 3435973836,
  "remainingDataBytes": 7301444404,
  "expiresAt": "2026-09-26T18:30:00.000Z"
}
POST/api/webhooks/whop
Whop Webhook Signature

Webhook receiver for Whop membership and payment events.

Response Preview (200 OK)
{
  "received": true,
  "event": "membership.went_valid"
}
VRIL Global Node SDK@vril-labs/sdk

Unified TypeScript client for plan discovery, instant profile provisioning, and QR activation.

import { VrilEsimClient } from '@vril-labs/sdk';

const client = new VrilEsimClient({ apiKey: process.env.VRIL_API_KEY });

// 1. Fetch available packages
const packages = await client.packages.list({ country: 'US' });

// 2. Purchase and provision eSIM
const order = await client.orders.create({
  packageCode: packages[0].code,
  customerEmail: 'traveler@vsim.dev',
});

// 3. Retrieve LPA code & QR
console.log(order.lpaCode, order.qrCodeUrl);
VRIL Telemetry SDK@vril-labs/client

High-throughput cellular telemetry, real-time data consumption alerts, and multi-carrier failover network health.

import { VrilTelemetryClient } from '@vril-labs/client';

const telemetry = new VrilTelemetryClient({ apiKey: process.env.VRIL_API_KEY });

// 1. Query real-time data consumption
const usage = await telemetry.sim.getUsage('89814400000072184931');

// 2. Check multi-carrier failover network health
const health = await telemetry.network.checkStatus();
console.log(health.status, health.latencyMs);