ESimProfile Resource
Super SIM’s downloadable eSIM Profiles API is currently in Public Beta. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Beta products are not covered by a Twilio SLA. Learn more about beta product support.
To avoid ambiguity, throughout this page Sim (initial cap) refers to the Sim API resource. SIM (all caps) refers to the physical Subscriber Identity Module (that is, a SIM card) associated with a Sim resource.
An ESimProfile resource represents a digital Super SIM profile that can be downloaded onto an eSIM (eUICC) that uses consumer profiles:
https://supersim.twilio.com/v1/ESimProfilesAn ESimProfile instance can be referenced in the API by its unique sid:
https://supersim.twilio.com/v1/ESimProfiles/{sid}An ESimProfile allows you to request a Super SIM profile for an eUICC SIM and allows you to manage the eSIM profiles.
When you create an ESimProfile resource, a SIM profile will be asynchronously reserved for you on Twilio’s eSIM subscription management service (SM-DP+). After the reservation completes, you’ll be able to download the SIM profile to your eSIM. You can configure a callback URL to be automatically notified when the SIM profile is available for download, and when it has been downloaded.
To use your SIM profile to connect to cellular networks, configure and activate the Sim resource that is created during the reservation process. The Sim resource can be configured before or after the SIM profile is downloaded. When your reservation is complete, the ESimProfile resource’s Status will be updated to available and its SimSid will be updated with the unique identifier of the Sim resource you will use to manage its connectivity.
If you configured the ESimProfile resource’s CallbackUrl, a notification will be sent to you with the Sim resource’s Sid when the ESimProfile resource’s Status is updated to available. See Asynchronous updates for more details about the notifications sent.
Once a consumer SIM profile has been downloaded to your eSIM, you will no longer be able to update the ESimProfile resource that represents it. You will manage the SIM profile’s connectivity using the Sim resource created during the reservation process and you, or an application running on your device, will manage which SIM profile should be enabled from your device.
Please make sure you have the following two items before using this API to reserve a Super SIM Profile:
• A consumer profile eUICC SIM in your device.
• Local Profiles Assistant (LPA) software in your device to download and manage SIM profiles. See The Benefits of Consumer Profile eSIMs for IoT devices for more details.
Reserving a SIM profile will result in the corresponding SIM resource being associated with your account and your account being charged for the cost of a SIM profile.
You can learn more about consumer eSIMs in this eSIM whitepaper from the GSMA.
A Super SIM profile can be downloaded only once to an eUICC SIM. Once it is downloaded, it can be used only with that eUICC SIM. It cannot be downloaded again or used with another eUICC SIM.
Pricing
Each Super SIM eSIM profile costs $3. Your Twilio account will be charged before the eSIM profile becomes available for download.
Volume discounts are available. Contact sales-wireless@twilio.com to speak to an IoT Sales Specialist.
Supported download methods
There are multiple approaches defined by the GSMA that can be used to download a consumer SIM profile to your device.
Default SM-DP+
The Default SM-DP+ method uses the EID of the eSIM to reserve an eSIM profile on the SM-DP+ server. Using your Local Profiles Assistant (LPA), your device can reach out to the SM-DP+ URL provided to it to check if there is a profile available for it. This method can be advantageous if you have a large number of devices for which you already know the EIDs. You can instruct all of your devices to contact the same SM-DP+ URL and not worry about giving each device a unique matching ID to identify the eSIM profile for it. To use this approach, provide the EID of your eSIM as the eid property when reserving an eSIM profile through this resource. If your LPA or device prompts you for a matching ID or an activation code, leave it blank or provide an empty string.
Activation Code
The Activation Code method can be used to reserve an eSIM profile that can be claimed and downloaded by any eSIM enabled device. You do not need to know the EID of the eSIM that will claim the eSIM profile. Instead, when you create an eSIM Profile resource, an eSIM profile will be reserved on our SM-DP+ server and a matching ID will be generated, identifying that specific profile. Any eSIM capable device can then contact the SM-DP+ server at its address and provide the eSIM profile’s matching ID to claim it. This is the approach typically used when QR codes are used to add eSIM profiles to devices. To use the Activation Code approach, when creating an eSIM Profile resource, set the generate_matching_id request parameter to true.
Customers may request that eSimProfile data be deleted. If you wish to do so, please contact Twilio Support through the Console or Help Center. For more information on Twilio’s data retention and deletion policy, please see this support document.
EsimProfile properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the eSIM Profile resource. |
account_sid
|
The SID of the Account to which the eSIM Profile resource belongs. |
iccid
|
The ICCID associated with the Sim resource. |
sim_sid
|
The SID of the Sim resource that this eSIM Profile controls. |
status
|
The status of the eSIM Profile. Can be: |
eid
|
Identifier of the eUICC that can claim the eSIM Profile. |
smdp_plus_address
|
Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status |
matching_id
|
Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if |
activation_code
|
Combined machine-readable activation code for acquiring an eSIM Profile with the Activation Code download method. Can be used in a QR code to download an eSIM profile. |
error_code
|
Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in |
error_message
|
Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
url
|
The absolute URL of the eSIM Profile resource. |
Status values
The table below describes the available status values of an ESimProfile instance.
new |
The initial value of an ESimProfile resource. Your request to create an eSIM profile has been accepted and we will begin the process of reserving an eSIM profile for you. |
reserving |
An eSIM profile is being reserved for you but is not yet ready for download. |
available |
An eSIM profile is ready to be downloaded. A Sim resource has been created. Your account has been charged for the profile. |
downloaded |
The eSIM profile has been claimed. It is not guaranteed that an ESimProfile resource will be updated from available to downloaded after the profile has been downloaded. The ESimProfile can no longer be updated. |
installed |
The eSIM has confirmed that the SIM profile has been successfully installed. When eSIMs are manufactured with profiles pre-installed, the ESimProfile resource will be added in this state. |
failed |
Your SIM profile either failed to be reserved or can no longer be downloaded from the SM-DP+. |
The ESimProfile resource will typically move through new and reserving within a few seconds and does not require you to take any action.
Create an ESimProfile resource to reserve a Super SIM profile
https://supersim.twilio.com/v1/ESimProfiles
Parameters
| Parameters in REST API format | |
|---|---|
callback_url
Optional
|
The URL we should call using the |
callback_method
Optional
|
The HTTP method we should use to call |
generate_matching_id
Optional
|
When set to |
eid
Optional
|
Identifier of the eUICC that will claim the eSIM Profile. |
Example 1
Asynchronous updates
Reserving and downloading a SIM profile completes asynchronously. Throughout this process, the ESimProfile resource will be updated. To receive a notification each time the ESimProfile resource updates, set its callback_url and callback_method properties.
The ESimProfile resource will be updated at each of the following events:
SIM profile successfully reserved
Your SIM profile has been reserved and is ready for download. The status property will be updated to available. The smdp_plus_address property will be updated with the URL of the SM-DP+.
The Sim resource that needs to be activated before you can connect to the cellular networks has also been created. The sim_sid property will be updated.
SIM profile reservation failed
Your requested SIM profile could not be reserved. The status property will be updated to failed. The error_code and error_message properties will be updated to indicate what went wrong.
SIM profile downloaded
Your SIM profile has been successfully downloaded. The status property will be updated to downloaded. The eid property will be updated with the EID of the eSIM that downloaded the SIM profile.
SIM profile failed to download
Something went wrong and your SIM profile can no longer be downloaded. The status property will be updated to failed. The error_code and error_message properties will be updated to indicate what went wrong.
SIM profile installed
Your SIM profile has been successfully installed on the eSIM. The status property will be updated to installed.
Callback values
If you set the callback_url and callback_method properties on your ESimProfile resource, the asynchronous request made to that URL will contain the following parameters:
ESimProfileSid |
The unique SID of the ESimProfile resource that this callback is in reference to. |
SimSid |
The unique SID of the Sim resource used to manage this SIM profile’s connectivity. |
SimIccid |
The ICCID of the SIM profile to be downloaded to your eSIM. |
ESimProfileStatus |
The status of the ESimProfile resource that this callback is in reference to. |
Eid |
The EID of the eSIM that can or did download the SIM profile. |
SmdpPlusAddress |
Address of the SM-DP+ from which the SIM profile can be downloaded. |
ErrorCode |
Error code to identify what went wrong. |
ErrorMessage |
Description of what went wrong. |
Example 2
Example 3
QR codes and eSIM Profiles
You may have seen QR codes used to install eSIM profiles on traditional consumer devices such as phones or tablets. The QR code contains the SM-DP+ address and the matching ID of the eSIM profile to claim, if one was generated, in a specific format. This combined SM-DP+ URL and matching ID are used to construct an “activation code” that is formatted the following way with each element separated by a $:
"1${SM-DP+_ADDRESS}${MATCHING_ID}"To create a QR code containing an eSIM profile’s activation code you will need to precede it with LPA:. For example, the following QR code contains this activation code:
LPA:1$TWL.PROD.ONDEMANDCONNECTIVITY.COM$TAB80-FUT45-XKLX8-BFGT6
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
