Skip to content

Get eSIM details and status

GET
/esims/{iccid}

Receive eSIM details for an ICCID

Authorizations

Parameters

Path Parameters

iccid
required
string

The ICCID of the eSIM

Responses

200

ESIM Status

object
iccid

The ICCID of the eSIM

string
matchingId

Activation Code for eSIM

string
smdpAddress

The SMDP+ Address of the eSIM

string
profileStatus

The status of the eSIM profile

string
Allowed values: Released Downloaded Installed Unavailable
pin

The PIN of the eSIM

string
puk

The PUK of the eSIM

string
firstInstalledDateTime

First install date and time (UTC in Milliseconds)

string format: date-time

400

Bad Request - returned when the given ICCID is not found and/or permission to view this ICCID is not granted

object
message

Status of api functions which do not return data

string

403

Unauthorised - returned when the api token is invalid

object
message

Status of api functions which do not return data

string

500

Server Error

object
message

Status of api functions which do not return data

string