Skip to main content
GET
Get install details
Offer these in the order they appear, because the first that works is the one nobody has to think about:
The activation code installs a working SIM. Treat it as a credential: show it to the person the eSIM is for, and do not log it.

Error codes

Authorizations

Authorization
string
header
required

A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.

Path Parameters

profileId
string
required

eSIM ULID. A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

Response

Successful response.

profileId
string
required

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

status
string
required
activationCode
string | null
required

The LPA string, e.g. LPA:1$smdp.example.com$MATCHING-ID.

qrCodePayload
string | null
required

The same string. Render it as a QR code for the traveller to scan.

One-tap install on a device that supports it.

manual
object
required
iccid
string | null
required