Add your Key ID and Secret to send test requests.

eSIM API Reference

Every eSIM endpoint, grouped by what it does. Requests go through the gateway and are authenticated with your key id and secret — see Authentication.

Catalog

List plansget

Returns the data plans you can buy, filterable by region, country, validity and price.

Get a planget

Returns one plan with its coverage, allowance, validity and price.

List countriesget

Returns the countries with plans available to you.

List regionsget

Returns the multi-country regions with plans available to you.

Orders

List ordersget

Returns your eSIM orders, newest first. Pass `status=pending` for the ones still being provisioned.

Buy a planpost

Buys a plan and begins provisioning. Returns immediately with an order to poll; delivery completes asynchronously.

Get an orderget

Returns an order's status and, once delivered, the profiles it produced.

Resend the confirmationpost

Sends the order confirmation email again to the address on the order. Rate limited; repeating it is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.

Profiles

List your profilesget

Returns every eSIM profile you hold, across all orders, each with the `iccid` that addresses it and the activation code that installs it.

Get a profileget

Returns one eSIM profile: its status, and the activation code plus Apple one-tap link that install it. The activation code IS the QR payload — render it as a QR locally rather than expecting a hosted image. Treat it as a credential: it is never cached and never logged.

Find a service GET

Returns the offers for a service across countries and pools — one row per offer, each with the `serviceId` you send to [POST /v1/otp/activations](#operation/createOtpActivation). The path segment addresses either **one offer**, by the `serviceId` a catalogue response published (`ALPHA-372-alibaba`) — matched exactly, and a 404 when no such offer is sellable to you — or **any service by name**, as free text (`viber`, `alibaba`) matched case-insensitively against a service name or slug. A name that matches nothing is an empty `data` array with `meta.total` 0, not a 404: no result is a result. Offers with no numbers in stock are omitted either way, so a sold-out offer id 404s.

List plans GET

Returns the data plans you can buy, filterable by region, country, validity and price.