Integration guide

Show installation instructions

Most support tickets in eSIM are installation tickets. Three fields in the eSIM object cover every device.

The fields

json

{
  "qr_code_url": "https://…/create-qr-code/?size=400x400&data=LPA%3A1%24…",
  "activation_code": "LPA:1$rsp.example-smdp.net$A1B2C3D4E5",
  "smdp_address": "rsp.example-smdp.net",
  "status": "ALLOCATED"
}

qr_code_url is a ready-made image. Embed it in your confirmation page and attach it to the email.
activation_code is the LPA string the QR encodes. Offer it as copyable text for travellers who cannot scan a screen they are reading from.
smdp_address plus the code after the last $ is what manual entry screens ask for.

Instructions to show

iPhone (iOS 17 and later)

Settings → Cellular → Add eSIM → Use QR Code.
Scan the QR, or tap Enter Details Manually and paste the SM-DP+ address and activation code.
Label the plan, then leave Data Roaming ON for the travel line.

Android (Pixel, Samsung and most others)

Settings → Network & Internet → SIMs → Add eSIM / Download a SIM instead.
Scan the QR, or choose Need help? → Enter it manually.
Enable roaming on the downloaded profile.

When to install

Tell travellers to install before they fly, while they still have Wi-Fi, but to switch the line on only after landing. Validity starts when the profile first attaches to a network in the destination, so installing early costs nothing.

One profile, one device

A QR code can be installed once. If a traveller deletes the profile it cannot be reinstalled and a replacement has to be purchased — put that warning next to the code.

Pre-flight checks worth surfacing

The device must be eSIM-capable and carrier-unlocked.
iPhone XS and later, Pixel 3 and later, Galaxy S20 and later are safe bets.
Keep the home SIM for calls and texts; set the travel eSIM as the data line.