Skip to main content
GET
Get eSIM activation code
Required scope: PARTNER
Returns what your client needs to install a ready eSIM on their phone: the full activation code (lpa), its two parts (smdp_address and matching_id) and a QR code. Before the eSIM is ready, the request fails with 409 ESIM_NOT_READY. Wait for the partner.esim.ready webhook, or for status: ACTIVE on Get eSIM. The activation code is never sent in a webhook. Fetch it when you deliver the eSIM to your client.
Anyone who installs the eSIM with this code takes over the line. Send it only to your client.

Response fields

How to deliver the eSIM to your client

Give your client one of these, depending on their phone:
  • QR code: show qr_code. Your client scans it from their phone’s eSIM settings.
  • Android, manual entry: give smdp_address and matching_id. Your client types them in their phone’s eSIM settings.
  • iPhone (iOS 17.4 and later), one-tap link: build a link from lpa. Your client opens it on the iPhone and the eSIM installs from there.
The iPhone link is https://esimsetup.apple.com/esim_qrcode_provisioning?carddata= followed by the URL-encoded lpa. The $ and : characters must be encoded.
Your client must be in France when they activate the eSIM. See eSIM (France) for the install steps on each phone. Allo does not detect when the eSIM is installed on the phone. The line already rings the eSIM from the moment it is ready.

Errors

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The eSIM id returned by Order eSIM (eso-*).

Response

Activation code

data
object