PressOne eSIM Developer Platform
  1. Install eSIM
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
          • Request access token
        • Check balance
          • Get balance
        • Compatible devices
          • Get compatible device lite list
        • Browse packages
          • Get packages
        • Place order
          • Submit order
        • Install eSIM
          • Get eSIM
            GET
          • Get installation instructions
            GET
        • Monitor usage
          • Get usage (data, text & voice)
        • Place top up order
          • Get top-up package list
          • Submit top-up order
        • Manage orders
          • Get order list
          • Get order
        • Manage eSIMs
          • Get eSIMs list
          • Get eSIM package history
    • Voice-only eSIM
      • Getting Started
      • Error handling
      • Endpoints
        • List Available Numbers
        • Claim Number
        • Renew Number
        • List User
  1. Install eSIM

Get installation instructions

GET
/customer/v2/sims/{iccid}/instructions
This endpoint allows you to retrieve the language specific installation instructions of a specific eSIM from the PressOne ESIM API using the eSIM's ICCID.
The access token, obtained from the "Request Access Token" endpoint, should be included in the request.
direct_apple_installation_url:
Partner 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

Header Params

Responses

🟢200Get Installation instructions (200)
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://prod.your-api-server.com/customer/v2/sims//instructions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'Accept-Language: en'
Response Response Example
{
    "data": {
        "instructions": {
            "language": "EN",
            "ios": [
                {
                    "model": null,
                    "version": "14,15,13",
                    "installation_via_qr_code": {
                        "steps": {
                            "1": "Go to Settings > Cellular/Mobile > Add Cellular/Mobile Plan.",
                            "2": "Scan the QR Code.",
                            "3": "Tap on 'Add Cellular Plan'.",
                            "4": "Label the eSIM.",
                            "5": "Choose preferred default line to call or send messages.",
                            "6": "Choose the preferred line to use with iMessage, FaceTime, and Apple ID.",
                            "7": "Choose the eSIM plan as your default line for Cellular Data and do not turn on 'Allow Cellular Data Switching' to prevent charges on your other line.",
                            "8": "Your eSIM has been installed successfully, please scroll down to see the settings for accessing data."
                        },
                        "qr_code_data": "LPA:1$lpa.airalo.com$TEST",
                        "qr_code_url": "https://sandbox.airalo.com/qr?expires=1797582688&id=115516&signature=3ee338b2d3405e913f1961993947236cc5c6b6c6c1d22d5e7da6e1281b6cefe6",
                        "direct_apple_installation_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$wbg.prod.ondemandconnectivity.com$Y7MRQ886FCDJD4RH"
                    },
                    "installation_manual": {
                        "steps": {
                            "1": "Go to Settings > Cellular/Mobile > Add Cellular/Mobile Plan.",
                            "2": "Tap on 'Enter Details Manually'.",
                            "3": "Enter your SM-DP+ Address and Activation Code.",
                            "4": "Tap on 'Add Cellular Plan'.",
                            "5": "Label the eSIM.",
                            "6": "Choose preferred default line to call or send messages.",
                            "7": "Choose the preferred line to use with iMessage, FaceTime, and Apple ID.",
                            "8": "Choose the eSIM plan as your default line for Cellular Data and do not turn on 'Allow Cellular Data Switching' to prevent charges on your other line.",
                            "9": "Your eSIM has been installed successfully, please scroll down to see the settings for accessing data."
                        },
                        "smdp_address_and_activation_code": "lpa.airalo.com"
                    },
                    "network_setup": {
                        "steps": {
                            "1": "Select your  eSIM under 'Cellular Plans'.",
                            "2": "Ensure that 'Turn On This Line' is toggled on.",
                            "3": "Go to 'Network Selection' and select the supported network.",
                            "4": "Turn on the Data Roaming.",
                            "5": "Need help? Chat with us."
                        },
                        "apn_type": "manual",
                        "apn_value": "singleall",
                        "is_roaming": true
                    }
                }
            ],
            "android": [
                {
                    "model": null,
                    "version": null,
                    "installation_via_qr_code": {
                        "steps": {
                            "1": "Go to Settings > Connections > SIM Card Manager.",
                            "2": "Tap on 'Add Mobile Plan'.",
                            "3": "Tap on 'Scan Carrier QR Code' and tap on 'Add'.",
                            "4": "When the plan has been registered, tap 'Ok' to turn on a new mobile plan.",
                            "5": "Your eSIM has been installed successfully, please scroll down to see the settings for accessing data."
                        },
                        "qr_code_data": "LPA:1$lpa.airalo.com$TEST",
                        "qr_code_url": "https://sandbox.airalo.com/qr?expires=1797582688&id=115516&signature=3ee338b2d3405e913f1961993947236cc5c6b6c6c1d22d5e7da6e1281b6cefe6"
                    },
                    "installation_manual": {
                        "steps": {
                            "1": "Go to Settings > Connections > SIM Card Manager.",
                            "2": "Tap on 'Add Mobile Plan'.",
                            "3": "Tap on 'Scan Carrier QR Code' and tap on 'Enter code instead'.",
                            "4": "Enter the Activation Code (SM-DP+ Address & Activation Code).",
                            "5": "When the plan has been registered, tap 'Ok' to turn on a new mobile plan.",
                            "6": "Your eSIM has been installed successfully, please scroll down to see the settings for accessing data."
                        },
                        "smdp_address_and_activation_code": "lpa.airalo.com"
                    },
                    "network_setup": {
                        "steps": {
                            "1": "In the 'SIM Card Manager' select your  eSIM.",
                            "2": "Ensure that your eSIM is turned on under 'Mobile Networks'.",
                            "3": "Enable the Mobile Data.",
                            "4": "Turn on the Data Roaming.",
                            "5": "Go to Settings > Connections > Mobile networks > Network Operators.",
                            "6": "Ensure that the supported network is selected.",
                            "7": "Need help? Chat with us."
                        },
                        "apn_type": "manual",
                        "apn_value": "singleall",
                        "is_roaming": true
                    }
                }
            ]
        }
    },
    "meta": {
        "message": "success"
    }
}
Modified at 2025-11-17 11:12:48
Previous
Get eSIM
Next
Get usage (data, text & voice)
Built with