SIM management overview

Discover Transatel SIM management API

eSIM

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 eSIM profile

ℹ️ Please note that for MVNO France light architecture and MVNO UK customers, eSIM profiles are provided already released, eSIM profile lifecycle history and related webhook events are not available.

eSIM management

This API lets you retrieve eSIM activation codes or matching IDs, as well as notification history about eSIM status changes.

Retrieve an eSIM profile details

This operation allows you to retrieve profile information from the Subscription Manager Data Preparation+ (SM-DP+) relative to a given eSIM identified by its SIM card serial number.

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 from your stock and make it downloadable on a device.
Optionally you can provide a device EID in order to make the profile usable only on this particular device.

As response, you will receive the activation code and associated QR code, that you can share directly with your subscriber.

ℹ️ Be aware that for MVNO France light architecture and MVNO UK customers, eSIM profiles are provided already released and ready to be downloaded. Hence, an EID cannot be attributed to bind those profiles to specific devices.

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 either allocate it or immediately release it, making it downloadable on a device.
Optionally you can provide a device EID in order to make the profile usable only on this particular device.

As response, you will receive:

• The SIM card serial number of the selected SIM
• The activation code and the associated QR code that you can share directly with your subscriber if the profile was also released

ℹ️ Be aware that this feature is not available for MVNO France light architecture and MVNO UK customers.