API Reference

Create a SIM

post
https://api.edgeiq.io/api/v1/platform/sims

Creates a new SIM record and links it to the specified device. The device_id and iccid fields are required. The SIM inherits its company_id from the linked device's company, so the calling user must have create permissions for that company. A given ICCID must be globally unique across the platform.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating or updating a SIM. Maps directly to the backend's SimInput struct. Read-only server-managed fields (ctd_data_usage, ctd_sms_usage, included_usage, overage_limit_reached, sim_barred, last_sync_at, and audit fields) are not accepted and will be ignored if present.

string
required

The ID of the device this SIM is linked to. Required on creation.

string

The ID of the MNO integration used to sync this SIM with a carrier connectivity management platform (CMP).

string
required
length between 18 and 22

Integrated Circuit Card Identifier. Must be 18-22 digits (ITU-T E.118). Globally unique across the platform. Required on creation.

string
length ≤ 20

Mobile Subscriber ISDN Number (the SIM's phone number). Maximum 20 characters.

string
length ≤ 30

SIM lifecycle status. This is an open string set by the carrier/Service Provider (CMP) sync and is NOT restricted to a fixed enum — any carrier status string is valid. Maximum 30 characters. Common values: inactive, active, suspended, deactivated, retired. Defaults to 'inactive' when omitted on creation.

string
length ≤ 255

Carrier communication plan name. Maximum 255 characters.

string
length ≤ 255

Carrier rate plan name. Maximum 255 characters.

sim_metadata
object

Extensible JSON object for carrier-specific fields. Values may be nested objects or numeric types. Maximum 50 top-level keys.

Responses

400

The request was malformed or contained invalid parameters.

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Updated 1 day ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago