Skip to main content

Overview

Dancity eSIMs give your users data connectivity in 150+ countries without swapping a physical SIM. The eSIM flow is:
  1. Browse regions to find the destination country or region
  2. Browse packages for that region to see data, validity, and price
  3. Purchase the eSIM — the user installs it on their device via a QR code
  4. Optionally top up an existing eSIM with additional data

Authentication

All eSIM endpoints use your merchant API key only.

Step 1 — Browse regions


Step 2 — Browse packages for a region


Step 3 — Purchase eSIM

Request body


Top up an existing eSIM

When a user’s eSIM is running low on data, list compatible add-on packages using its ICCID (the SIM identifier assigned after the first purchase).

Query parameters

Sample response

Then purchase the selected package with POST /api/v1/esim/purchase using the returned packageCode.

Fetch eSIMs

List active eSIMs on the merchant account. Each row includes the ICCID (needed for top-ups), package details, and activation status.

Query parameters

Sample response


Get eSIM details

Fetch QR code, ICCID, activation code, and status for a purchased eSIM. Use this to display the install QR code to your customer or to retrieve the ICCID for top-ups.

Path parameter

Sample response


Full purchase flow

Save the transactionId after purchase. Use GET /esim/details/{transactionId} to retrieve and re-display the QR code if the user needs it again.

Next steps