# ESimProfile Resource

{% hint style="info" %}
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.
{% endhint %}

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](https://docs.korewireless.com/api/products/supersim/sim-resource) 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](#status-values) 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**](#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.

{% hint style="warning" %}
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 [<mark style="background-color:red;">**The Benefits of Consumer Profile eSIMs for IoT devices**</mark>](https://www.korewireless.com/news/what-is-an-esim) 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**](https://www.gsma.com/esim/wp-content/uploads/2018/12/esim-whitepaper.pdf) from the GSMA.
{% endhint %}

{% hint style="danger" %}
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.
{% endhint %}

## Pricing <a href="#pricing" id="pricing"></a>

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](https://www.korewireless.com/iot/help).&#x20;

## Supported Download Methods <a href="#supported-download-methods" id="supported-download-methods"></a>

There are multiple approaches defined by the GSMA that can be used to download a consumer SIM profile to your device.

### Default SM-DP+ <a href="#default-sm-dp" id="default-sm-dp"></a>

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 <a href="#activation-code" id="activation-code"></a>

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](#qr-codes-and-esim-profiles). 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](https://docs.korewireless.com/en-us/developers/api-management/auth) 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:

{% code overflow="wrap" %}

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

{% endcode %}

{% hint style="warning" %}
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.
{% endhint %}

***

## Read all ESimProfile resources

> Retrieve a list of eSIM Profiles.

```json
{"openapi":"3.0.1","info":{"title":"KORE - Supersim","version":"1.0.0"},"tags":[{"name":"SupersimV1EsimProfile"}],"servers":[{"url":"https://supersim.api.korewireless.com"}],"security":[{"OAuth":[]}],"components":{"securitySchemes":{"OAuth":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.korewireless.com/api-services/v1/auth/token","scopes":{}}}}},"schemas":{"esim_profile_enum_status":{"type":"string","nullable":true,"description":"The status of the eSIM Profile. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://docs.korewireless.com/en-us/v/api/products/supersim/esimprofile-resource#status-values) for a description of each.","enum":["new","reserving","available","downloaded","installed","failed"]},"supersim.v1.esim_profile":{"type":"object","properties":{"sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^HP[0-9a-fA-F]{32}$","nullable":true,"description":"The unique string that we created to identify the eSIM Profile resource."},"account_sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^AC[0-9a-fA-F]{32}$","nullable":true,"description":"The SID of the [Account](https://docs.korewireless.com/en-us/v/api/global-resources/iam/account) to which the eSIM Profile resource belongs."},"iccid":{"type":"string","nullable":true,"description":"The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource."},"sim_sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^HS[0-9a-fA-F]{32}$","nullable":true,"description":"The SID of the [Sim](https://docs.korewireless.com/en-us/v/api/products/supersim/sim-resource) resource that this eSIM Profile controls."},"status":{"$ref":"#/components/schemas/esim_profile_enum_status"},"eid":{"type":"string","nullable":true,"description":"Identifier of the eUICC that can claim the eSIM Profile."},"smdp_plus_address":{"type":"string","format":"uri","nullable":true,"description":"Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status `available`."},"matching_id":{"type":"string","nullable":true,"description":"Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if `generate_matching_id` is set to `true` when creating the eSIM profile reservation."},"activation_code":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state."},"error_message":{"type":"string","nullable":true,"description":"Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state."},"date_created":{"type":"string","format":"date-time","nullable":true,"description":"The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."},"date_updated":{"type":"string","format":"date-time","nullable":true,"description":"The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."},"url":{"type":"string","format":"uri","nullable":true,"description":"The absolute URL of the eSIM Profile resource."}}}}},"paths":{"/v1/ESimProfiles":{"get":{"summary":"Read all ESimProfile resources","description":"Retrieve a list of eSIM Profiles.","tags":["SupersimV1EsimProfile"],"parameters":[{"name":"Eid","in":"query","description":"List the eSIM Profiles that have been associated with an EId.","schema":{"type":"string"}},{"name":"SimSid","in":"query","description":"Find the eSIM Profile resource related to a [Sim](https://docs.korewireless.com/en-us/v/api/products/supersim/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.","schema":{"type":"string"}},{"name":"Status","in":"query","description":"List the eSIM Profiles that are in a given status.","schema":{"$ref":"#/components/schemas/esim_profile_enum_status"}},{"name":"PageSize","in":"query","description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"Page","in":"query","description":"The page index. This value is simply for client state.","schema":{"type":"integer","minimum":0}},{"name":"PageToken","in":"query","description":"The page token. This is provided by the API.","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"esim_profiles":{"type":"array","items":{"$ref":"#/components/schemas/supersim.v1.esim_profile"}},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListEsimProfileResponse"}}},"headers":{"Access-Control-Allow-Origin":{"description":"Specify the origin(s) allowed to access the resource","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"Specify the HTTP methods allowed when accessing the resource","schema":{"type":"string"}},"Access-Control-Allow-Headers":{"description":"Specify the headers allowed when accessing the resource","schema":{"type":"string"}},"Access-Control-Allow-Credentials":{"description":"Indicates whether the browser should include credentials","schema":{"type":"boolean"}},"Access-Control-Expose-Headers":{"description":"Headers exposed to the client","schema":{"type":"string"}}},"description":"OK"}},"operationId":"ListEsimProfile"}}}}
```

## Create an ESimProfile resource to reserve a Super SIM profile

> Order an eSIM Profile.

```json
{"openapi":"3.0.1","info":{"title":"KORE - Supersim","version":"1.0.0"},"tags":[{"name":"SupersimV1EsimProfile"}],"servers":[{"url":"https://supersim.api.korewireless.com"}],"security":[{"OAuth":[]}],"components":{"securitySchemes":{"OAuth":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.korewireless.com/api-services/v1/auth/token","scopes":{}}}}},"schemas":{"supersim.v1.esim_profile":{"type":"object","properties":{"sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^HP[0-9a-fA-F]{32}$","nullable":true,"description":"The unique string that we created to identify the eSIM Profile resource."},"account_sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^AC[0-9a-fA-F]{32}$","nullable":true,"description":"The SID of the [Account](https://docs.korewireless.com/en-us/v/api/global-resources/iam/account) to which the eSIM Profile resource belongs."},"iccid":{"type":"string","nullable":true,"description":"The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource."},"sim_sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^HS[0-9a-fA-F]{32}$","nullable":true,"description":"The SID of the [Sim](https://docs.korewireless.com/en-us/v/api/products/supersim/sim-resource) resource that this eSIM Profile controls."},"status":{"$ref":"#/components/schemas/esim_profile_enum_status"},"eid":{"type":"string","nullable":true,"description":"Identifier of the eUICC that can claim the eSIM Profile."},"smdp_plus_address":{"type":"string","format":"uri","nullable":true,"description":"Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status `available`."},"matching_id":{"type":"string","nullable":true,"description":"Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if `generate_matching_id` is set to `true` when creating the eSIM profile reservation."},"activation_code":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state."},"error_message":{"type":"string","nullable":true,"description":"Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state."},"date_created":{"type":"string","format":"date-time","nullable":true,"description":"The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."},"date_updated":{"type":"string","format":"date-time","nullable":true,"description":"The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."},"url":{"type":"string","format":"uri","nullable":true,"description":"The absolute URL of the eSIM Profile resource."}}},"esim_profile_enum_status":{"type":"string","nullable":true,"description":"The status of the eSIM Profile. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://docs.korewireless.com/en-us/v/api/products/supersim/esimprofile-resource#status-values) for a description of each.","enum":["new","reserving","available","downloaded","installed","failed"]}}},"paths":{"/v1/ESimProfiles":{"post":{"summary":"Create an ESimProfile resource to reserve a Super SIM profile","description":"Order an eSIM Profile.","tags":["SupersimV1EsimProfile"],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/supersim.v1.esim_profile"}}},"headers":{"Access-Control-Allow-Origin":{"description":"Specify the origin(s) allowed to access the resource","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"Specify the HTTP methods allowed when accessing the resource","schema":{"type":"string"}},"Access-Control-Allow-Headers":{"description":"Specify the headers allowed when accessing the resource","schema":{"type":"string"}},"Access-Control-Allow-Credentials":{"description":"Indicates whether the browser should include credentials","schema":{"type":"boolean"}},"Access-Control-Expose-Headers":{"description":"Headers exposed to the client","schema":{"type":"string"}}},"description":"Created"}},"operationId":"CreateEsimProfile","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","title":"CreateEsimProfileRequest","properties":{"CallbackUrl":{"type":"string","description":"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`."},"CallbackMethod":{"type":"string","format":"http-method","enum":["GET","POST"],"description":"The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST."},"GenerateMatchingId":{"type":"boolean","description":"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."},"Eid":{"type":"string","description":"Identifier of the eUICC that will claim the eSIM Profile."}}}}}}}}}}
```

## Fetch an ESimProfile resource

> Fetch an eSIM Profile.

```json
{"openapi":"3.0.1","info":{"title":"KORE - Supersim","version":"1.0.0"},"tags":[{"name":"SupersimV1EsimProfile"}],"servers":[{"url":"https://supersim.api.korewireless.com"}],"security":[{"OAuth":[]}],"components":{"securitySchemes":{"OAuth":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.korewireless.com/api-services/v1/auth/token","scopes":{}}}}},"schemas":{"supersim.v1.esim_profile":{"type":"object","properties":{"sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^HP[0-9a-fA-F]{32}$","nullable":true,"description":"The unique string that we created to identify the eSIM Profile resource."},"account_sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^AC[0-9a-fA-F]{32}$","nullable":true,"description":"The SID of the [Account](https://docs.korewireless.com/en-us/v/api/global-resources/iam/account) to which the eSIM Profile resource belongs."},"iccid":{"type":"string","nullable":true,"description":"The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource."},"sim_sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^HS[0-9a-fA-F]{32}$","nullable":true,"description":"The SID of the [Sim](https://docs.korewireless.com/en-us/v/api/products/supersim/sim-resource) resource that this eSIM Profile controls."},"status":{"$ref":"#/components/schemas/esim_profile_enum_status"},"eid":{"type":"string","nullable":true,"description":"Identifier of the eUICC that can claim the eSIM Profile."},"smdp_plus_address":{"type":"string","format":"uri","nullable":true,"description":"Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status `available`."},"matching_id":{"type":"string","nullable":true,"description":"Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if `generate_matching_id` is set to `true` when creating the eSIM profile reservation."},"activation_code":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state."},"error_message":{"type":"string","nullable":true,"description":"Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state."},"date_created":{"type":"string","format":"date-time","nullable":true,"description":"The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."},"date_updated":{"type":"string","format":"date-time","nullable":true,"description":"The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."},"url":{"type":"string","format":"uri","nullable":true,"description":"The absolute URL of the eSIM Profile resource."}}},"esim_profile_enum_status":{"type":"string","nullable":true,"description":"The status of the eSIM Profile. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://docs.korewireless.com/en-us/v/api/products/supersim/esimprofile-resource#status-values) for a description of each.","enum":["new","reserving","available","downloaded","installed","failed"]}}},"paths":{"/v1/ESimProfiles/{Sid}":{"get":{"summary":"Fetch an ESimProfile resource","description":"Fetch an eSIM Profile.","tags":["SupersimV1EsimProfile"],"parameters":[{"name":"Sid","in":"path","description":"The SID of the eSIM Profile resource to fetch.","schema":{"type":"string"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/supersim.v1.esim_profile"}}},"headers":{"Access-Control-Allow-Origin":{"description":"Specify the origin(s) allowed to access the resource","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"Specify the HTTP methods allowed when accessing the resource","schema":{"type":"string"}},"Access-Control-Allow-Headers":{"description":"Specify the headers allowed when accessing the resource","schema":{"type":"string"}},"Access-Control-Allow-Credentials":{"description":"Indicates whether the browser should include credentials","schema":{"type":"boolean"}},"Access-Control-Expose-Headers":{"description":"Headers exposed to the client","schema":{"type":"string"}}},"description":"OK"}},"operationId":"FetchEsimProfile"}}}}
```

## Asynchronous updates <a href="#asynchronous-updates" id="asynchronous-updates"></a>

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 <a href="#sim-profile-successfully-reserved" id="sim-profile-successfully-reserved"></a>

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 <a href="#sim-profile-reservation-failed" id="sim-profile-reservation-failed"></a>

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 <a href="#sim-profile-downloaded" id="sim-profile-downloaded"></a>

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 <a href="#sim-profile-failed-to-download" id="sim-profile-failed-to-download"></a>

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 <a href="#sim-profile-installed" id="sim-profile-installed"></a>

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 <a href="#qr-codes-and-esim-profiles" id="qr-codes-and-esim-profiles"></a>

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

<figure><img src="https://3487028960-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJknMM6SZJYk9EbbitKp5%2Fuploads%2FRqo9eeY2hmnW6UCHyQv1%2Fimage.png?alt=media&#x26;token=3d994bce-4470-4c45-b358-eee2c411a2b7" alt=""><figcaption></figcaption></figure>
