eSIM installation methods for API Partners

eSIM Installation Methods (Data eSIM Service)

PressOne offers flexible approaches for handling eSIM installations for the Data eSIM Service (data-only or data+voice+SMS plans), catering to varying levels of control and customization.

Note: These installation methods apply to the Data eSIM Service only. The Voice-Only eSIM Service uses a different provisioning process.

1. Create Full Installation Instructions

Take full control by creating and managing eSIM installation instructions for your users.

Key steps:

Access the QR code:

Retrieve the QR code from the API endpoints (Submit Order or Get eSIM).

The qrcode attribute contains the LPA string (e.g., "LPA:1$lpa.provider.com$TEST") that you can encode into a QR code.

Alternatively, use the qrcode_url attribute to display a pre-generated QR code image.

Provide manual installation instructions:

Share the activation code (matching_id) and SM-DP+ address (lpa) for manual installation.

These are returned in the order response under the sims array.

Guide network setup:

Include instructions for enabling roaming (check is_roaming status).

Configure the APN if required (apn_type and apn_value attributes).

2. Use Multilingual Installation Instructions

Leverage PressOne's multilingual installation instructions to simplify content creation and enhance user experience.

Endpoint: GET /customer/v2/sims/:iccid/instructions

Query parameter: language (optional, e.g., "en", "es", "fr")

Returns:

QR code installation steps

Manual installation steps

Network setup instructions

Help URL with detailed instructions

Advantages:

Reduces development effort

Supports multiple languages for global accessibility

Provides consistent, tested installation instructions

3. Email Delivery of Installation Instructions

Let PressOne handle end-user communication with partner-branded emails containing installation instructions.

Key features:

Multilingual support

Emails include installation instructions

Email delivery is managed by our provider infrastructure

How to use:

Include the to_email parameter when submitting orders via the Submit Order endpoint. You can also provide copy_address for BCC copies.

Request Example:

{
  "package_id": "abc123",
  "package_name": "Turkey 7 Days 1GB",
  "quantity": 1,
  "price": 4.50,
  "currency": "USD",
  "to_email": "customer@example.com",
  "copy_address": ["support@yourcompany.com"]
}

Notes:

Available for standard orders only (not async orders)

Each eSIM purchase triggers a separate email

Email content and templates are managed by the provider

How to Generate the QR Code for an eSIM (Data eSIM Service)

When you submit an order using POST /customer/v2/orders for the Data eSIM Service, the response includes two options for displaying QR codes:

qrcode: A QR code data string that you can use to generate your own QR code image

Example: "LPA:1$lpa.provider.com$TEST"

This is the raw data that should be encoded into a QR code

qrcode_url: A pre-generated QR code image URL that you can display directly

Example: "https://api.pressone.com/qr?id=61038..."

You can use this URL directly in an <img> tag

Option 1: Generate QR Code Using JavaScript Library

You can generate QR codes on your website using any QR code generation library. Here is an example using the QRCodeJS library:

Note: This is example code for your implementation. You can use any QR code generation library or method that suits your technology stack.

Option 2: Use Pre-generated QR Code URL

Alternatively, you can simply display the pre-generated QR code image using the qrcode_url from the API response:

Note: The qrcode attribute contains the LPA (Local Profile Assistant) string that devices use to install the eSIM. The qrcode_url is a convenience option if you prefer not to generate the QR code yourself.

eSIM Installation Methods (Data eSIM Service)#

1. Create Full Installation Instructions#

2. Use Multilingual Installation Instructions#

3. Email Delivery of Installation Instructions#

How to Generate the QR Code for an eSIM (Data eSIM Service)#

Option 1: Generate QR Code Using JavaScript Library#