SIMs

The API provides services to retrieve the collection of SIMs with paging, filtering, and sorting options. It also provides services for single SIM retrieval and CRUD operations via POST, PATCH, and DELETE actions.

Below is a sample SIM in JSON representation. Apart from its own data, the object contains an embedded endpoint object.

{
  "id": 788, 
  "iccid": "8988303000008013931",
  "iccid_with_luhn": "89883030000080139311",
  "eid": "89049011803455664400046832584675",
  "production_date": "2014-08-01T08:47:00+0000",
  "activation_date": "2014-08-21T18:17:00+0000",
  "status": { 
    "id": 1,
    "description": "Activated"
  },
  "customer_org": {
    "id": 13,
    "name": "Enterprise",
    "country": { 
      "id": 205,
      "name": "United Kingdom"
    }
  },
  "issuer_org": {
    "id": 11,
    "name": "MNO",
    "country": {
      "id": 205,
      "name": "United Kingdom" 
    }
  },
  "reseller_org": null,
  "endpoint": {
    "id": 1,
    "name": "arduino01",
    "imei": "864345678889321",
    "created": "2015-03-19T08:45:41.000+0000",
    "last_updated": "2015-03-19T08:45:41.000+0000",
    "organisation_id": 5,
    "service_profile_id": 1,
    "tariff_profile_id": 1,
    "tags": "arduino, meter, temp",
    "ip_address": "10.1.1.9",
    "ip_address_space_id": 1
  },
  "imsi": "123451234567890",
  "msisdn": "88563748761",
  "model": {
    "id": 1,
    "description": "Java smartcard", 
    "memory_size": 64,
    "formfactor": { 
      "id": 1,
      "name": "2FF",
    },
    "manufacturer": { 
      "id": 1,
      "name": "Motorola"
    }
  }
}

SIM Object

Here is the description of SIM object:

Property Type Description
id Number Unique identifier of this SIM
iccid String Integrated circuit card identifier without the final Luhn checksum digit
iccid_with_luhn String Integrated circuit card identifier including the final Luhn checksum digit
eid String Unique global serial number for an eUICC if applicable
production_date Timestamp | null Date/time when this SIM was created
Type: ISO 8601 timestamp format
activation_date Timestamp | null Date/time when this SIM was activated for the first time
Type: ISO 8601 timestamp format
status Object Information about the SIM status (see Status Object)
customer_org Object Details about the organization the SIM is issued to (see Customer Organization Object)
issuer_org Object Details about the organization that issued the SIM (see Issuer Organization Object)
reseller_org Object | null Details about the organization that resold the SIM (see Reseller Organization Object)
endpoint Object | null Details about the endpoint the SIM is assigned to (see Endpoint Object)
imsi String | null IMSI number of the SIM
msisdn String | null MSISDN number of the SIM
model Object | null Details about the SIM model (see Model Object)

SIM Status Object

Property Type Description
id Number Status ID for this SIM
description String Description of the SIM status

SIM Statuses

ID Description
0 Issued
1 Activated
2 Suspended
3 Deleted
4 Factory Test

Customer Organization Object

Property Type Description
id Number Unique identifier of the organization
name String Name of the organization
country Object Country of the organization (see Country Object)

Issuer Organization Object

Property Type Description
id Number Unique identifier of the organization
name String Name of the organization
country Object Country of the organization (see Country Object)

Reseller Organization Object

Property Type Description
id Number Unique identifier of the organization
name String Name of the organization
country Object Country of the organization (see Country Object)

Country Object

Property Type Description
id Integer Unique identifier of the country
name String Name of country

Endpoint Object

This data is embedded from a subset of the Endpoint.

Property Type Description
id Integer Unique identifier of the endpoint
name String Name of endpoint
imei String | null International mobile equipment identity
created Timestamp Date/time when this endpoint was created
Type: ISO 8601 timestamp format
last_updated Timestamp Date/time when this endpoint was last updated
Type: ISO 8601 timestamp format
organisation_id Integer Unique identifier of the organization assigned to the endpoint
service_profile_id Integer | null Unique identifier of the assigned service profile
tariff_profile_id Integer | null Unique identifier of the assigned tariff profile
tags String | null Any tags assigned to this endpoint with each value separated by a comma (e.g., "arduino, meter, temp")
ip_address String Configured IP address
ip_address_space_id Integer Unique identifier of the assigned IP address space

Model Object

Property Type Description
id Integer Unique identifier of the SIM model
description String Description of the SIM model
memory_size Integer Memory size in KB
formfactor Object Details about the SIM form factor (see Form Factor Object)
manufacturer Object Manufacturer of the SIM (see Manufacturer Object)

Form Factor Object

Property Type Description
id Integer Form factor ID for this SIM
name String Description of the form factor

Manufacturer Object

Property Type Description
id Integer Unique identifier of the manufacturer
name String Name of the manufacturer