Home/API docs

Developers / API

API documentation, coming soon.

A public reference for plans, orders, webhooks, and eSIM delivery is being written. Until it ships, integration notes are shared during a scoping call.

Short answer: There is no full public reference yet. The four sample calls below show the flow; host, keys, and live prices are shared during onboarding.

Talk to sales API product page

What the docs will cover

The reference will follow the order lifecycle, not a list of endpoints. Each section will include a request, a response, and the support path when something fails.

Authentication and sandbox

Keys, environments, and test orders.

Plans

Destination, days, data, and the price you set.

Orders

Idempotent creation, booking reference, and status.

Delivery

QR code, install link, and SDK handoff.

Webhooks

Order and eSIM status changes, with retries.

Errors and support

Error codes, retry rules, and who to contact.

What you can use today

The product page explains the model and the delivery surfaces. The buyer checklist lists the questions to settle before an integration project starts. For a current integration note, talk to sales.

API product page API buyer checklist Talk to sales

This page will be replaced by the full reference when it is published.

Preview

The API in four calls.

Sample paths and payloads from the current API notes. Host, keys, and live prices are shared during onboarding; the full reference is still coming.

01 / GET

Find plans

Ask for the plans that fit the trip: the destination and the days. Show them in your flow at your retail price.

GET/v1/plans?destination=JP&days=15

Response

{
  "data": [
    {
      "id": "jp-10gb-15d",
      "name": "Japan",
      "data": "10 GB",
      "days": 15
    },
    {
      "id": "as-10gb-15d",
      "name": "Asia",
      "data": "10 GB",
      "days": 15
    }
  ]
}

At the phone Data for Japan 10 GB · 15 days

02 / POST

Create the order

After the traveler pays in your checkout, create the order with the plan, the email, and your booking reference.

POST/v1/orders

Request

{
  "plan": "jp-10gb-15d",
  "email": "[email protected]",
  "reference": "HK-2041"
}

Response

{
  "id": "ord_7K2Q",
  "status": "processing"
}

At the phone Paid Your eSIM is on the way.

03 / GET

Get the eSIM

The order holds the eSIM QR and an install link. With the SDK, the app installs the eSIM in one tap where the phone allows it; the QR is the fallback.

GET/v1/orders/ord_7K2Q

Response

{
  "id": "ord_7K2Q",
  "status": "ready",
  "plan": "jp-10gb-15d",
  "qr": "(QR image)",
  "install_link": "(link for your app)"
}

At the phone Your eSIM is ready Japan · 10 GB

04 / Webhook

Hear back

A webhook tells your system when the order is ready, so the trip in your app shows the eSIM and its status with no polling.

Webhookorder.completed

Event sent to your server

{
  "type": "order.completed",
  "order": "ord_7K2Q",
  "reference": "HK-2041"
}

At the phone Your trip to Tokyo eSIM ready · starts on landing

SDK

Same calls inside the app.

The same calls inside your iOS or Android app
One-tap install in the app, where the phone allows it
The QR and the install link as the fallback

iOS / Android

Go live

From sandbox to first market.

Test keys and sample plans in the sandbox
Test orders end to end, with the webhook
A go-live check with the RoamWorks team
Live keys for your first market

Preview only. The public reference will add authentication, pagination, error codes, and the complete event list.

Start

Put travel data in your product.

Tell us where you meet the traveler and what you sell today. We will send the model, coverage list, and integration notes.

Talk to sales Explore the API