Query IMSI
6 min
Purpose
Returns one or more IMSIs associated with the SIM specified in the <iccid> element.
Traditional SIMs typically have a single IMSI. However, some SIM types support multiple IMSIs, including:
- Multi-IMSI SIMs
- Dual-IMSI configurations
- eSIM profiles with alternative IMSIs downloaded to the SIM
This request returns all IMSIs associated with the SIM.
Endpoint
POST https://api.m2miportal.com
Content-Type: application/xml
Accept: application/xml
Request (XML)
<query-imsi version="1" api-id="123456">
<authentication>
<username>username</username>
<password>password</password>
</authentication>
<iccid>1234567890123456789</iccid>
</query-imsi>Response (Success)
<query-imsi-response api-id="123456">
<api-outcome>Success</api-outcome>
<imsi>234101234567890</imsi>
<imsi>234581234567890</imsi>
<imsi>234301234567890</imsi>
</query-imsi-response>Response Elements
Element | Description |
|---|---|
<imsi> | One or more IMSIs associated with the SIM. Maximum 15 digits per IMSI. |
If no IMSIs can be identified for the SIM, an empty <imsi> element will be returned.
Behaviour Notes
- Single-IMSI SIMs will return one <imsi> element.
- Multi-IMSI and eSIM configurations may return multiple <imsi> elements.
- The API does not identify which IMSI is currently active or in use.
Response (Failure)
If a request cannot be processed, the response will include:
- api-outcome indicating failure
- An error description explaining the reason
Failure responses may occur due to:
- Invalid authentication credentials
- Invalid or unknown identifiers (for example ICCID or MSISDN)
- Invalid or missing parameters
- Values not permitted for the specified SIM type or account configuration
- Insufficient permissions
Integrating systems should validate input data before submission and implement appropriate error handling and logging.