Set QR Status

5 min

Purpose

Sets the QR Status for the specified SIM.

Some virtual SIMs are provisioned onto mobile devices using a QR code. The QR Status allows you to track the lifecycle of the SIM.

The status is specified using the <qr-status> element.

If a SIM is selected that does not have a QR code associated with it, the response will be Invalid ICCID. If an invalid status value is supplied, the response will be Invalid Content.

Valid integer values for <qr-status> are:

0 = unassigned

1 = provided to customer

2 = reserved

3 = installed on device

4 = deleted from device

Operational Impact

API commands perform live configuration changes.

Changes take effect immediately.

Commands may affect SIM status, service availability, charging, or usage limits.

Requests cannot be undone automatically.

Ensure all parameters are validated before submitting requests to the production environment.

Endpoint

POST https://api.m2miportal.com
Content-Type: application/xml
Accept: application/xml

Request (XML)

<set-qr-status version="1" api-id="123456">
  <authentication>
    <username>username</username>
    <password>password</password>
  </authentication>
  <iccid>1234567890123456789</iccid>
  <qr-status>1</qr-status>
</set-qr-status>

Response (Success)

<set-qr-status-response api-id="123456">
  <api-outcome>Success</api-outcome>
</set-qr-status-response>

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.