Add your Key ID and Secret to send test requests.
List your profiles
Returns every eSIM profile you hold, across all orders, each with the iccid that addresses it and the activation code that installs it.
Authorization
KeyId ApiSecret x-key-id<token>
Your API key id.
In: header
x-api-secret<token>
Your API key secret.
In: header
Query Parameters
page?integer
Default
1Range
1 <= value <= 10000pageSize?integer
Default
50Range
1 <= value <= 200Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/esim/profiles?page=1&pageSize=50" \ -H "x-key-id: YOUR_KEY_ID" \ -H "x-api-secret: YOUR_API_SECRET"{
"data": [
{
"iccid": "8944500102030405060",
"activationCode": "LPA:1$smdp.example.com$EXAMPLE-CODE-0001",
"appleInstallUrl": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.com$EXAMPLE-CODE-0001",
"installationAvailable": true
},
{
"iccid": "8944500102030405061",
"activationCode": "LPA:1$smdp.example.com$EXAMPLE-CODE-0002",
"appleInstallUrl": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.com$EXAMPLE-CODE-0002",
"installationAvailable": true
}
],
"meta": {
"page": 1,
"pageSize": 2,
"total": 7,
"totalPages": 4,
"hasNext": true
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request is not valid. See `fields` for what to correct.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "AUTHENTICATION_REQUIRED",
"message": "This endpoint requires an API key.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "CONFLICT",
"message": "The resource is not in a state that allows this operation.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry after the interval in `Retry-After`.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Something went wrong on our side.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "SERVICE_RESPONSE_INVALID",
"message": "The upstream service returned an unexpected response.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is temporarily unavailable. Try again shortly.",
"requestId": "9f1c7b2e-…"
}
}Get an order GET
Returns an order's status and, once delivered, the profiles it produced.
Get a profile GET
Returns one eSIM profile: its status, and the activation code plus Apple one-tap link that install it. The activation code IS the QR payload — render it as a QR locally rather than expecting a hosted image. Treat it as a credential: it is never cached and never logged.