Version: v2.0

eSIM Profile Lifecycle

An eSIM has different states throughout its lifecycle. The Connect API returns the eSIM profile state for a given ICCID using the SIM endpoint. The key states are outlined below.

StatusDescription
Releasedready to be installed by the customer
Downloadeddownloaded into the eUICC of the customer device
Installedsuccessfully installed in eUICC of the customer device
Unavailabledeleted from eUICC of customer device

Note: Please note, when an eSIM becomes "Unavailable" it will automatically switch back to “Released” so it can be re-installed again.

Example Request#

curl -X GET \
https://services.truphone.com/connect-api/v2/sims/8944474600000109251 \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-H 'X-Correlation-ID: unique-id-from-requester-123'

Example Response#

{
"iccid": "8944471111111119506",
"status": "Released",
"matching_id": "5C-ZYXZZ-1R54O94",
"last_modified": "2020-12-03T08:56:00Z",
"_metadata": {
"links": {
"_lpa": "LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94",
"_subscriptions": "{BASE_URL}/v2/subscriptions?iccid=8944478600000213141",
"_qrcode": "http://services.truphone.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXFC-1R5MO94",
"_self": "{BASE_URL}/v2/sims/8944471111111119506"
}
}
}