Sign in

v24

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-19169310464.0 KB
Tools

Configure eSIM (download profile and/or enable subscription)

post/devices/{deviceId}/esim

Path parameters

deviceIdstring required

Headers

X-Device-Display-IDinteger

Request body

$schemastring uri

A URL to the JSON Schema for this object.

confirmationCodestring

Optional carrier-issued confirmation code (the 4th LPA segment). Required only for plans whose SM-DP+ challenges the device for one. Requires matchingId — the LPA spec only interprets segment 4 when segment 3 is present.

enableboolean required
matchingIdstring
smDpAddrstring required

Example request

{
  "$schema": "https://example.com/schemas/ConfigureESimBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

carrierstring required
displayNamestring required
iccidstring required
isEmbeddedboolean required
slotinteger required
subIdinteger required
typestring required

Example response

{
  "$schema": "https://example.com/schemas/ESimSubscription.json"
}