API v2.4 / eSIMs / Get eSIM details

Server

GET

/esims/{iccid}

eSIM Go API

This endpoint allows you to retrieve detailed information about a specific eSIM using its ICCID (Integrated Circuit Card Identifier).

eSIM profile statuses:

Released - The eSIM is not installed. If there is a firstInstalledDateTime then the eSIM has been installed previously and then uninstalled again.

Installed - The eSIM is installed.

Downloaded - This is unlikely to be seen very often. It would be when the bundle has been delivered to LPA, but the eSIM has not yet been released.

Unavailable - An eSIM in this status cannot be installed. We recommend reissuing a new eSIM instead, especially if the eSIM is not already installed.

Authorizations

apikeyAuth

Parameters

Path Parameters

iccid

required

string

(Required) The ICCID of the eSIM

Example

8944123456789012000

Query Parameters

additionalFields

string

Example

appleInstallUrl

Responses

200

object

iccid

The Integrated Circuit Card Identifier of the SIM card

string

894123456789123456

pin

The Personal Identification Number for the SIM card

string

puk

The Personal Unblocking Key for the SIM card

string

123445678

matchingId

A unique identifier for matching purposes (used for eSIM activation)

string

JQ-123456-ABCDEPFX

smdpAddress

The Subscription Manager Data Preparation server address (used for eSIM activation)

string

http://rsp.example.com

profileStatus

The current status of the SIM profile

string

Installed

firstInstalledDateTime

The timestamp of when the profile was first installed (in milliseconds since epoch)

integer format: int64

1723541877280

customerRef

Customer reference information

string

appleInstallUrl

URL used for eSIM installation for devices with IOS 17.4 and above

string

https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$rsp-1234.example.com$ABCD-ABCD-ABCD-ABCD