Soracom

Soracom Subscriber API

[Soracom Air for Cellular](/en/docs/air/) SIM information, operations, and cancellation

GitHub OpenAPI
Business capability
Subscriber Identity Management BC-2640.10

Operations 31

GET /subscribers List Subscribers #
GET /subscribers/{imsi} Get Subscriber #
POST /subscribers/{imsi}/activate Activate Subscriber #
PUT /subscribers/{imsi}/bundles Set Bundles to Subscriber #
GET /subscribers/{imsi}/data Get data sent from a subscriber to Harvest Data #
POST /subscribers/{imsi}/deactivate Deactivate Subscriber #
POST /subscribers/{imsi}/delete_session Delete Session #
POST /subscribers/{imsi}/disable_termination Disable Termination of Subscriber #
POST /subscribers/{imsi}/downlink/ping Send ping requests to a subscriber #
POST /subscribers/{imsi}/enable_termination Enable Termination of Subscriber #
GET /subscribers/{imsi}/events/sessions List Session Events #
POST /subscribers/{imsi}/register Register Subscriber #
POST /subscribers/{imsi}/report_local_info Triggers Subscriber to report SIM local info #
POST /subscribers/{imsi}/send_sms Send SMS to Subscriber #
POST /subscribers/{imsi}/set_expiry_time Update Expiry Time of Subscriber #
POST /subscribers/{imsi}/set_group Adds a SIM to a SIM group #
POST /subscribers/{imsi}/set_imei_lock Set IMEI lock configuration for Subscriber #
POST /subscribers/{imsi}/set_to_standby Set Subscriber to standby mode #
POST /subscribers/{imsi}/suspend Suspend Subscriber #
PUT /subscribers/{imsi}/tags Bulk Insert or Update Subscriber Tags #
DELETE /subscribers/{imsi}/tags/{tag_name} Delete Subscriber Tag #
POST /subscribers/{imsi}/terminate Terminate Subscriber #
POST /subscribers/{imsi}/unset_expiry_time Delete Expiry Time of Subscriber #
POST /subscribers/{imsi}/unset_group Removes a SIM from a SIM group #
POST /subscribers/{imsi}/unset_imei_lock Unset IMEI lock configuration for Subscriber #
POST /subscribers/{imsi}/update_speed_class Update Subscriber speed class #
POST /subscribers/export Export all subscribers #
POST /subscribers/msisdn/{msisdn}/send_sms Send SMS to Subscriber by MSISDN #
DELETE /subscribers/transfer_token/{token} Cancel the transfer of Ready status SIMs (Invalidate the transfer token) #
POST /subscribers/transfer_token/issue Initiate the transfer of Ready status SIMs (Issue a transfer token) #
POST /subscribers/transfer_token/verify Accept the transfer of Ready status SIMs (Verify the transfer token) #

Documentation

📖
Documentation
https://developers.soracom.io/en/docs/harvest/
📖
Documentation
https://developers.soracom.io/en/docs/inventory/
📖
Documentation
https://developers.soracom.io/en/docs/napter/
📖
Documentation
https://developers.soracom.io/en/docs/event-handler/
📖
Documentation
https://developers.soracom.io/en/docs/vpg/
📖
Documentation
https://developers.soracom.io/en/docs/query/
📖
Documentation
https://developers.soracom.io/en/docs/air-for-lorawan/
📖
Documentation
https://developers.soracom.io/en/docs/air-for-sigfox/
📖
Documentation
https://users.soracom.io/ja-jp/tools/api/reference/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/openapi/soracom-subscriber-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-schema/soracom-data-entry-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-schema/soracom-device-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-structure/soracom-device-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-schema/soracom-port-mapping-schema.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/examples/soracom-harvest-data-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/examples/soracom-napter-create-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-ld/soracom-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/soracom-subscriber-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

soracom-subscriber-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Soracom API v1
  title: Soracom Subscriber API
  version: 20250903-043502
servers:
- description: Japan coverage production API endpoint
  url: https://api.soracom.io/v1
- description: Global coverage production API endpoint
  url: https://g.api.soracom.io/v1
tags:


# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/openapi/soracom-subscriber-api-openapi.yml