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

eSIM lifecycle

Lifecycle of an eSIM profile



StatusDescription
availableeSIM profile available in stock
allocatedeSIM profile allocated to a specific device
releasedeSIM profile ready to be downloaded on a device
downloadedeSIM profile downloaded by the device
installedeSIM profile installed into the device
enabledeSIM profile enabled on the device
disabledeSIM profile disabled on the device
deletedeSIM profile deleted from the device

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 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.