Using our APIs

The IoT.live APIs allows customers and partners to integrate connectivity management capabilities directly into their own applications, portals, workflows, and operational systems.

Whether you're building customer self-service capabilities, automating device provisioning, or integrating connectivity management into an existing platform, the IoT.live APIs provides a secure and standards-based way to interact with your SIM estate.

The quickest way to get started is by using the published Swagger/OpenAPI documentation together with a tool such as Postman.

To access the IoT.live API you will need:

IoT.live APIs are REST-based and use standard HTTPS requests.

Typical API interactions consist of:

The Swagger documentation provides:

Open the published Swagger URL provided by your IoT.live administrator, or found here: https://iot.live/public/api/docs/index.html

Within Swagger you can:

We recommend reviewing the following SIM lifecycle operations first:

These provide a simple introduction to working with the platform.

Create a new Postman collection named:

IoT.live API Tests

Within the collection:

Add an Environment

Create the following variables:

Most API calls require an access token.

Create a request called:

Get Access Token

Use the authentication details provided by CSL.

Successful authentication will return an access token which can be stored as a Postman environment variable.

Example Authorisation header:

Before making any changes, verify connectivity using a read-only endpoint.

For example:

Get SIM Details

Expected outcome:

Typical information may include:

If this request succeeds, your authentication and connectivity are working correctly.

Once basic connectivity has been verified, test a lifecycle operation.

Suspend SIM

Purpose:

Temporarily prevent the SIM from using network services while retaining the subscription.

Example request:

Headers:

Example response:

After a successful suspension request:

This validation step is important when building automations.

Example workflow:

Suspend SIM

↓

Wait for response

↓

Get SIM Details

↓

Confirm status = SUSPENDED

To restore service, call the Unsuspend endpoint.

Unsuspend SIM

Expected response:

When building production integrations:

Begin with:

These APIs provide a simple end-to-end workflow that covers:

Once basic functionality is working, consider:

✅ Use a dedicated test SIM during development

✅ Store API credentials securely

✅ Validate API responses before updating internal systems

✅ Log request IDs and response codes

✅ Implement retries for transient failures

✅ Use sandbox or test environments where available

❌ Do not hardcode access tokens

❌ Do not expose credentials in client-side applications

❌ Do not assume lifecycle changes are instantaneous

Check:

Verify:

Check:

Once you have successfully suspended and unsuspended a SIM using Postman, you are ready to integrate IoT.live APIs into your own applications and workflows. The Swagger/OpenAPI documentation can be used to generate client SDKs, accelerate development, and explore additional capabilities across SIM lifecycle management, diagnostics, usage monitoring, and connectivity operations.