eSIM Profiles
An eSIM profile allows access to the mobile data network. The user can install an eSIM using different methods on an eSIM-capable smartphone:
Scan the Activation Code
Direct Installation (without a QR code)
To use the Direct Installation, please integrate our SDKs, see SDK Integration.
eSIM API Object
Each eSIM profile comes with
uid - internal identitier
ICCID - main identifier for end-user support
activationCode - used to install the eSIM
IMSI, lastSeen, activatedAt - additional identifiers for support
state - current state (e.g. INSTALLED)
Providing QR code for installation
Once the First Package is activated, the returned eSIM can be used to provide a QR code for installing the eSIM.
You can use any QR code renderer to generate a QR code using the activationCode
and provide it to your user via email or through other channels.
The QR code must be scanned with an eSIM-capable device, like an iPhone 14.
eSIM States
An eSIM can have different states. You can use the eSIM state to guide the user during your user journey.
State | Meaning | Comment |
---|---|---|
RELEASED | Not installed on a device | Profile ready to be downloaded and installed |
DISABLED | Installed, but user disabled the eSIM in the OS | Not available for all eSIM profiles / devices |
INSTALLED | Installed and enabled | |
ERROR | Something went wrong during installation | Contact support to replace the profile. |
To receive status updates, use the eSIM Status webhook. The webhook is triggered within a few seconds after the user interaction.
Last updated