Device status management | emnify Documentation

ID	Description
8	SIM activation
9	SIM suspension
10	SIM deletion
42	Endpoint enabled
43	Endpoint disabled
45	SIM factory test
48	SIM registration
50	SIM Released
51	SIM Assigned
68	Reset connectivity
69	SIM migration

SIM activation

The SIM is patched to the Activated status after previously holding one of the following statuses: Issued, Suspended, or Factory Test.

You can manually trigger this event by using the emnify Portal or REST API. Or, it’s automatically triggered when the factory test mode threshold (data or SMS) is reached.

Activated SIMs can use network services.

Example JSON response: SIM status changed from Suspended to Activated

1 {
2     "timestamp": "2021-10-27T08:44:56.147Z",
3     "alert": false,
4     "description": "Status of SIM changed from 'Suspended' to 'Activated'",
5     "id": 2107485359,
6     "event_type": {
7         "id": 8,
8         "description": "SIM activation"
9     },
10     "event_source": {
11         "id": 2,
12         "description": "API"
13     },
14     "event_severity": {
15         "id": 0,
16         "description": "Info"
17     },
18     "organisation": {
19         "id": 624,
20         "name": "Test Org"
21     },
22     "endpoint": {
23         "id": 83173458,
24         "imei": "9953599921446542",
25         "ip_address": "174.249.170.160",
26         "name": "Factory Test Sim 2",
27         "tags": null
28     },
29     "sim": {
30         "iccid": "8242757752885188552",
31         "id": 3668977,
32         "production_date": "2020-12-23T13:02:11.000Z"
33     },
34     "imsi": {
35         "id": 323245909,
36         "import_date": "2020-12-23T13:02:11.000Z",
37         "imsi": "44137163473706"
38     }
39 }

Example JSON response: SIM activation after Factory Test volume reached

1 {
2     "timestamp": "2021-10-27T11:58:15.000Z",
3     "alert": false,
4     "description": "SIM activated after factory test volume reached.",
5     "id": 15235673491,
6     "event_type": {
7         "id": 8,
8         "description": "SIM activation"
9     },
10     "event_source": {
11         "id": 1,
12         "description": "Policy Control"
13     },
14     "event_severity": {
15         "id": 0,
16         "description": "Info"
17     },
18     "organisation": {
19         "id": 35216,
20         "name": "Test Org"
21     },
22     "endpoint": {
23         "id": 39654118,
24         "imei": "8516353639994804",
25         "ip_address": "174.238.2.179",
26         "name": "Factory Test Sim 2",
27         "tags": null
28     },
29     "sim": {
30         "iccid": "57486230661905310281",
31         "id": 598611,
32         "production_date": "2020-12-23T13:02:11.000Z"
33     },
34     "imsi": {
35         "id": 7790199,
36         "import_date": "2020-12-23T13:02:11.000Z",
37         "imsi": "984189013845491"
38     },
39     "detail": {
40         "transition": {
41             "sim": {
42                 "status": {
43                     "from": {
44                         "id": 4,
45                         "description": "FACTORY TEST"
46                     },
47                     "to": {
48                         "id": 1,
49                         "description": "ACTIVATED"
50                     }
51                 }
52             },
53             "reason": "SIM reached factory test volume."
54         }
55     }
56 }

SIM suspension

The SIM is patched to the Suspended status, temporarily suspending and blocking it from network access. Starting from the first day of the next month, the suspended SIM doesn’t accrue any charges.

Activating a SIM with the Suspended status again is possible at any time.

Example JSON response

1 {
2     "timestamp": "2021-10-27T08:44:46.267Z",
3     "alert": false,
4     "description": "Status of SIM changed from 'Activated' to 'Suspended'",
5     "id": 6664262361,
6     "event_type": {
7         "id": 9,
8         "description": "SIM suspension"
9     },
10     "event_source": {
11         "id": 2,
12         "description": "API"
13     },
14     "event_severity": {
15         "id": 0,
16         "description": "Info"
17     },
18     "organisation": {
19         "id": 4046,
20         "name": "Test Org"
21     },
22     "endpoint": {
23         "id": 1541102,
24         "imei": "3446623275770945",
25         "ip_address": "227.147.158.142",
26         "name": "Test Sim 2",
27         "tags": null
28     },
29     "sim": {
30         "iccid": "8930423315326577121",
31         "id": 209035,
32         "production_date": "2020-12-23T13:02:11.000Z"
33     },
34     "imsi": {
35         "id": 90246192,
36         "import_date": "2020-12-23T13:02:11.000Z",
37         "imsi": "116892797180278"
38     }
39 }

