ESimProfile Resource

Access Super SIM functionality via eUICCs

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.api.korewireless.com/v1/ESimProfiles

An ESimProfile instance can be referenced in the API by its unique sid:

https://supersim.api.korewireless.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 KORE'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 corresponding 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 eUICC SIM in your device that uses the SGP.22 or SGP.32 eSIM standards. • 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 only be downloaded only once. 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 KORE account will be charged before the eSIM profile becomes available for download.

Volume discounts are available. Learn more by speaking with a KORE 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 unique 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.

Status Values

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

---

API Authorization

Before you can make requests to this resource, you must have a valid bearer token. Review our API authorization guide to learn how to generate a token. Here's an example on how to define your access token in a header using cURL from the command line:

curl -X GET "https://supersim.api.korewireless.com/v1/ESimProfiles" -H "Authorization: Bearer <YOUR_AUTH_TOKEN>"

The examples below do not show the required Authorization header due to a bug. We're working on fixing that. In the meantime, be sure to include that in all of your requests.

---

Create an ESimProfile resource to reserve a Super SIM profile

post

Order an eSIM Profile.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Body

application/x-www-form-urlencoded

CallbackUrlstringOptional

The URL we should call using the callback_method when the status of the eSIM Profile changes. At this stage of the eSIM Profile pilot, the a request to the URL will only be called when the ESimProfile resource changes from reserving to available.

CallbackMethodstring · enumOptional

The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST.

Possible values:

GenerateMatchingIdbooleanOptional

When set to true, a value for Eid does not need to be provided. Instead, when the eSIM profile is reserved, a matching ID will be generated and returned via the matching_id property. This identifies the specific eSIM profile that can be used by any capable device to claim and download the profile.

EidstringOptional

Identifier of the eUICC that will claim the eSIM Profile.

Responses

201

Created

application/json

post

/v1/ESimProfiles

cURLNodeJsPython

curl -L -X POST "https://supersim.api.korewireless.com/v1/ESimProfiles" --data-urlencode "Eid=<YOUR_EID>" --header "Content-Type: application/x-www-form-urlencoded" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

201

Created

{
  "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "iccid": null,
  "sim_sid": null,
  "status": "new",
  "eid": "89049032005008882600033489aaaaaa",
  "smdp_plus_address": null,
  "matching_id": null,
  "activation_code": null,
  "error_code": null,
  "error_message": null,
  "date_created": "2020-09-01T20:00:00Z",
  "date_updated": "2020-09-01T20:00:00Z",
  "url": "https://supersim.api.korewireless.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Fetch an ESimProfile resource

get

Fetch an eSIM Profile.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Path parameters

SidstringRequired

The SID of the eSIM Profile resource to fetch.

Responses

200

OK

application/json

get

/v1/ESimProfiles/{Sid}

cURLNodeJsPython

curl -L "https://supersim.api.korewireless.com/v1/ESimProfiles/<Sid>" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

200

OK

{
  "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "iccid": "8988307aaaaaaaaaaaaa",
  "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "available",
  "eid": "89049032005008882600033489aaaaaa",
  "smdp_plus_address": "sm-dp-plus.kore.com",
  "matching_id": null,
  "activation_code": null,
  "error_code": null,
  "error_message": null,
  "date_created": "2020-09-01T20:00:00Z",
  "date_updated": "2020-09-01T20:00:00Z",
  "url": "https://supersim.api.korewireless.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Read all ESimProfile resources

get

Retrieve a list of eSIM Profiles.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Query parameters

EidstringOptional

List the eSIM Profiles that have been associated with an EId.

Example: {"value":"89049032005008882600033489aaaaaa"}

SimSidstringOptional

Find the eSIM Profile resource related to a Sim resource by providing the SIM SID. Will always return an array with either 1 or 0 records.

Example: {"value":"HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}

Statusstring · enum | nullableOptional

The status of the eSIM Profile. Can be: new, reserving, available, downloaded, installed or failed. See the eSIM Profile Status Values for a description of each.

Example: newPossible values:

PageSizeinteger · min: 1 · max: 1000Optional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

PageintegerOptional

The page index. This value is simply for client state.

PageTokenstringOptional

The page token. This is provided by the API.

Responses

200

OK

application/json

get

/v1/ESimProfiles

cURLNodeJsPython

curl -L "https://supersim.api.korewireless.com/v1/ESimProfiles?Status=installed" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

200

OK

{
  "esim_profiles": [
    {
      "sid": "HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "iccid": "8988307aaaaaaaaaaaaa",
      "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "status": "available",
      "eid": "89049032005008882600033489aaaaaa",
      "smdp_plus_address": "sm-dp-plus.kore.com",
      "matching_id": null,
      "activation_code": null,
      "error_code": null,
      "error_message": null,
      "date_created": "2020-09-01T20:00:00Z",
      "date_updated": "2020-09-01T20:00:00Z",
      "url": "https://supersim.api.korewireless.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ],
  "meta": {
    "first_page_url": "https://supersim.api.korewireless.com/v1/ESimProfiles?PageSize=50&Page=0",
    "key": "esim_profiles",
    "next_page_url": null,
    "page": 0,
    "page_size": 50,
    "previous_page_url": null,
    "url": "https://supersim.api.korewireless.com/v1/ESimProfiles?PageSize=50&Page=0"
  }
}

Asynchronous updates

Reserving and downloading an 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:

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

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