API v2.2 / eSIMs / Get eSIM details and status

Server eSIMGo API - https://api.esim-go.com/v2.2

GET

/esims/{iccid}

• eSIMGo API

Receive eSIM details for an ICCID

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.

Deactivated - The eSIM has been deactivated and can no longer be used.

Authorizations

• apiKeyAuth
• apiKeyQueryAuth

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 Deactivated

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