Skip to main content

Welcome to Vellosim API

The Vellosim API provides a comprehensive solution for integrating eSIM services into your application or website. Our API enables you to offer global connectivity solutions to your customers with ease.

Base URL

Authentication

All API requests require authentication using an API Key in the X-API-Key header. Production:
Testing/Sandbox:
Use keys with vls_live_ prefix for production and vls_test_ prefix for testing/sandbox. The API automatically routes requests to the appropriate environment based on your key prefix.

Getting Your API Key

  1. Log in to your Vellosim dashboard
  2. Navigate to Developer β†’ API Keys
  3. Click Generate New API Key
  4. Copy and securely store your API key
Keep your API key secure! Never share it publicly or commit it to version control. The API key is shown only once during creation.

Request Format

Headers

Include these headers in all requests:

HTTP Methods

Response Format

All API responses are returned in JSON format with consistent structure.

Success Response

Error Response

Status Codes

Rate Limiting

API requests are rate-limited based on your plan: Rate limit information is included in response headers:

Pagination

Endpoints that return lists support pagination:

Pagination Response

API Endpoints

Wallet

Get Balance

Retrieve your current wallet balance

eSIM

Get Regions

Get all available regions (countries & continents)

Get Packages

Get eSIM packages filtered by region

Purchase

Buy eSIM

Purchase an eSIM package

Orders

My eSIMs

Get all your eSIM orders with filtering

Get Order

Get specific order details by ID

SDKs and Libraries

We’re working on official SDKs for popular languages. In the meantime, you can use standard HTTP clients like:
  • JavaScript/TypeScript: fetch, axios
  • Python: requests, httpx
  • PHP: cURL, Guzzle
  • Java/Kotlin: OkHttp, Retrofit
  • Swift: URLSession, Alamofire

Support

Need help integrating the API?
Start with the Quickstart Guide to make your first API call in minutes!