SIM deletion

The SIM is deleted and permanently removed from the SIM inventory.

Once deleted, the SIM cannot be restored for network access.

Endpoint enabled

Device is enabled.

Example JSON response

1 {
2     "timestamp": "2021-10-27T08:44:52.828Z",
3     "alert": false,
4     "description": "Status of Endpoint 96485463 changed to Enabled",
5     "id": 55793293648,
6     "event_type": {
7         "id": 42,
8         "description": "Endpoint enabled"
9     },
10     "event_source": {
11         "id": 2,
12         "description": "API"
13     },
14     "event_severity": {
15         "id": 0,
16         "description": "Info"
17     },
18     "organisation": {
19         "id": 6461,
20         "name": "Test Org"
21     },
22     "endpoint": {
23         "id": 96485463,
24         "imei": "1831095813329187",
25         "ip_address": "121.214.125.202",
26         "name": "Test Sim 2",
27         "tags": null
28     },
29     "sim": {
30         "iccid": "5363218780648553126",
31         "id": 9270816,
32         "production_date": "2020-12-23T13:02:11.000Z"
33     },
34     "imsi": {
35         "id": 96756141,
36         "import_date": "2020-12-23T13:02:11.000Z",
37         "imsi": "87393970592520"
38     }
39 }

Endpoint disabled

Device is disabled.

Example JSON response

1 {
2     "timestamp": "2021-10-27T08:44:49.585Z",
3     "alert": false,
4     "description": "Status of Endpoint 28778135 changed to Disabled",
5     "id": 19126170545,
6     "event_type": {
7         "id": 43,
8         "description": "Endpoint disabled"
9     },
10     "event_source": {
11         "id": 2,
12         "description": "API"
13     },
14     "event_severity": {
15         "id": 0,
16         "description": "Info"
17     },
18     "organisation": {
19         "id": 2448,
20         "name": "Test Org"
21     },
22     "endpoint": {
23         "id": 28778135,
24         "imei": "4042850244446350",
25         "ip_address": "183.104.130.246",
26         "name": "Test Sim 2",
27         "tags": null
28     },
29     "sim": {
30         "iccid": "5011996012476043533",
31         "id": 5492364,
32         "production_date": "2020-12-23T13:02:11.000Z"
33     },
34     "imsi": {
35         "id": 5508107,
36         "import_date": "2020-12-23T13:02:11.000Z",
37         "imsi": "741161647249343"
38     }
39 }

SIM factory test

SIM is patched from Issued to Factory Test status (for SIM testing).

Example JSON response

1 {
2     "timestamp": "2021-10-27T11:30:52.684Z",
3     "alert": false,
4     "description": "Status of SIM changed from 'Issued' to 'Factory Test'",
5     "id": 1955109934112,
6     "event_type": {
7         "id": 45,
8         "description": "SIM factory test"
9     },
10     "event_source": {
11         "id": 2,
12         "description": "API"
13     },
14     "event_severity": {
15         "id": 0,
16         "description": "Info"
17     },
18     "organisation": {
19         "id": 40163,
20         "name": "Test Org"
21     },
22     "endpoint": {
23         "id": 896737335,
24         "imei": "760116392707263",
25         "ip_address": "199.153.59.220",
26         "name": "Test Sim 2",
27         "tags": null
28     },
29     "sim": {
30         "iccid": "49176386291337319872",
31         "id": 703869,
32         "production_date": "2020-12-23T13:02:11.000Z"
33     },
34     "imsi": {
35         "id": 391022,
36         "import_date": "2020-12-23T13:02:11.000Z",
37         "imsi": "165974752113101"
38     }
39 }

