eSIM API
GET /esims/:esimID
Oauth2

Returns an eSIM object from its ID

Query parameters

  • esimID string

    ID of the eSIM

Responses

  • 200 application/json

    eSIM fetched successfully

    Hide response attributes Show response attributes object
    • id string

      The eSIM's ID

    • iccid string

      The eSIM's ICCID

    • matchingID string

      The eSIM's matching ID

    • smdpPlus string

      The eSIM's associated SMDP+ server domain

    • msisdn string

      The eSIM's MSISDN

    • status string

      Statuses:

      • PROCESSING - The eSIM is currently being processed by the network and should soon be available
      • RELEASED - The eSIM has been created and ready to be downloaded and installed by the User
      • DOWNLOADED - The eSIM has been downloaded onto the User's device (this should be an ephemeral status on all modern devices as the installation process automatically starts once the download is complete). An eSIM "stuck" in this status could indicate an issue with the installation process.
      • INSTALLED - The eSIM has been installed onto the User's device
      • UNINSTALLED - The User has removed the eSIM from the device
      • EXPIRED - The eSIM has expired and has been released back to the network
      • ENABLED - The eSIM is installed and enabled in the User's device eSIMs
      • DISABLED - The eSIM is installed and disabled in the User's device eSIMS
      • ONLINE - The eSIM is currently active and connected to the network
      • OFFLINE - The eSIM is currently active but is disconnected from the network
      • UNAVAILABLE - We currently cannot provide information about this eSIM, please contact our support

      Values are PROCESSING, RELEASED, DOWNLOADED, INSTALLED, UNINSTALLED, EXPIRED, ENABLED, DISABLED, ONLINE, OFFLINE, or UNAVAILABLE.

    • qrCodeLink string

      QR code image URL for quick eSIM install
GET /esims/:esimID 
curl \
 --request GET 'https://zim.api.dev.zimconnections.com/esims/:esimID' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": "esim_igFqGZhkRTHb0UNiRuAAA",
  "iccid": 8948010000000012345,
  "msisdn": 447482482482,
  "status": "ONLINE",
  "smdpPlus": "smdpp.zimconnections.com",
  "matchingID": "64DF7EFC13EBEB1AA90F126A509BBDBD",
  "qrCodeLink": "images.zimconnections.com/..."
}