IMEI Management
nRF Cloud IMEI services provide support functions for your manufacturing and operations, such as the ability to order and list IMEIs.
The IMEIs page is located in the admin panel and requires an admin role.
The following table summarizes IMEI handling and services for Nordic Semiconductor products.
| Product | Ordering | Listing | Info |
|---|---|---|---|
| nRF9160 | N/A | X | Modules contain a Nordic-programmed IMEI. |
| nRF9161 | X | X (Nordic TAC) | Modules do not contain a ready-programmed IMEI. You can order IMEIs from nRF Cloud or use your own TAC range. Listing supported for IMEIs ordered from nRF Cloud. |
| nRF9151 | N/A | X | Modules contain a ready-programmed Nordic IMEI, which can be listed. Modules also support custom TAC range IMEI programming, which is used by the modem. |
| nRF9131 | N/A | N/A | Modules require your own device model TAC range. |
| Thingy:91, Development Kits, Evaluation Kits | N/A | N/A | Thingy:91 devices, Development Kits, and Evaluation Kits are ready-programmed with an IMEI (labeled on the board). IMEI listing is not supported for individual devices. |
Ordering
You can use nRF Cloud to order IMEIs for your supported devices. This means you do not need your own TAC range for prototype builds and production-grade batches under 100k devices.
Development kits (DKs) and Thingy devices are delivered with pre-programmed IMEIs, so you do not need to order IMEIs for them.
Beginning in June 2023, Nordic Semiconductor nRF9161 SiPs for production are no longer pre-programmed with IMEIs. The nRF Cloud IMEI ordering service allows small- to medium-scale customers to order and use IMEIs from Nordic Semiconductor Type Allocation Code (TAC) ranges. However, nRF9160 and nRF9151 devices are pre-programmed with IMEIs and you can overwrite the nRF9151 with a custom IMEI if needed.
Devices
The IMEI ordering service is compatible with nRF9161 production devices.
Nordic Semiconductor development devices (DKs, EKs, and Thingy devices) still have pre-programmed IMEIs.
Ordering IMEIs in the web app
This guide applies to Nordic Semiconductor devices that are not pre-programmed with an IMEI.
You can order IMEIs for production devices by specifying a box ID. For development devices, you can use a box ID or submit a request for up to 10 individual devices at a time, up to 100 per organization.
You can optionally include a model name for the end product containing a Nordic Semiconductor chip.
You cannot order IMEIs for the same box ID multiple times.
Make sure that the information you enter for a production allocation request is correct before you submit it. If the allocation request has an error, you cannot resubmit a request with the same box ID.
To order IMEIs:
-
In the web app, navigate to Admin → IMEIs.
-
Click Order IMEIs in the upper right corner of the page.
-
Select order type and provide the required information:
- By Box ID:
- Box ID
- Product
- Model (optional)
- By Count:
- Enter the number of IMEIs to order. The dialog shows your available quota.
- Product
- Model (optional)
- By Box ID:
-
Click Order.
-
Click an order's ID to open the result.
-
Copy and paste the ordered IMEIs, or download them as a CSV file.
Ordering IMEIs using the APIs
This section explains how to order IMEIs using the REST API.
Fetching information
The following endpoints return information about product names to which you can order IMEIs, as well as existing IMEI orders and requests:
- Use the
GetProductsendpoint to list products to which you can order IMEIs. - Use the
ListImeiAllocationsendpoint to list any previously ordered IMEIs, with optional filter parameters. - Use the
GetImeiAllocationendpoint to fetch details for a specific order entry.
Fetching usage and limits
Use the
GetLimits
endpoint to fetch details of order usage and limits.
Ordering IMEIs for production devices by box ID
Use the
AllocateImeis
endpoint to order IMEIs for production devices using a box ID.
Required parameters:
scope: Scope of the IMEI order, which isPRODUCTIONin this case.reelCode: A box ID that represents a batch of IMEI numbers.product: Name of the Nordic Semiconductor product.
You can also optionally include the model.
The server responds with HTTP status 200 and an IMEI report containing a list of the ordered IMEIs.
Ordering IMEIs for individual devices
Use the
AllocateImeis
endpoint to order IMEIs for individual devices. You can order up to 10
individual IMEIs per request, up to 100 per organization.
The endpoint is the same as for ordering by box ID, and the scope depends on
the parameters you specify (PRODUCTION, by box ID, or DEVELOPMENT, count).
Required parameters:
scope: Scope of the IMEI order, which isDEVELOPMENTin this case.countorreelCode: Number of IMEIs to order or box ID, depending on your use case.product: Name of the Nordic Semiconductor product.
You can optionally include the model.
The server responds with HTTP status 200 and an IMEI report containing a list of the ordered IMEIs.
Listing
This guide explains how to get a list of IMEIs using a box ID for modules with ready-programmed IMEIs and IMEIs ordered from nRF Cloud.
Using the web app
To get a list of IMEIs associated with a box ID:
-
In the web app, navigate to Admin → IMEIs.
-
Select List IMEIs.
The List IMEIs by Box ID dialog opens.
-
Enter a box ID in the text box.
-
Click Fetch.
nRF Cloud returns a list of IMEIs. You can download this list as a CSV file with Download CSV.
If you download and open a CSV file in a spreadsheet application, IMEI values might display by default in scientific notation.
Change the cell format to text to display the full value. This may vary depending on the application.
Using the APIs
Use the
ListImeisByReelCode
endpoint, including the box ID as a path parameter.
A successful request returns an HTTP 200 status and a list of IMEIs associated with the box ID in the response.
Managing models
This section explains how to manage product models using the web app or APIs.
The maximum model name length is 100 characters. The limit is 100 models per organization.
Using the web app
To add a new model:
- In the web app, navigate to Admin → IMEIs and click Order IMEIs.
- In the order dialog, use the Model field to add a new model.
- Enter a model name. The maximum model length is 100 characters.
The new model is available to select when ordering IMEIs.
You cannot edit a model once you have created it. Delete an existing model from the Model field's manage view.
Using the APIs
The following REST endpoints apply to model management:
- Use the
AddModelendpoint to create a new model. Max 100 characters for the model name and 100 models in each organization. - Use the
DeleteModelendpoint to delete an existing model. - Use the
ListModelsendpoint to list the previously created model names of your end products using a Nordic Semiconductor chip.