eSIM API — Global eSIM Provisioning & Integration API

Q: How many eSIM providers can I access through the API?

Our eSIM API connects you to multiple eSIM providers through a single integration point. Rather than integrating with each provider individually, you get access to a diverse catalog of packages covering 200+ countries. Each API response includes provider details, pricing, coverage, and data packages so you can compare and select the best option for your customers.

Q: What authentication does the eSIM API use?

The eSIM API uses HTTP Digest Authentication. You authenticate every request using your TCXC login credentials passed via standard Digest Auth headers. All API calls are made over HTTPS to ensure data security. We also provide a sandbox environment with separate credentials for safe testing before going live.

Q: What is the iOS install link in the API response?

The ios_install_link is a special URL returned when you purchase an eSIM through our API. It enables one-tap eSIM activation on Apple devices—when a customer clicks this link on their iPhone or iPad, it automatically opens the eSIM setup flow with all provisioning details pre-filled. No QR code scanning required. This significantly simplifies the activation process for iOS users.

Q: Is there a sandbox environment for testing?

Yes. We provide a full sandbox environment where you can test all eSIM API endpoints—search, purchase, and top-up—without incurring real charges or provisioning actual eSIMs. The sandbox mirrors the production API exactly, so your integration code works identically in both environments. Switch to production by simply changing your credentials when you're ready to go live.

API OVERVIEW

A Developer-First eSIM API

One API, multiple eSIM providers. Search, purchase, and manage eSIM profiles globally with standard REST endpoints and JSON responses.

Search and Discovery

Query eSIM packages by country, data size, validity, and provider. Compare pricing across multiple eSIM providers in real-time through a single API call. Filter results by region, data volume, or price to find the perfect package for your customers.

Purchase and Provision

Instant eSIM provisioning with QR code, LPA string, and iOS install link returned in the response. Sub-second activation with comprehensive error handling ensures reliable provisioning at any scale across all supported devices.

Top-up and Manage

Extend data or validity on active eSIMs with a single API call. Full lifecycle management through the eSIM developer API lets you handle renewals, check usage status, and manage your entire eSIM inventory programmatically.

eSIM API ENDPOINTS

eSIM API Integration: 3 Simple Endpoints to Go Live

Our eSIM API documentation covers everything you need. Each endpoint follows REST conventions with JSON request and response bodies. Below are live examples you can test immediately with your API credentials.

Search Marketplace

Filter by country, data size, validity, price, or seller (GET)

JSON

{
  "status": "success",
  "search_results": [
    {
      "i_esim_package": 175,
      "i_vendor": 42,
      "vendor_login": "Acme Networks",
      "name": "Turkey 1 GB 7 Days",
      "country_code": "tr",
      "data_gb": 1,
      "validity_days": 7,
      "price_with_fee": "1.10",
      "sms": 0,
      "voice": 0,
      "networks": "Turkcell, Vodafone TR",
      "supported_countries": [
        { "country_name": "TURKEY", "country_code": "TR" }
      ]
    }
  ]
}

Simple JSON API

Standard HTTP methods, JSON responses, cURL-friendly endpoints

Sub-Second Provisioning

Real-time inventory sync and instant eSIM activation

Multi-Provider Access

Single integration, 200+ countries, multiple eSIM vendors

Explore Full eSIM API Reference

KEY FEATURES

Why Developers Choose Our eSIM API

Built for production workloads, our eSIM developer API combines enterprise reliability with developer-friendly design. From multi-provider access to full lifecycle management, every feature is designed to reduce your time to market and simplify ongoing operations.

Multi-Provider Access

One eSIM API, multiple providers. Compare pricing and coverage across all connected eSIM providers without building separate integrations for each. Aggregate the best inventory from the global eSIM ecosystem through a single endpoint.

Universal eSIM Support

Default universal eSIMs let end users install once and add any country in seconds. No repeated installations for travelers or enterprise users. Reduce support overhead and dramatically improve the customer experience.

Instant QR Provisioning

Generate QR codes and iOS install links instantly through the eSIM provisioning API. Sub-second activation globally with Base64-encoded QR images ready for display in your application or email delivery.

Production-Ready

Built for production workloads with comprehensive error handling, rate limiting, and a full sandbox environment for testing before deployment.

Real-Time Inventory

Live pricing and availability from all connected providers. No stale data, no pricing surprises. The eSIM REST API returns current package availability and pricing with every search query so your users always see accurate information.

Full Lifecycle Management

Search, purchase, top-up, and monitor eSIMs through the complete lifecycle via the global eSIM API. Manage your entire eSIM inventory programmatically with full visibility into order status and provisioning state.

QUICK START

Get Started with Our eSIM API in Minutes

From sign-up to your first eSIM provisioning call, the integration process is designed to be straightforward. Our eSIM API documentation includes code samples, sandbox credentials, and step-by-step guides to get you live quickly.

Create Account

Sign up for a TelecomsXchange account and receive your API credentials. Your account includes sandbox access so you can start testing immediately without any financial commitment.

Test in Sandbox

Use the sandbox environment to test all three eSIM API endpoints. The sandbox mirrors production exactly, so you can validate your integration logic, error handling, and response parsing without any risk.

Integrate

Add the eSIM API calls to your application. Whether you are using JavaScript, Python, PHP, or any language with HTTP support, the REST API works with standard HTTP clients. Refer to our eSIM API documentation for complete code examples.

Go Live

Switch to production credentials and start provisioning eSIMs globally. Monitor your usage through the dashboard, scale confidently with our 99.9% uptime infrastructure, and access developer support whenever you need it.

FREQUENTLY ASKED QUESTIONS

eSIM API: Developer Questions

Common questions about integrating and using our eSIM provisioning API

What is an eSIM API and how does it work?

An eSIM API (Application Programming Interface) allows developers to integrate eSIM provisioning capabilities directly into their applications. Through our eSIM API, you can programmatically search for eSIM packages across 200+ countries, purchase and provision eSIMs instantly (receiving QR codes and LPA strings), and manage top-ups and lifecycle—all via standard REST API calls. This eliminates the need for manual eSIM management and enables fully automated digital experiences.

How many eSIM providers can I access through the API?

What is a Universal eSIM and why does the API default to it?

A Universal eSIM is our default eSIM type that allows end users to install once and add data for any supported country—no reinstallation needed. Traditional regional eSIMs require a new installation for each trip. Universal eSIMs dramatically improve customer experience and reduce support overhead. Our eSIM API provisions Universal eSIMs by default, so your customers install once and simply top-up for new destinations.

What authentication does the eSIM API use?

What is the iOS install link in the API response?

How fast is eSIM provisioning through the API?

eSIM provisioning through our API is near-instant. From the moment you make the purchase API call, you receive the QR code, LPA string, and iOS install link in the response within sub-second timeframes. The eSIM is immediately ready for activation on the end user's device. This speed enables real-time use cases like point-of-sale activation, travel booking integrations, and instant connectivity apps.

Is there a sandbox environment for testing?

Can I white-label eSIM services using the API?

Yes. Our eSIM API is designed for white-label integration. The QR codes, install links, and provisioning flows can be embedded directly in your branded application without any TCXC branding visible to your end users. Many travel apps, mobile operators, and enterprise platforms use our eSIM API to offer branded eSIM services. Learn more about our eSIM Exchange platform for additional white-label options.

Start Building with the eSIM API Today

Use our global eSIM API to power connectivity in your application. Get started with free sandbox access and ship your eSIM integration when you're ready.

Get API Key

View Full Docs

eSIM Exchange

Free sandbox access -- No minimum commitment -- Developer support