SIM operations

The following SIM operations are available using the SIM API. See the Swagger detailed in the next column for an endpoint description and examples, and to try out the API.

You must have the relevant permissions to make a request.

Using the Swagger interface

To authorise your SIM API session:

  1. In the right-hand Swagger column, select Authorize at the top right of the Swagger window, or select alongside an endpoint.

    The Available authorizations window appears. You can either use the client ID and client secret for authorization, or alternatively, an access token.

  2. If you are using the client ID and client secret, insert the credentials into the ClientCredentialsOauth2 client_id and client_secret boxes.

  3. Select Authorize, then select Close to use the Swagger interface and make SIM API requests.

  4. If you are using an access token, in the CognitoEseyeUserPoolAuthorizer Value box, paste the unique access_token.

    The access_token is generated when you authenticate your service account. For more information, see Using a service account to access the API.

  5. Select Authorize, then select Close to use the Swagger interface and make SIM API requests.

To use the Swagger interface:

  1. Select an endpoint link in the API procedures below, or scroll to the relevant endpoint in the Swagger interface.

    The parameters and schema values are described in detail on the Swagger interface.

  2. If there is a Request Body or Response where one or more Example Value is displayed, select Schema to view the available values for each field, as well as details about that key/value pair.

    For example, customerSuspend is a string that can either have a yes or no value:

  3. Ensure you are authorised to try out the SIM API.

  4. Alongside the Parameters heading for that endpoint, select Try it out.

    The values in each parameter become active, and no longer appear greyed out.

  5. Overwrite the example values with your own parameters.

    The supplied example values will not necessarily return any related SIMs on your account. You must remove the example values when testing the SIM API from the Swagger interface.

    If the parameter is not required, you can leave it blank.

  6. For POST and PATCH endpoints that contain a Request Body, type new values for the relevant fields.

    You can remove key/value pairs that you do not need from the Request Body.

  7. Select Execute at the bottom of the endpoint section to make the request.

  8. In the Responses section, view the returned SIM API response.

    The response includes an example Curl script and the Request URL, as well as the response from the server.

Using the Postman Collection and Environment

We have also supplied a Postman Collection and Environment for the SIM API.

You must have already performed base 64 encoding on your client ID and client secret. For more information, see SIM API Introduction.

To view and use the supplied Postman files:

  1. Download the following JSON files:

  2. Import the downloaded files into your Postman application.
  3. In the Postman Environments workspace, ensure SIM API is the active environment.

  4. In the AnyNet SIM API environment, ensure that iccid Current value contains a test SIM ICCID that you are wanting to use for testing the API.

    This SIM must already exist in your Infinity account.

  5. Ensure that the Base64string Current value contains your generated base 64 string for authentication.

  6. In the Postman Collections workspace, send POST Get Access Token to authenticate your API session.

    The Response includes the access_token, for example:

  7. Copy the access_token.

  8. Select the AnyNet SIM API collection top level folder, then view the Authorization tab.

  9. Alongside Token, delete the example access_token, then paste the new access_token.

  10. Save your changes.

    The token will last for one hour only.

  11. Start using the API.

Viewing SIM details for all SIMs

To view details for all SIMs that meet the specified query parameters:

  • Call GET /api/v2/sim

    You can filter the returned results by one or more of the following parameters: ICCID, SIM ID, mobile network operator ID, portfolio ID, package ID, suspension status (there are three different suspension status types – adminSuspend, systemSuspend, and customerSuspend), and SIM status.

Viewing SIM details for a single SIM

To view details for a single SIM:

Updating details for a single SIM

To update a single SIM details:

  1. Call PATCH /api/v2/sim/{iccId}, where {iccid} is the ICCID that you want to update.

  2. In the request body, set the relevant fields to perform the following actions:

    Activate or deactivate a SIM

    Suspend or unsuspend a SIM

    Change SIM package

    Change SIM portfolio

  3. Execute the call.

    The current SIM details are returned, including the new status.

Activate or deactivate a SIM

To activate or deactivate a SIM:

  • In the request body, set the SIM status to either:

    • active – activates the SIM on the network

      An active SIM or IMSI is charged at standard service charge rates, and for any usage. For more information, see Understanding the SIM lifecycle.

    • available – deactivates the SIM so it no longer connects to the network

Suspend or unsuspend a SIM

To suspend or unsuspend a SIM:

  • In the request body, set customerSuspend to either:

    yes – closes an active SIM's data sessions and disables all services so it becomes unavailable for use; standard rate service charges continue

    no – unsuspends the SIM so it is available for use

    You cannot update a suspended SIM.

Customers may suspend their SIM for the following reasons:

  • To prevent unauthorised usage if the device is lost or stolen
  • They want to move the SIM to a different device, but not immediately
  • They are not using the device for a significant period of time, but want to maintain the current contract for that device

Customers can reactivate their suspended SIMs.

For more information, see Understanding the SIM lifecycle.

Change SIM package

To change the SIM package:

  • In the request body, set packageId to the desired package identifier.

    The desired package must already exist on your Infinity account.

Cameron - explanation of bus logic (same for portfolio change) - must exist sphere

Change SIM portfolio

To change the SIM portfolio:

  • In the request body, set portfolioId to the desired portfolio identifier.

    The desired portfolio must already exist on your Infinity account.

Viewing all attributes for a single SIM

SIM attributes provide extra details about a SIM or device, and make it easy to group and find related SIMs or devices by their shared attributes. Each attribute consists of a unique identifier and a key-value pair.

To view all attributes for the current ICCID:

Creating one or more new SIM attributes

To create one or more new SIM attributes for the current ICCID:

  1. Call POST /api/v2/sim/{iccId}/attribute, where {iccid} is the ICCID where you want to create the new attribute.

  2. In the request body, supply an attribute key and associated value per attribute that you want to create.

    See the Swagger interface for details.

  3. Execute the call.

    The current SIM updates with the new attributes.

Deleting a specific SIM attribute

Viewing a specific SIM attribute

To view a specific SIM attribute:

Updating a specific SIM attribute

  1. Call PATCH /api/v2/sim/{iccId}/attribute/{iccAttributeId}, where {iccid} is the ICCID where the attribute exists, and {iccAttributeId} identifies the attribute whose value you want to update.

  2. In the request body, type a new value for the attribute.

    The API returns the updated attribute.

Changing SIM P