Introduction

Airvoy provides zero-rated connectivity for mobile applications — meaning your users can access your app and specific domains without using their mobile data. Our API lets you provision eSIMs, define which domains are accessible, and manage connectivity policies programmatically.

This is ideal for travel apps, fintech platforms, ride-sharing services, and any application where continuous connectivity is essential for user experience.

We also offer native SDKs with pre-built UI components for Swift, Flutter, and React Native — so you can integrate eSIM provisioning, usage tracking, and installation flows into your app in minutes.

What is Zero-Rating?

Zero-rating allows users to access specific apps and websites without it counting against their data plan. With Airvoy, you define exactly which domains are zero-rated, and we handle the network-level implementation.

When a user installs an Airvoy eSIM linked to your application, they receive free data access to your whitelisted domains — your API endpoints, CDN, payment processors, and any third-party services your app depends on.

How It Works

The integration process involves three main steps:

1. 1.Create a Group — Define a collection of domains that should be zero-rated via the dashboard. This includes your APIs, CDNs, and any third-party services.
2. 2.Provision eSIMs — Generate eSIMs linked to your group via the API. Each eSIM inherits the domain whitelist and can have individual data limits.
3. 3.Distribute to Users — Users install the eSIM on their device and 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
  }'

{
  "data": {
    "esims": [
      {
        "id": "0d7db4a0-7cf4-440c-9256-4a3c08a6998c",
        "user_id": "e1e4444e-a166-4636-9b3a-086d6e300cbe",
        "group_id": "de4349d8-94a5-4261-9efb-89086baa22c3",
        "telnyx_sim_id": "b889815b-c425-42b1-88a1-aa639b32a61f",
        "iccid": "89311210000005914313",
        "status": "enabled",
        "imsi": "311210394316585",
        "msisdn": "+19702874806",
        "activation_code": "LPA:1$smdpplus.net$IL3UMEUTLB935KFAMENKU8Y5",
        "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 is a connectivity policy that defines which domains are accessible. Groups are created via the dashboard and include all the underlying network infrastructure (VPC, firewall, WireGuard tunnel).

For example, adding api.yourapp.com to a group automatically includes v1.api.yourapp.com, v2.api.yourapp.com, and any other subdomains.

Via the API, groups are read-only — you can list them and retrieve details, but creation and domain management is done through the dashboard.

eSIM Provisioning

Once you have a group configured, you can provision eSIMs through the API. Each eSIM includes an activation code that users can scan as a QR code or enter manually in their device settings.

eSIMs can be enabled, disabled, and have their data limits adjusted at any time. You can also set per-eSIM data caps in MB to control usage.

Getting Started

To begin using the Airvoy API:

1. 1.Get Your API Key — Visit the dashboard to create an account and generate credentials.
2. 2.Add Funds — A minimum balance of 250 USD is required.
3. 3.Create a Group — Set up your domain whitelist via the dashboard.
4. 4.Follow the Quickstart — See the Quickstart guide to issue your first eSIM.

Need help? Contact us at support@airvoy.app.