Products
Developers
API Reference
Contact Us

NetworkAccessProfile Network Subresource

Control which cellular networks are allowed by your Network Access Profile

Each Network Access Profile (NAP) resource has a Networks subresource (NAP Networks) that contains a list of allowed cellular networks Super SIMs can connect to.

https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{Sid}/Networks

The NAP Network resources in this subresource are a subset of all of the Network resources available from the Networks resource. You can add or remove NAP Network resources from the NAP Networks subresource at any time to change which cellular networks Super SIMs using the parent Network Access Profile resource can connect to.

The sid used to add, remove, or identify NAP Network resources is the same as the sid of the corresponding Network resource. You can filter the NAP Networks subresource the same way you can the Networks resource.

NetworkAccessProfile Network properties

A Network Access Profile Network resource (NAP Network) has the same representation and values as the corresponding available Network resource with the exception of the additional NetworkAccessProfileSid property that identifies the Network Access Profile the subresource belongs to.

Managing Access to Networks

Allowing Access to a Network

To allow Super SIMs to connect to a cellular network represented by a Network resource, a NAP Network resource must be created. Use the sid of the Network resource you with to add in your create request to add the NAP Networks subresource.

For example, if you wish to allow Super SIMs to connect to AT&T US you would follow these steps:

  1. First, you need to know the sid of the Network resource that represents AT&T US. You could do that by reading through the list of Network resources or if you know the MCC and MNC identifiers (310 and 410, respectively for AT&T US), you can read Networks resource by MCC and MNC. You will find that the sid of the Network resource representing AT&T US is HWd85b0262d6fc4c0b991bf8294596642e.

  2. Now that you know the sid of the Network resource you wish to add, you can allow your Super SIMs to that use your NAP by creating NAP Network resource with AT&T US' sid. See the documentation below for more details on how to do this.

Removing Access to a Network

To prevent Super SIMs from connecting to a cellular network that was previously allowed by your NAP, the corresponding NAP Network resource must be deleted. See the documentation below for more details on how to do this.

Remember that the networks listed in your NAP Networks list act as an allow list. Your SIMs will be blocked from connecting to any networks not present in the list. Adding networks to the list gives permission to connect to it. Removing networks from the list blocks them again.

API Authorization

Before you can make requests to this resource, you must have a valid bearer token. Review our API authorization guide to learn how to generate a token. Here's a curl example on how to define your access token in a header:

curl -X GET \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
'https://supersim.api.korewireless.com/v1/Sims'

The examples below do not show the required Authorization header due to a bug. We're working on fixing that. In the meantime, be sure to include that in all of your requests.

Create a NetworkAccessProfile Network Resource

Add a Network resource to the Network Access Profile resource.

POSThttps://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks
Authorization
Path parameters
NetworkAccessProfileSid*string

The unique string that identifies the Network Access Profile resource.

Body
Network*string

The SID of the Network resource to be added to the Network Access Profile resource.

Pattern: ^HW[0-9a-fA-F]{32}$
Response

Created

Headers
Body
sidnullable string

The unique string that identifies the Network resource.

Pattern: ^HW[0-9a-fA-F]{32}$
network_access_profile_sidnullable string

The unique string that identifies the Network resource's Network Access Profile resource.

Pattern: ^HA[0-9a-fA-F]{32}$
friendly_namenullable string

A human readable identifier of the Network this resource refers to.

iso_countrynullable string

The ISO country code of the Network resource.

identifiersnullable array of any

Array of objects identifying the MCC-MNCs that are included in the Network resource.

urlnullable string (uri)

The absolute URL of the Network resource.

Request
const response = await fetch('https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "Network": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }),
});
const data = await response.json();
Response
{
  "sid": "text",
  "network_access_profile_sid": "text",
  "friendly_name": "text",
  "iso_country": "text",
  "identifiers": [],
  "url": "https://example.com"
}

Fetch a NetworkAccessProfile Network resource

Fetch a Network Access Profile resource's Network resource.

GEThttps://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}
Authorization
Path parameters
NetworkAccessProfileSid*string

The unique string that identifies the Network Access Profile resource.

Sid*string

The SID of the Network resource to fetch.

Pattern: ^HW[0-9a-fA-F]{32}$
Response

OK

Headers
Body
sidnullable string

The unique string that identifies the Network resource.

Pattern: ^HW[0-9a-fA-F]{32}$
network_access_profile_sidnullable string

The unique string that identifies the Network resource's Network Access Profile resource.

Pattern: ^HA[0-9a-fA-F]{32}$
friendly_namenullable string

A human readable identifier of the Network this resource refers to.

iso_countrynullable string

The ISO country code of the Network resource.

identifiersnullable array of any

Array of objects identifying the MCC-MNCs that are included in the Network resource.

urlnullable string (uri)

The absolute URL of the Network resource.

Request
const response = await fetch('https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "sid": "text",
  "network_access_profile_sid": "text",
  "friendly_name": "text",
  "iso_country": "text",
  "identifiers": [],
  "url": "https://example.com"
}

Read multiple NetworkAccessProfile Network resources

Retrieve a list of Network Access Profile resource's Network resource.

GEThttps://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks
Authorization
Path parameters
NetworkAccessProfileSid*string

The unique string that identifies the Network Access Profile resource.

Query parameters
Response

OK

Headers
Body
networksarray of supersim.v1.network_access_profile.network_access_profile_network (object)
metaobject
Request
const response = await fetch('https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "networks": [
    {
      "sid": "text",
      "network_access_profile_sid": "text",
      "friendly_name": "text",
      "iso_country": "text",
      "identifiers": [],
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "text",
    "next_page_url": "https://example.com",
    "page": 0,
    "page_size": 0,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}

Delete a NetworkAccessProfile Network resource

Remove a Network resource from the Network Access Profile resource's.

DELETEhttps://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}
Authorization
Path parameters
NetworkAccessProfileSid*string

The unique string that identifies the Network Access Profile resource.

Pattern: ^HA[0-9a-fA-F]{32}$
Sid*string

The SID of the Network resource to be removed from the Network Access Profile resource.

Pattern: ^HW[0-9a-fA-F]{32}$
Response

The resource was deleted successfully.

Request
const response = await fetch('https://supersim.api.korewireless.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

PreviousNetworkAccessProfile ResourceNextNetwork Resource

Last updated