> For the complete documentation index, see [llms.txt](https://docs.kpnthings.com/kpn-things/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kpnthings.com/kpn-things/rsp/transparent-api/es2.md). # ES2 interface description {% hint style="warning" %} The KPN RSP Gateway has not implemented every interface of the GSMA SGP.02 v3.2 / v4.0 specification. Upon request more interfaces can be implemented. Please contact [support](/kpn-things/rsp/help/support.md) for more information. {% endhint %} #### Legend | Icon | Interface type | Source | Target | | ---- | -------------- | -------- | -------- | | 💠 | Function call | Customer | KPN | | 🔔 | Notification | KPN | Customer | ## General ### ES2 - communication with SM-DP {% hint style="info" %} Your SM-SR should be connected to our SM-DP in order to use the ES2 interface. {% endhint %} ```http https://rsp.kpnthings.com/esim-messaging/3/ES2/ES2SmDpService ``` ### Attributes * replyTo - is considered required. Without replyTo attribute, no callback will be performed for the function call. ## The interfaces ### Getting eUICC Information 💠 > Section 5.3.1 of the [SGP.02 v3.2 specification](https://www.gsma.com/newsroom/resources/sgp-02-v3-2-remote-provisioning-architecture-for-embedded-uicc-technical-specification/). Allows you to retrieve up to date information of you RSP SIM card. *We check if you may access the SM-SR using the provided SM-SR ID.* ### Download a Profile 💠 > Section 5.3.2 of the [SGP.02 v3.2 specification](https://www.gsma.com/newsroom/resources/sgp-02-v3-2-remote-provisioning-architecture-for-embedded-uicc-technical-specification/). Allows you to download a KPN profile (identifiable by ICCID or Profile type) to one of your SIM cards (identifiable by EID). You should provide the ID of the SM-SR that manages the provided SIM card. Optionally enable the profile upon downloading the virtual profile to the SIM card. *We check if you may access the SM-SR using the provided SM-SR ID. If you download a profile using Profile type, we check whether you have access to the provided Profile type. If you download a profile using ICCID, we verify your ownership of the ICCID.* ### Profile Enabling 💠 > Section 5.3.5 of the [SGP.02 v3.2 specification](https://www.gsma.com/newsroom/resources/sgp-02-v3-2-remote-provisioning-architecture-for-embedded-uicc-technical-specification/). Allows you to enable a profile (identifiable by ICCID) that is already downloaded to a SIM card (identifiable by EID). You should provide the ID of the SM-SR that manages the provided SIM card. You can enable the bootstrap profile as well as the virtual profiles on the SIM card. {% hint style="warning" %} You will **not** receive a Profile Enabled notification for the profile you enable through this API call. {% endhint %} *If you try to manage a KPN RSP SIM card, we verify your ownership of the EID. If you try to manage a non-KPN RSP SIM card, we check if you may access the SM-SR using the provided SM-SR ID.* ### Profile Disabling 💠 > Section 5.3.6 of the [SGP.02 v3.2 specification](https://www.gsma.com/newsroom/resources/sgp-02-v3-2-remote-provisioning-architecture-for-embedded-uicc-technical-specification/). Allows you to disable a profile on a specific RSP SIM card. *If you try to control a KPN RSP SIM card, we verify your ownership of the EID. If you try to manage a non-KPN RSP SIM card, we check if you may access the SM-SR using the provided SM-SR ID.* ### Delete a Profile 💠 > Section 5.3.7 of the [SGP.02 v3.2 specification](https://www.gsma.com/newsroom/resources/sgp-02-v3-2-remote-provisioning-architecture-for-embedded-uicc-technical-specification/). Allows you to request deletion of a profile on a specific RSP SIM card. *If you try to control a KPN RSP SIM card, we verify your ownership of the EID. If you try to manage a non-KPN RSP SIM card, we check if you may access the SM-SR using the provided SM-SR ID.* ### Set Fall-Back Attribute 💠 > Section 5.3.23 of the [SGP.02 v4.0 specification](https://www.gsma.com/newsroom/wp-content/uploads/SGP.02-v4.0.pdf). Allows you to set a profile as fallback for a specific RSP SIM card. *If you try to control a KPN RSP SIM card, we verify your ownership of the EID. If you try to manage a non-KPN RSP SIM card, we check if you may access the SM-SR using the provided SM-SR ID.* {% hint style="warning" %} It is **not** possible to specify a Validity Period per request. Currently set to a fixed period of 720 seconds. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.kpnthings.com/kpn-things/rsp/transparent-api/es2.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.