Get a previously-issued eSIM

get https://api.simtex.io/ESIM/{eSIMId}

Current status (including usage) of the eSIM is also provided

Responses

Response body

object

string | null

ESIM Id

iccid

string | null

ESIM's ICCID

string | null

Thge SVG-formatted QR code to be used for activation of the eSIM on a specific device.

androidESIMActivation

object

Activation data for Android

activationCode

string | null

Activation Code for Android

iosESIMActivation

object

Activation data for iOS

smDpPlusAddress

string | null

SM-DP+ Address

activationCode

string | null

Activation Code for iOS

iosUniversalLink

string | null

Returns a constructed iOS Universal link
Example: https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.io$4K-1U0UQ2-1C004LP

esimUrl

string | null

URl to a page that enables eSIM activation, status tracking, topup ordering and cancellation

replacedByESIMOrderId

string | null

Replaced by eSIM Order Id

replacementForESIMOrderId

string | null

eSIM Id for the eSIM order Replacement for

purchasedOnPortal

boolean

Indicates whether this eSIM was purchased using a shopping cart on a portal.
In case false, it is an eSIM that was purchased otherwise (API, Bulk order) and a disclaimer should be displayed upon installation

currentStatus

string

Pending Active Replaced Cancelled

esimOrderId

string | null

eSIM Order Id

partnerName

string | null

Name Partner

customersPurtalStatusPageUrl

string | null

Url to (optionally Partner-branded) status page on customers portal

esimTypeName

string | null

ID of eSIM type with aggregator

esimProviderName

string | null

eSIM provider (aggregator) name

currencyCode

string | null

The currency (ISO-4217) in which the original order was made

shoppingCartId

string | null

The optional shopping cart id on which the eSIM was originally purchesed

customerName

string | null

Name of device holder

customerEmailAddress

string | null

Customer Email Address

firstNetworkActivityTime

date-time | null

Time first Network activity was detected on the eSIM

cancellationTime

date-time | null

Time the eSIM was cancelled (null means never cancelled)

replacedTime

date-time | null

Time this eSIM was replaced by another eSIM

initialDataOrder

object

Data order status

orderId

string | null

Original Order Id

timeOrdered

date-time

Time ordered

firstUsageTime

date-time | null

Time first usage was reported for this data order

timeDepleted

date-time | null

Time this data order was fully used

timeExpired

date-time | null

Time this data order was expired

days

int32

Number of days this package is valid.

usage

array of objects | null

List of data usage by country

usage

object

countryCode

string | null

The country code (Iso-3166-1 Alpha-2)

quotaGB

double

Data quota in GB

usageGB

double

Actual data used for this country

alerts

array of objects | null

Alerts sent for this data package

alerts

object

timestamp

date-time

Time when the alert was sent

countryCode

string | null

Iso-3166 Alpha-2 code of the country for which the alert was sent

string

NotRequired Email Webhook

usage

double

Usage at alert time

hoursToDeplete

double

Time in hours to deplete usage to a country at the time of sending the Alert

dataPackageStatus

string

Available Depleted Expired

topupDataOrders

array of objects | null

Topup Data Usage orders

topupDataOrders

object

orderId

string | null

Original Order Id

timeOrdered

date-time

Time ordered

firstUsageTime

date-time | null

Time first usage was reported for this data order

timeDepleted

date-time | null

Time this data order was fully used

timeExpired

date-time | null

Time this data order was expired

days

int32

Number of days this package is valid.

usage

array of objects | null

List of data usage by country

usage

object

countryCode

string | null

The country code (Iso-3166-1 Alpha-2)

quotaGB

double

Data quota in GB

usageGB

double

Actual data used for this country

alerts

array of objects | null

Alerts sent for this data package

alerts

object

timestamp

date-time

Time when the alert was sent

countryCode

string | null

Iso-3166 Alpha-2 code of the country for which the alert was sent

string

NotRequired Email Webhook

usage

double

Usage at alert time

hoursToDeplete

double

Time in hours to deplete usage to a country at the time of sending the Alert

dataPackageStatus

string

Available Depleted Expired

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.simtex.io/ESIM/eSIMId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized

404Not Found