SIM registration

SIM or SIM batch is registered to a Workspace via a Batch Identification Code (BIC).

This event doesn’t trigger when the emnify team assigns SIMs to a Workspace. It also doesn’t trigger for every SIM of a SIM batch, so the events log is only be visible on the individual SIM when registering single SIM batches.

Example JSON response

1 {
2   "timestamp": "2021-12-20T00:13:36.000Z",
3   "alert": false,
4   "description": "Batch of 1 SIM(s) registered.",
5   "id": 9539556207944,
6   "event_type": {
7     "id": 48,
8     "description": "SIM registration"
9   },
10   "event_source": {
11     "id": 2,
12     "description": "API"
13   },
14   "event_severity": {
15     "id": 0,
16     "description": "Info"
17   },
18   "organisation": {
19     "id": 3376,
20     "name": "Sample Corp"
21   },
22   "sim": {
23     "iccid": "68429007768008033558",
24     "id": 96112629,
25     "production_date": "2020-05-15T08:50:07.000Z"
26   },
27   "user": {
28     "id": 28757,
29     "name": "Sample User",
30     "username": "user@sample.com"
31   },
32   "detail": {
33     "sim_batch": {
34       "id": 57716,
35       "sim_model": {
36         "id": 9
37       },
38       "batch_size": 1,
39       "first_iccid": "68429007768008033558",
40       "last_iccid": "68429007768008033558"
41     }
42   }
43 }

SIM Released

SIM is released from a device.

Triggered through the emnify User Interface (EUI) or REST API.

Example JSON response

1 {
2   "timestamp": "2021-12-15T07:39:24.905Z",
3   "alert": false,
4   "description": "SIM 3423335 released from endpoint 5749159",
5   "id": 9511580614964,
6   "event_type": {
7     "id": 50,
8     "description": "SIM Released"
9   },
10   "event_source": {
11     "id": 2,
12     "description": "API"
13   },
14   "event_severity": {
15     "id": 0,
16     "description": "Info"
17   },
18   "organisation": {
19     "id": 316,
20     "name": "Test Org"
21   },
22   "endpoint": {
23     "id": 5749159,
24     "imei": "601262876950445",
25     "ip_address": "182.112.132.120",
26     "name": "Factory Test Sim 3",
27     "tags": null
28   },
29   "sim": {
30     "iccid": "4423772578905695775",
31     "id": 3423335,
32     "production_date": "2020-12-23T13:02:11.000Z"
33   },
34   "imsi": {
35     "id": 63513617,
36     "import_date": "2020-12-23T13:02:11.000Z",
37     "imsi": "616139522755995"
38   }
39 }

SIM Assigned

SIM is assigned to a device.

Triggered through the emnify User Interface (EUI) or while creating an endpoint using the emnify REST API.

Example JSON response

1 {
2   "timestamp": "2021-12-15T07:45:45.807Z",
3   "alert": false,
4   "description": "SIM 2972420 assigned to endpoint 38463269",
5   "id": 60798254506111,
6   "event_type": {
7     "id": 51,
8     "description": "SIM Assigned"
9   },
10   "event_source": {
11     "id": 2,
12     "description": "API"
13   },
14   "event_severity": {
15     "id": 0,
16     "description": "Info"
17   },
18   "organisation": {
19     "id": 89698,
20     "name": "Test Org"
21   },
22   "endpoint": {
23     "id": 38463269,
24     "imei": "821536534391790",
25     "ip_address": "100.102.41.214",
26     "name": "Factory Test Sim 3",
27     "tags": null
28   },
29   "sim": {
30     "iccid": "10314787648254377158",
31     "id": 2972420,
32     "production_date": "2020-12-23T13:02:11.000Z"
33   },
34   "imsi": {
35     "id": 5236562,
36     "import_date": "2020-12-23T13:02:11.000Z",
37     "imsi": "963687450685669"
38   },
39   "detail": {
40     "imei": "821536534391790"
41   }
42 }

Reset connectivity

An action to reset a device’s connectivity was triggered. Resetting device connectivity resets the network state and allows the device to freshly reattach.

