ES2 interface description

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 for more information.

Legend

Icon	Interface type	Source	Target
💠	Function call	Customer	KPN
🔔	Notification	KPN	Customer

General

ES2 - communication with SM-DP

Your SM-SR should be connected to our SM-DP in order to use the ES2 interface.

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.

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.

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.

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.

You will not receive a Profile Enabled notification for the profile you enable through this API call.

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.

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.

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.

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.

It is not possible to specify a Validity Period per request. Currently set to a fixed period of 720 seconds.