API v2.4 / eSIMs / Get eSIM Install Details

Server

GET

/esims/assignments

eSIM Go API

eSIM SMDP+ Details Retrieval Endpoint

This API endpoint retrieves eSIM SMDP+ details based on provided Order or Apply References.

Key features:

Input: One or multiple reference numbers can be submitted via query parameters.
Output: For each reference, the system returns:
- ICCID (Integrated Circuit Card Identifier)
- SMDP+ (Subscription Manager Data Preparation) address
- Matching ID
Output format options:
- Default: text/csv
- Alternative formats: application/json, application/zip
- Format selection is controlled via the ‘Accept’ header in the request
Special functionality: When requesting ‘application/zip’, the response is a ZIP file containing QR code images in PNG format.

Authorizations

apikeyAuth

Parameters

Query Parameters

reference

string

(Required) Order Reference or Apply Reference

additionalFields

string

Example

appleInstallUrl

Responses

200

object

iccid

The ICCID (Integrated Circuit Card Identifier) of the eSIM

string

8944123456789012345

matchingId

The matching ID for the eSIM profile

string

A1B2-C3D4-E5F6-G7H8

smdpAddress

The address of the Subscription Manager Data Preparation (SM-DP+) server

string

http://smdp.example.com

profileStatus

The current status of the eSIM profile

string

Released

pin

The PIN (Personal Identification Number) for the eSIM

string

puk

The PUK (PIN Unlock Key) for the eSIM

string

12345678

firstInstalledDateTime

The date and time when the profile was first installed

string format: date-time

2023-06-15T14:30:00.000Z

Example

{
  "iccid": "8944123456789012345",
  "matchingId": "A1B2-C3D4-E5F6-G7H8",
  "smdpAddress": "http://smdp.example.com",
  "profileStatus": "Released",
  "pin": "1234",
  "puk": "12345678",
  "firstInstalledDateTime": "2023-06-15T14:30:00.000Z"
}