1. Manage eSIMs
PressOne eSIM Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • User journeys
      • Top-up Journey
      • Purchase Journey
    • Guides
      • eSIM installation methods for API Partners
      • How to generate the QR code for an eSIM
  • REST API
    • Data / Data + Voice + SMS eSIM
      • Introduction
      • Error handling
      • Endpoints
        • Authenticate
          • Get token information
          • Refresh access token
          • Request access token
        • Check balance
          • Get balance
        • Compatible devices
          • Get compatible device lite list
        • Browse packages
          • Get packages
        • Place order
          • Submit order
        • Manage orders
          • Get order list
          • Get order
        • Manage eSIMs
          • Get eSIM by ICCID
            GET
          • Get eSIMs list
            GET
          • Get eSIM package history
            GET
        • Install eSIM
          • Get installation instructions
        • Monitor usage
          • Get usage (data, text & voice)
        • Place top up order
          • Get top-up package list
          • Submit top-up order
    • Voice-only eSIM
      • Getting Started
      • Error handling
      • Endpoints
        • List Available Numbers
        • Claim Number
        • Renew Number
        • List User
    • SMS
      • Introduction
      • Authentication
      • Conventions
        • Response envelope
        • Errors
        • Rate limits
        • Idempotency
        • Date ranges & timezone
        • Pagination
      • Endpoints
        • Send an SMS
          • Send SMS /api/sms/send
        • List message logs
          • List message logs /api/sms/logs
        • Get statistics
          • Get statistics /api/sms/statistics
        • Export logs (CSV)
          • Export logs (CSV) /api/sms/export
        • Analytics
          • Overview
            • Overview /api/sms/analytics/overview
          • Message volume
            • Message volume /api/sms/analytics/message-volume
          • Delivery status distribution
            • Delivery status distribution /api/sms/analytics/delivery-status
          • Delivery report
            • Delivery report - /api/sms/analytics/delivery-report
        • Check wallet balance
          • Check wallet balance /api/sms/balance
        • Send an OTP
          • Send an OTP /api/sms/otp/send
        • Verify an OTP
          • Verify an OTP /api/sms/otp/verify
      • Delivery webhooks
        • Delivery webhooks
      • Message lifecycle & statuses
        • Message lifecycle & statuses
      • Appendix: message object
        • Appendix: message object
  1. Manage eSIMs

Get eSIM by ICCID

GET
/customer/v2/sims/{iccid}
This endpoint allows you to retrieve the details of a specific eSIM from the PressOne ESIM API using the eSIM's ICCID. Note that only eSIM orders made via the API are retrievable via this endpoint. You can include related data in the response by specifying optional parameters.
The access token, obtained from the "Request Access Token" endpoint, should be included in the request.
direct_apple_installation_url:
API now supports direct installation on iOS devices. With the introduction of Universal Links by Apple, users with iOS 17.4 or higher can directly install eSIMs using a special URL, which can be provided to your end clients if they are using iOS version 17.4 or above.

Request

Path Params

Query Params

Header Params

Responses

🟢200Get eSIM (200)
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://prod.your-api-server.com/customer/v2/sims/?include=order%2Corder.status%2Corder.user%2Cshare%2C%20package' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'
Response Response Example
{
    "data": {
        "id": 11028,
        "created_at": "2023-02-27 08:30:14",
        "iccid": "8944465400000267221",
        "lpa": "lpa.airalo.com",
        "imsis": null,
        "matching_id": "TEST",
        "qrcode": "LPA:1$lpa.airalo.com$TEST",
        "qrcode_url": "https://sandbox.airalo.com/qr?expires=1763800214&id=13282&signature=93bc1599eaaea3175eb32a9f23b3961273e97f04c50ba1b57b68ac99bc6677df",
        "direct_apple_installation_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$wbg.prod.ondemandconnectivity.com$Y7MRQ886FCDJD4RH",
        "voucher_code": null,
        "airalo_code": null,
        "apn_type": "automatic",
        "apn_value": null,
        "is_roaming": true,
        "confirmation_code": "5751",
        "order": null,
        "brand_settings_name": "our perfect brand",
        "recycled": true,
        "recycled_at": "2025-05-05 10:52:39",
        "simable": {
            "id": 9647,
            "created_at": "2023-02-27 08:30:14",
            "code": "20230227-009647",
            "description": null,
            "type": "sim",
            "package_id": "kallur-digital-7days-1gb",
            "quantity": 1,
            "package": "Kallur Digital-1 GB - 7 Days",
            "esim_type": "Prepaid",
            "validity": "7",
            "price": "9.50",
            "data": "1 GB",
            "currency": "USD",
            "manual_installation": "<p><b>eSIM name: </b>Kallur Digital</p><p><b>Coverage:</b> Faroe Islands</p><p><b>To manually activate the eSIM on your eSIM capable device:</b></p><p>1. Settings> Cellular/Mobile> Add Cellular/Mobile Plan.</p><p>2. Manually enter the SM-DP+ Address and activation code.</p><p>3. Confirm the eSIM plan details</p><p>4. Label the eSIM.</p><p><b>To access Data:</b></p><p>1. Enable data roaming.</p><p><b>To top-up:</b></p><p></p><p>Visit airalo.com/my-esims or \"My eSIMs\" tab in your Airaloo app.</p><p><br></p>",
            "qrcode_installation": "<p><b>eSIM name:</b> Kallur Digital</p><p><b>Coverage: </b>Faroe Islands</p><p><b>To activate the eSIM by scanning the QR code on your eSIM capable device you need to print or display this QR code on other device:</b></p><p>1. Settings> Cellular/Mobile> Add Cellular/Mobile Plan.</p><p>2. Scan QR code</p><p>3. Confirm the eSIM plan details</p><p>4. Label the eSIM</p><p><b>To access Data:</b></p><p>1. Enable data roaming</p>",
            "installation_guides": {
                "en": "https://sandbox.airalo.com/installation-guide"
            },
            "status": {
                "name": "Completed",
                "slug": "completed"
            },
            "user": {
                "id": 120,
                "created_at": "2023-02-20 08:41:57",
                "name": "User Name",
                "email": "email@domain.com",
                "mobile": null,
                "address": null,
                "state": null,
                "city": null,
                "postal_code": null,
                "country_id": null,
                "company": "Company Name"
            },
            "sharing": {
                "link": "https://esims.cloud/our-perfect-brand/a4g5ht-58sdf1a",
                "access_code": "4812"
            }
        }
    },
    "meta": {
        "message": "succes"
    }
}
Modified at 2026-06-24 12:17:51
Previous
Get order
Next
Get eSIMs list
Built with