SIM management overview
Discover Transatel SIM management API
eSIM (embedded SIM) is a form of programmable SIM which allows eSIM carrier profiles to be downloaded and installed over a network connectivity. This API allows to manage them and in particular consult their status.
Lifecycle and statuses
Lifecycle of an
|available||eSIM profile available in stock|
|allocated||eSIM profile allocated to a specific device|
|released||eSIM profile ready to be downloaded on a device|
|downloaded||eSIM profile downloaded by the device|
|installed||eSIM profile installed into the device|
|enabled||eSIM profile enabled on the device|
|disabled||eSIM profile disabled on the device|
|deleted||eSIM profile deleted from the device|
Retrieve an eSIM profile details
As response, you will receive information such as:
- the eSIM profile status
- the activation code, the matching ID or even a ready-to-use QR code to download the profile on a device
- the identifier of the eUICC on which the profile was downloaded
- and optionally a history of all notifications and status changes
The activation code, matching ID and QR code are only available once an eSIM has been released.
Release a given eSIM profile
This operation allows you to release an eSIM profile for a given SIM of your stock and make it downloadable on a device. As response, you will receive the activation code and associated QR code, that you can share directly with your subscriber.
Only profiles not yet downloaded can be released.
Reserve an eSIM profile
This operation allows you to reserve automatically an eSIM profile from your pool and release it, making it downloadable on a device. As response, you will receive the activation code, the associated QR code that you can share directly with your subscriber, as well as the SIM serial number of the selected SIM.
ℹ️ Be aware that this feature is not yet available on our MVNO France & UK light architecture.