Partner

Get eSIM activation code

Changed on

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 with ESIM_NOT_READY. Requires the PARTNER scope.

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

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/partner/esims/{id}/activation_code
  • Auth
    API key in header Authorization

Path parameters

idstring required

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

Response

Activation code

Example response

{
  "data": {
    "lpa": "LPA:1$smdp.example.com$ABCD-1234-EFGH-5678",
    "smdp_address": "smdp.example.com",
    "matching_id": "ABCD-1234-EFGH-5678",
    "qr_code": "data:image/png;base64,iVBORw0KGgo..."
  }
}

Changes