Introduction

Airvoy provides zero-rated connectivity for mobile applications. This means your users can access your app and its essential services without consuming their personal mobile data. Our API allows you to programmatically provision eSIMs, define accessible domains, and manage connectivity policies at scale.

This solution is perfect for travel apps, fintech platforms, ride-sharing services, and any other application where guaranteed, continuous connectivity is critical to the user experience.

What is Zero-Rating?

Zero-rating enables users to access specific apps and websites without depleting their personal data plans. With Airvoy, you simply define the domains you want to zero-rate, and we handle the complex network-level routing to make it happen.

When users install an Airvoy eSIM tied to your app, they instantly gain free data access to your whitelisted domains. This includes your core API endpoints, CDNs, payment processors, and any essential third-party services your application relies on.

How It Works

Integrating Airvoy into your platform involves three core steps:

1. 1.Create a Group — Use the dashboard to define a collection of zero-rated domains (e.g., your APIs, CDNs, and third-party integrations).
2. 2.Provision eSIMs — Generate eSIMs linked to your group via our API. Each eSIM automatically inherits your domain whitelist and can be configured with individual data limits.
3. 3.Distribute to Users — Deliver the eSIM activation codes to your users. Once installed on their devices, they immediately gain zero-rated access to your services.

curl -X POST https://api.airvoy.app/v1/esims \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "group_id": "de4349d8-94a5-4261-9efb-89086baa22c3",
    "quantity": 1,
    "email": "user@example.com"
  }'

{
  "data": {
    "esims": [
      {
        "id": "0d7db4a0-7cf4-440c-9256-4a3c08a6998c",
        "user_id": "e1e4444e-a166-4636-9b3a-086d6e300cbe",
        "group_id": "de4349d8-94a5-4261-9efb-89086baa22c3",
        "iccid": "89311210000005914313",
        "status": "enabled",
        "imsi": "311210394316585",
        "msisdn": "+19702874806",
        "activation_code": "LPA:1$smdpplus.net$IL3UMEUTLB935KFAMENKU8Y5",
        "end_user_email": "user@example.com",
        "data_limit_mb": 500.0,
        "full_internet": false,
        "created_at": "2026-02-08T20:15:53.571181+00:00",
        "updated_at": "2026-02-08T20:15:53.571181+00:00"
      }
    ],
    "billing": {
      "charged": 0.7,
      "new_balance": 22.3
    }
  }
}

Groups

A group represents a connectivity policy detailing which domains are accessible to its assigned eSIMs. Created via the dashboard, a group automatically provisions all the necessary underlying network infrastructure, including a dedicated VPC, firewall, and WireGuard tunnel.

Domain matching is smart: adding api.yourapp.com to a group automatically whitelists all of its subdomains, such as v1.api.yourapp.com and v2.api.yourapp.com.

Note: Through the API, groups are currently read-only. You can list them and retrieve their details programmatically, but group creation and domain management must be performed through the dashboard.

eSIM Provisioning

Once your group is configured, you can start provisioning eSIMs via the API. Every generated eSIM includes an activation code (LPA format) that users can scan as a QR code or enter manually into their device's cellular settings.

You maintain full lifecycle control over your eSIMs: they can be enabled, disabled, or deleted at any time. You can also enforce per-eSIM data caps (in MB) to tightly manage usage and control costs.

Getting Started

Ready to build? Follow these steps to get started:

1. 1.Get Your API Key — Visit the dashboard to create an account and generate your API credentials.
2. 2.Add Funds — Top up your account (a minimum balance of $250 is required to provision group infrastructure).
3. 3.Create a Group — Define your domain whitelist and spin up your infrastructure via the dashboard.
4. 4.Follow the Quickstart — Jump into our Quickstart guide to issue your first eSIM via the API.

Need help? Reach out to our team at support@routedlabs.com.