Skip to main content
GET
/
subscriptions
/
{subscriptionId}
/
esim
/
qrcode
{
  "subscriptionId": "d8174435-6378-4be5-a9f5-8b4aaadae5d4",
  "qrCodeData": "LPA:1$rsp-prod.example.com$12345678-1234-1234-1234-123456789012",
  "qrCodeUrl": "https://esim.your-domain.com/qr/d8174435-6378-4be5-a9f5-8b4aaadae5d4",
  "expiresAt": "2024-12-31T23:59:59Z",
  "metadata": {}
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

​
subscriptionId
string
required

The unique identifier of the subscription.

Response

eSIM QR code data and hosted URL retrieved successfully.

eSIM QR code data and hosted URL for a subscription's eSIM profile.

​
subscriptionId
string
required

The unique identifier of the subscription this QR code belongs to.

Example:

"d8174435-6378-4be5-a9f5-8b4aaadae5d4"

​
qrCodeData
string
required

The QR code data string that contains the eSIM profile download information (LPA format).

Example:

"LPA:1$rsp-prod.example.com$12345678-1234-1234-1234-123456789012"

​
qrCodeUrl
string<uri>
required

Hosted URL where the QR code image can be accessed for display or download.

Example:

"https://esim.your-domain.com/qr/d8174435-6378-4be5-a9f5-8b4aaadae5d4"

​
expiresAt
string<date-time>
required

When the QR code and hosted URL expire. After this time, a new QR code should be requested.

Example:

"2024-12-31T23:59:59Z"

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I