canonical: https://jentic.com/apis/portal.1nce.com/1nce

# Portal 1nce 1NCE API

Jentic publishes the only available OpenAPI specification for 1NCE API, keeping it validated and agent-ready. The 1NCE API provides programmatic management of IoT SIM cards, connectivity, and data quotas for large-scale IoT deployments. It covers SIM lifecycle operations including activation, deactivation, top-ups, SMS handling, and real-time connectivity diagnostics across 25 endpoints. The API also supports order management, product catalog access, and customer support ticket creation for 1NCE's flat-rate IoT connectivity platform.

## For AI agents

Manage IoT SIM cards, monitor connectivity status, handle data quotas, and send SMS to devices. Supports bulk SIM operations and real-time diagnostics across 25 endpoints.

## Scope

Does not handle device firmware updates, edge computing, or data analytics dashboards - use for SIM lifecycle management and connectivity monitoring only.

## Capabilities

- Activate, deactivate, and transfer IoT SIM cards across customer accounts
- Monitor real-time connectivity status and location for individual SIMs
- Top up data volume quotas for single SIMs or in bulk
- Send and retrieve SMS messages to and from IoT devices
- Track daily data usage and quota consumption per SIM
- Place and manage orders for new SIM cards and products
- Create and track customer support service requests

## Use cases

### IoT Fleet Connectivity Monitoring

Monitor the connectivity status, network events, and location of IoT SIM cards across a deployed device fleet. The 1NCE API returns real-time connectivity information per ICCID, including operator attachment, session state, and last-seen location. Operations teams managing hundreds or thousands of IoT devices use this to detect offline units and diagnose network issues without logging into the 1NCE portal individually.

Example prompt: Retrieve connectivity_info for SIM with ICCID 8949000000000001 and report whether it is currently attached to the network

### Automated Data Quota Top-Up

Automatically top up data volume for IoT SIMs approaching their quota limit. The 1NCE API supports both individual SIM top-ups via ICCID and bulk top-up operations for multiple SIMs simultaneously. Businesses running metered IoT services configure auto-top-up rules or trigger top-ups programmatically when usage thresholds are crossed, preventing device disconnection.

Example prompt: Check the data quota for SIM 8949000000000001 via /v1/sims/{iccid}/quota/data and trigger a top-up if remaining volume is below 10MB

### Device SMS Communication

Send configuration commands or receive status messages from IoT devices via SMS through the 1NCE platform. The API allows sending SMS to any managed SIM by ICCID and retrieving message history including delivery status. This is used for remote device configuration, firmware trigger messages, and receiving sensor alerts from devices that communicate via SMS rather than IP data.

Example prompt: Send an SMS with body 'REBOOT' to SIM 8949000000000001 and confirm delivery status

### AI Agent IoT Fleet Management via Jentic

AI agents use the 1NCE API through Jentic to automate IoT fleet management tasks - checking device connectivity, topping up quotas, and sending commands - without handling OAuth2 credentials directly. Jentic's intent search maps natural-language queries like 'check SIM status' to the correct endpoint and parameter schema, enabling agents to manage IoT infrastructure programmatically.

Example prompt: Search Jentic for '1NCE SIM connectivity status', load the operation schema, and execute a GET request to retrieve status for ICCID 8949000000000001

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /v1/sims | List all SIM cards with status and metadata |
| GET | /v1/sims/{iccid} | Get detailed status for a specific SIM |
| PUT | /v1/sims/{iccid} | Activate, deactivate, or modify a SIM card |
| POST | /v1/sims/{iccid}/topup | Top up data volume for a SIM |
| GET | /v1/sims/{iccid}/connectivity_info | Retrieve connectivity and location info |
| POST | /v1/sims/{iccid}/sms | Send an SMS to a SIM card |
| GET | /v1/sims/{iccid}/usage | Get daily data usage for a SIM |
| POST | /v1/orders | Place a new SIM card order |

## Key resources

- **SIMs** — Lifecycle management, status, connectivity info, quotas, and diagnostics for IoT SIM cards
- **Orders** — Place and track orders for new SIM cards and products
- **Products** — Browse available 1NCE product catalog
- **SMS** — Send, receive, and track SMS messages to/from IoT devices
- **Support** — Create and manage customer support service requests

## Why Jentic

- **Setup:** Wiring the 1NCE API by hand means running its OAuth2 client-credentials flow, exchanging the client secret for a token, and refreshing it yourself. Through Jentic you install once, import the 1NCE API from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** 1NCE puts the SIM's ICCID in the URL path (/v1/sims/{iccid}/...), so a rule can pin your agent to one SIM: you choose the operations it may call, so actions like top-up, SMS sending, or SIM updates are not included unless you add them.
- **Credential handling:** Your 1NCE client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'check SIM connectivity status' or 'get SIM usage', and Jentic returns the matching 1NCE operation with its input schema including the ICCID so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **EMnify API** — Enterprise IoT connectivity platform with global SIM management
- **Particle API** — IoT device cloud with firmware management and event streaming
- **Golioth API** — IoT device management platform for firmware and data routing

## FAQ

### Why is there no official OpenAPI spec for 1NCE API?

1NCE does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call 1NCE API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the 1NCE API use?

The 1NCE API uses OAuth2 authentication. Through Jentic, your OAuth2 client credentials are stored encrypted in the vault and token refresh is handled automatically - agents never see raw client secrets or manage token expiry.

### Can I send SMS to IoT devices with the 1NCE API?

Yes. POST to /v1/sims/{iccid}/sms with a message body to send SMS to any managed SIM. You can also retrieve sent and received messages via GET on the same path and check delivery status for individual messages at /v1/sims/{iccid}/sms/{id}.

### What are the rate limits for the 1NCE API?

The OpenAPI spec does not specify explicit rate limits. 1NCE applies per-account throttling based on your subscription tier. Bulk SIM operations (activation, top-up) are handled via batch endpoints rather than individual calls to stay within limits.

### How do I check a SIM card's data usage through Jentic?

Install with pip install jentic, then search for 'get SIM daily usage'. Jentic returns the GET /v1/sims/{iccid}/usage operation with its parameter schema. Execute with the target ICCID to receive daily usage breakdown.

### Can I perform bulk SIM operations with the 1NCE API?

Yes. POST to /v1/sims accepts an array of SIM identifiers for bulk activate, deactivate, label changes, and IMEI lock operations. The /v1/sims/topup endpoint handles bulk data top-ups, and /v1/sims/autoTopup configures automatic top-up rules for multiple SIMs.

### How do I monitor whether an IoT device is connected?

GET /v1/sims/{iccid}/connectivity_info returns real-time network attachment status, operator information, and last-known location for a SIM. For historical diagnostics, GET /v1/sims/{iccid}/events provides a timeline of network events including attach, detach, and data session starts.

### Can I limit what my agent is allowed to do with the 1NCE API?

Yes. Jentic One is self-hosted, so you run it and your own rules decide which 1NCE operations the agent may call and which credentials it may use. Because 1NCE puts the SIM's ICCID in the URL path, such as /v1/sims/{iccid}/connectivity_info and /v1/sims/{iccid}/usage, you can pin the agent to a single SIM and grant it only read operations like connectivity checks and usage lookups. State-changing actions such as top-ups at /v1/sims/{iccid}/topup, SMS sending at /v1/sims/{iccid}/sms, or SIM activation via PUT /v1/sims/{iccid} stay off limits unless you explicitly allow them.