For more details on the subsequent series of events, see Reset connectivity in Device troubleshooting.

Example JSON response in the origin Workspace

1 {
2   "timestamp": "2025-01-13T18:46:33.000Z",
3   "alert": false,
4   "description": "Endpoint connectivity reset triggered",
5   "id": 1799598796013575,
6   "event_type": {
7     "id": 68,
8     "description": "Reset connectivity"
9   },
10   "event_source": {
11     "id": 2,
12     "description": "API"
13   },
14   "event_severity": {
15     "id": 0,
16     "description": "Info"
17   },
18   "organisation": {
19     "id": 12345,
20     "name": "Example Organization"
21   },
22   "endpoint": {
23     "id": 123456789,
24     "imei": null,
25     "ip_address": "192.0.2.100",
26     "name": "GPS Tracker",
27     "tags": null
28   },
29   "sim": {
30     "iccid": "89883030000080139311",
31     "id": 12345,
32     "production_date": "2019-10-10T13:06:24.000Z"
33   },
34   "detail": {
35     "data": {}
36   }
37 }

SIM migration

One or more SIMs were transferred from a source Workspace to a target Workspace. This action generates two separate events:

A source event in the originating Workspace, indicating which SIMs were transferred and where they were moved.
A target event in the destination Workspace, confirming the receipt of the transferred SIMs.

Transfers may impact SIM status and billing, as described in the SIM transfer guide.

Example JSON response in the source Workspace

1 {
2   "timestamp": "2025-01-23T08:46:32.000Z",
3   "alert": false,
4   "description": "SIM(s) migrated from workspace 1 to workspace 2 by user sasha@example.com",
5   "id": 1234567890,
6   "event_type": {
7     "id": 69,
8     "description": "SIM migration"
9   },
10   "event_source": {
11     "id": 2,
12     "description": "API"
13   },
14   "event_severity": {
15     "id": 0,
16     "description": "Info"
17   },
18   "organisation": {
19     "id": 1,
20     "name": "Example Workspace 1"
21   },
22   "user": {
23     "id": 123,
24     "name": "Sasha Q",
25     "username": "sasha@example.com"
26   },
27   "detail": {
28     "target_workspace": {
29       "id": 2
30     },
31     "sims": [
32       {
33         "id": 12345,
34         "iccid": "8988303000008013931",
35         "iccid_with_luhn": "89883030000080139311",
36         "source_workspace": {
37           "id": 1,
38           "name": "Example Workspace 1"
39         }
40       },
41       {
42         "id": 67890,
43         "iccid": "8988303000008013931",
44         "iccid_with_luhn": "89883030000080139311",
45         "source_workspace": {
46           "id": 1,
47           "name": "Example Workspace 1"
48         }
49       }
50     ],
51     "type": "source"
52   }
53 }

Example JSON response in the target Workspace

1 {
2   "timestamp": "2025-01-23T08:46:33.000Z",
3   "alert": false,
4   "description": "SIM(s) migrated to workspace 2 by user sasha@example.com",
5   "id": 1234567890,
6   "event_type": {
7     "id": 69,
8     "description": "SIM migration"
9   },
10   "event_source": {
11     "id": 2,
12     "description": "API"
13   },
14   "event_severity": {
15     "id": 0,
16     "description": "Info"
17   },
18   "organisation": {
19     "id": 2,
20     "name": "Example Workspace 2"
21   },
22   "user": {
23     "id": 123,
24     "name": "Sasha Q",
25     "username": "sasha@example.com"
26   },
27   "detail": {
28     "target_workspace": {
29       "id": 2
30     },
31     "sims": [
32       {
33         "id": 12345,
34         "iccid": "8988303000008013931",
35         "iccid_with_luhn": "89883030000080139311",
36         "source_workspace": {
37           "id": 1,
38           "name": "Example Workspace 1"
39         }
40       },
41       {
42         "id": 67890,
43         "iccid": "8988303000008013931",
44         "iccid_with_luhn": "89883030000080139311",
45         "source_workspace": {
46           "id": 1,
47           "name": "Example Workspace 1"
48         }
49       }
50     ],
51     "type": "target"
52   }
53 }