How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Soracom

Soracom Subscriber API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Soracom Subscriber API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Subscriber. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 31 operations across 31 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 20250903-043502.

Requests are made against 2 base URLs: https://api.soracom.io/v1, https://g.api.soracom.io/v1.

31 operations 31 paths 26 schemas 2 DELETE4 GET23 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250903-043502
Base URL
https://api.soracom.io/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Soracom Subscriber API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Soracom-API-Key (api_key). An API key is passed in the header as X-Soracom-Token (api_token).

  • api_key — API key for authentication. Obtain this from the Soracom User Console or via the Auth API. Required in combination with an API token for all authenticated requ…
  • api_token — API token for authentication. This token has an expiration time and must be refreshed periodically. Required in combination with an API key for all authenticat…

Paths & Operations 31

Across 31 paths, the API surfaces 31 operations — 2 DELETE, 4 GET, 23 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriber 31

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

GET
/subscribers
List Subscribers.
listSubscribers 8 params → 200
GET
/subscribers/{imsi}
Get Subscriber.
getSubscriber 1 param → 200404
POST
/subscribers/{imsi}/activate
Activate Subscriber.
activateSubscriber 1 param → 200404
PUT
/subscribers/{imsi}/bundles
Set Bundles to Subscriber.
putBundles 1 param body → 200400404
GET
/subscribers/{imsi}/data
Get data sent from a subscriber to Harvest Data.
getDataFromSubscriber 6 params → 200
POST
/subscribers/{imsi}/deactivate
Deactivate Subscriber.
deactivateSubscriber 1 param → 200404
POST
/subscribers/{imsi}/delete_session
Delete Session
deleteSubscriberSession 1 param → 200404
POST
/subscribers/{imsi}/disable_termination
Disable Termination of Subscriber.
disableTermination 1 param → 200404
POST
/subscribers/{imsi}/downlink/ping
Send ping requests to a subscriber.
subscriberDownlinkPingToUserEquipment 1 param body → 200
POST
/subscribers/{imsi}/enable_termination
Enable Termination of Subscriber.
enableTermination 1 param → 200404
GET
/subscribers/{imsi}/events/sessions
List Session Events.
listSessionEvents 5 params → 200
POST
/subscribers/{imsi}/register
Register Subscriber.
registerSubscriber 1 param body → 201
POST
/subscribers/{imsi}/report_local_info
Triggers Subscriber to report SIM local info.
reportLocalInfo 1 param → 202400404
POST
/subscribers/{imsi}/send_sms
Send SMS to Subscriber
sendSms 1 param body → 202400404
POST
/subscribers/{imsi}/set_expiry_time
Update Expiry Time of Subscriber.
setExpiryTime 1 param body → 200404
POST
/subscribers/{imsi}/set_group
Adds a SIM to a SIM group
setGroup 1 param body → 200404
POST
/subscribers/{imsi}/set_imei_lock
Set IMEI lock configuration for Subscriber.
setImeiLock 1 param body → 200400404
POST
/subscribers/{imsi}/set_to_standby
Set Subscriber to standby mode.
setSubscriberToStandby 1 param → 200400404
POST
/subscribers/{imsi}/suspend
Suspend Subscriber.
suspendSubscriber 1 param → 200404
PUT
/subscribers/{imsi}/tags
Bulk Insert or Update Subscriber Tags.
putSubscriberTags 1 param body → 200404
DELETE
/subscribers/{imsi}/tags/{tag_name}
Delete Subscriber Tag.
deleteSubscriberTag 2 params → 204404
POST
/subscribers/{imsi}/terminate
Terminate Subscriber.
terminateSubscriber 1 param → 200404
POST
/subscribers/{imsi}/unset_expiry_time
Delete Expiry Time of Subscriber.
unsetExpiryTime 1 param → 204404
POST
/subscribers/{imsi}/unset_group
Removes a SIM from a SIM group
unsetGroup 1 param → 200404
POST
/subscribers/{imsi}/unset_imei_lock
Unset IMEI lock configuration for Subscriber.
unsetImeiLock 1 param → 200404
POST
/subscribers/{imsi}/update_speed_class
Update Subscriber speed class.
updateSpeedClass 1 param body → 200404
POST
/subscribers/export
Export all subscribers.
exportSubscribers 1 param → 200
POST
/subscribers/msisdn/{msisdn}/send_sms
Send SMS to Subscriber by MSISDN
sendSmsByMsisdn 1 param body → 202400404
DELETE
/subscribers/transfer_token/{token}
Cancel the transfer of Ready status SIMs (Invalidate the transfer token)
deleteSubscriberTransferToken 1 param → 204404
POST
/subscribers/transfer_token/issue
Initiate the transfer of Ready status SIMs (Issue a transfer token)
issueSubscriberTransferToken body → 200
POST
/subscribers/transfer_token/verify
Accept the transfer of Ready status SIMs (Verify the transfer token)
verifySubscriberTransferToken body → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Subscriber (33 properties), SessionEvent (17 properties), SessionStatus (14 properties), PreviousSessionStatus (12 properties). Each schema is shown below with its type and property counts.

TagUpdateRequest
object
2 properties 2 required
Placement
object
2 properties
IssueSubscriberTransferTokenRequest
object
3 properties 3 required
TagSet
object
An object which always contains at least one property "name" with a string value. If you give a subscriber/SIM a name, the name will be returned as the value o…
SetGroupRequest
object
1 property
RegisterSubscribersRequest
object
3 properties 1 required
ImeiLock
object
IMEI lock configuration.
1 property
IssueSubscriberTransferTokenResponse
object
1 property 1 required
VerifySubscriberTransferTokenResponse
object
1 property 1 required
LocationRegistrationStatusForNetwork
object
2 properties
DownlinkPingRequest
object
2 properties
SetImeiLockRequest
object
1 property
FileExportResponse
object
3 properties
DownlinkPingResponse
object
3 properties
UpdateSpeedClassRequest
object
1 property 1 required
DataEntry
object
6 properties
PreviousSessionStatus
object
Information about the previous session.
12 properties
LocationRegistrationStatus
object
3 properties
ExpiryTime
object
2 properties 1 required
Subscriber
object
33 properties
SmsForwardingRequest
object
2 properties
Cell
object
Information about the base station to which the IoT SIM is connected. It will not be output for virtual SIM/subscribers.
9 properties
SessionEvent
object
17 properties
SmsForwardingReport
object
1 property
VerifySubscriberTransferTokenRequest
object
1 property 1 required
SessionStatus
object
Information about the current session.
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-subscriber-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
AE Profile APIs.io
Soracom Group Configuration API
AE Profile APIs.io
Soracom Billing API
AE Profile APIs.io
Soracom Stats and Diagnostics API
AE Profile APIs.io
Soracom Auth and Access Management API
AE Profile APIs.io
Soracom Lagoon API
AE Profile APIs.io
Soracom Cloud Camera Services API
AE Profile APIs.io
Soracom Batch API
AE Profile APIs.io
Soracom Analysis API
AE Profile APIs.io
Soracom API Sandbox: Coupon API
AE Profile APIs.io
Soracom API Sandbox: Operator API
AE Profile APIs.io
Soracom API Sandbox: Order API
AE Profile APIs.io
#Subscriber
← Back to S APIs
API Details
ID
soracom:soracom-subscriber-api
Base URL
https://api.soracom.io/v1
Docs
https://users.soracom.io/ja-jp/tools/api/reference/#/Sim
Provider
Soracom
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=soracom-subscriber-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/soracom-subscriber-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Soracom Subscriber API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.