Install eSIM
Direct Installation
The installProfile
method can be used to install an eSIM profile on a user's device. The device operating system will show up an installation wizard for the user.
This function returns either the installed profile or an error object containing the error.
QR Code Installation
Due to restrictions, Direct Installation might not be available for some apps.
In this case, you can use the iOS QR code feature.
First, generate a QR code based on the activationCode
of the profile
object. Several libraries generate QR codes on iOS. Ensure you generate a QR code with a valid activation code starting with LPA$.
Then, provide the QR code to the user via email or as an image in your app that can be saved to photos.
Please add a proper UX to explain to your users how to install the eSIM profile.
Check our eSIM Profiles section of our API if you want to initiate this process from your app middleware.
Last updated