Allo

Get eSIM activation code

Returns the activation code of a ready eSIM: the LPA string, the SM-DP+ address, the matching id and a QR code. Before the eSIM is ready, the request fails…

GET/v2/api/partner/esims/{id}/activation_code

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.

Response fields

FieldDescription
lpaThe full activation code, in the form LPA:1$<smdp_address>$<matching_id>
smdp_addressThe SM-DP+ address, for manual entry
matching_idThe activation code, for manual entry
qr_codeA PNG data URI of a QR code that encodes lpa. Use it as the src of an <img> tag.

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.

const { lpa } = activationCode;
const link =
  "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=" +
  encodeURIComponent(lpa);

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

CodeWhat it means
ESIM_NOT_READYThe eSIM is not ready to install yet. Always retryable: true.
PARTNER_ESIM_REVOKEDThe eSIM was revoked (409): its activation code is no longer available.
PARTNER_ESIM_NOT_FOUNDNo eSIM with this id was ordered on an account your API key created.
ESIM_UNAVAILABLEThe activation code cannot be read right now. Retry later.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

idstringrequired

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

Responses

200Activation code
dataobject
4 fields
lpastring

Full activation code, LPA:1$<smdp_address>$<matching_id>.

smdp_addressstring

SM-DP+ address, for manual entry on Android.

matching_idstring

Matching id (activation code), for manual entry on Android.

qr_codestring

PNG data URI of a QR code that encodes lpa.

401
403The API key lacks the PARTNER scope.
errorobject
404No eSIM with this id was ordered on an account your API key provisioned (PARTNER_ESIM_NOT_FOUND).
errorobject
409The eSIM is not ready to install yet (ESIM_NOT_READY). Wait for the partner.esim.ready webhook.
errorobject
429
500The activation code cannot be read right now (ESIM_UNAVAILABLE).
errorobject