ONSIM Dev Portal

ONSIM API

Endpoint:https://api.onsimapp.com

Account - Cease Account

DELETE

https://api.onsimapp.com

/account

Cease Account. WARNING:: Please use with caution this will irrevocably cease the SIM and Account - it can not be reversed

Account - Cease Account › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Cease Account › Request Body

iccidstring · required
SIM ICCID
Example: 8944530000000012345

Account - Cease Account › Responses

Account Successfully Ceased

No data returned

DELETE /account

curl --request DELETE \
  --url https://api.onsimapp.com/account \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "iccid": "8944530000000012345"
}
'

shell

Show example in

Request Body Example

{
  "iccid": "8944530000000012345"
}

json

Example Responses

No example

plain

Account - Get Info

GET

https://api.onsimapp.com

/account/{mpn}

Get account information, services and bundle

Account - Get Info › path Parameters

mpnstring · required
mpn of account you want to retrieve info for

Account - Get Info › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Get Info › Responses

Info of Account

accountobject[]
Info Regarding the Account
Example: {"sim":"8944000000000123456","i_account":"123456","mpn":"447777777777","sip_address":"sipaddress","services":{"mobile_data":"ON","mobile_hotspot":"OFF","mobile_messaging":"ON","mobile_voice":"ON"},"bundles":{"data":{"bundle_name":"10GB","allowance":10240,"used":240,"remaining":10000,"unit":"megabyte","period_from":"2024-01-01 00:00:00","period_to":"2024-02-01 00:00:00"}}}

GET /account/{mpn}

curl --request GET \
  --url https://api.onsimapp.com/account/:mpn \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Account - Update Bundle

POST

https://api.onsimapp.com

/account/{mpn}/bundle/{bundle}

Use this method to update the bundle associated to the Account use either BASE (no data) or UNLIMITED (data)

Account - Update Bundle › path Parameters

mpnstring · required
mpn of account you want to update
bundlestring · required
Bundle SKU

Account - Update Bundle › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Update Bundle › Responses

Bundle Successfully Updated

No data returned

POST /account/{mpn}/bundle/{bundle}

curl --request POST \
  --url https://api.onsimapp.com/account/:mpn/bundle/:bundle \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Account - Recording

POST

https://api.onsimapp.com

/account/{mpn}/recording

Enable or disable call and SMS recording for the specified account. ⚠️ Use with caution, especially for users in regulated industries. Disabling recording will immediately stop all data capture, and any unrecorded events cannot be recovered retroactively.

Account - Recording › path Parameters

mpnstring · required
mpn of account you want to update

Account - Recording › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Recording › Request Body

voice_recordingstring · enum · required
Use a value of ON or OFF to enable or disable Voice Recording
Enum values:
ON
OFF
Example: ON
Default: ON
sms_recordingstring · enum · required
Use a value of ON or OFF to enable or disable SMS Recording
Enum values:
ON
OFF
Example: ON
Default: ON

Account - Recording › Responses

Account Recording Status

voice_recordingstring
Voice Recording Status
Example: Voice Recording Activated
sms_recordingstring
SMS Recording Status
Example: SMS Recording Activated

POST /account/{mpn}/recording

curl --request POST \
  --url https://api.onsimapp.com/account/:mpn/recording \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "voice_recording": "ON",
  "sms_recording": "ON"
}
'

shell

Show example in

Request Body Example

{
  "voice_recording": "ON",
  "sms_recording": "ON"
}

json

Example Responses

No example

json

application/json

Account - eSIM

POST

https://api.onsimapp.com

/account/esim

Returns the eSIM activation code and status for the supplied i_account, MPN or ICCID. Additionally allows eSIM activation code to be refreshed if not currently installed. The eSIM activation code can be used to generate a QR code for installation on an eSIM compatible device.

Account - eSIM › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - eSIM › Request Body

i_accountstring
Your account/subscriber's unique ID
Example: 12345
Default:
mpnstring
Enter any of your SIM's numbers, mobile or landline, in e164 (i.e 44777...)
Example: 447777777777
Default:
iccidstring
Your 19 digit SIM ID
Example: 8944444444444444444
Default:
refresh_codeinteger · enum
If set to 1 will refresh the activation code if eSIM has not yet been installed
Enum values:
0
1
Example: 1
Default: 0

Account - eSIM › Responses

eSIM Activation Code, Status of Installation & Refresh Confirmation

esim_codestring
The eSIM Activation Code
Example: LPA:XXXX
esim_statusstring
The eSIM Installation Status
Example: installed or ready to install
enabled_on_devicestring
Whether the installed eSIM is enabled or disabled on the device
Example: Y
refresh_codestring
Whether the call to refresh the code has been actioned
Example: esim code refreshed or error

POST /account/esim

curl --request POST \
  --url https://api.onsimapp.com/account/esim \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "i_account": "12345",
  "mpn": "447777777777",
  "iccid": "8944444444444444444",
  "refresh_code": 0
}
'

shell

Show example in

Request Body Example

{
  "i_account": "12345",
  "mpn": "447777777777",
  "iccid": "8944444444444444444",
  "refresh_code": 0
}

json

Example Responses

No example

json

application/json

Account - Generate QR

POST

https://api.onsimapp.com

/account/esim/generate

Pass a valid eSIM activation code in order to generate a QR Image. Note: Images are presigned S3 URLs with an expiry of 24 hours

Account - Generate QR › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Generate QR › Request Body

esim_codestring · pattern: ^LPA:1 · required
eSIM Activation Code
Example: LPA:XXXXXX

Account - Generate QR › Responses

Presigned QR code PNG URL

string

Example: https://onsimqrcodes.s3.amazonaws.com/UUID.png?X-Amz-Algorithm=XXXXX

POST /account/esim/generate

curl --request POST \
  --url https://api.onsimapp.com/account/esim/generate \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "esim_code": "LPA:XXXXXX"
}
'

shell

Show example in

Request Body Example

{
  "esim_code": "LPA:XXXXXX"
}

json

Example Responses

No example

plain

text/plain

Account - Update Mobile Settings

POST

https://api.onsimapp.com

/account/pbxinfo/{mpn}

Update Mobile Settings for Account

Account - Update Mobile Settings › path Parameters

mpnstring · required
mpn of account you are updating

Account - Update Mobile Settings › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Update Mobile Settings › Request Body

mpnstring
Account's new mpn
Example: 447777777777
pbx_userstring
Account's new SIP address/username
Example: USER12345
pbx_passwordstring
Account's new SIP password
Example: PA$$W0RD!
first_namestring
Account's new First Name
Example: John
last_namestring
Account's new Last Name
Example: Smith
emailstring
Account's new Email Address
Example: j.smith@example.com
mobile_datastring · enum
Use a value of ON or OFF to enable or disable Mobile Data
Enum values:
ON
OFF
Example: ON
Default: ON
mobile_voicestring · enum
Use a value of ON or OFF to enable or disable Mobile Voice
Enum values:
ON
OFF
Example: ON
Default: ON
mobile_smsstring · enum
Use a value of ON or OFF to enable or disable Mobile SMS
Enum values:
ON
OFF
Example: ON
Default: ON
mobile_hotspotstring · enum
Use a value of ON or OFF to enable or disable Mobile Hotspot/Tethering of mobile data
Enum values:
ON
OFF
Example: ON
Default: OFF

Account - Update Mobile Settings › Responses

Account Updated

No data returned

POST /account/pbxinfo/{mpn}

curl --request POST \
  --url https://api.onsimapp.com/account/pbxinfo/:mpn \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpn": "447777777777",
  "pbx_user": "USER12345",
  "pbx_password": "PA$$W0RD!",
  "first_name": "John",
  "last_name": "Smith",
  "email": "j.smith@example.com",
  "mobile_data": "ON",
  "mobile_voice": "ON",
  "mobile_sms": "ON",
  "mobile_hotspot": "ON"
}
'

shell

Show example in

Request Body Example

{
  "mpn": "447777777777",
  "pbx_user": "USER12345",
  "pbx_password": "PA$$W0RD!",
  "first_name": "John",
  "last_name": "Smith",
  "email": "j.smith@example.com",
  "mobile_data": "ON",
  "mobile_voice": "ON",
  "mobile_sms": "ON",
  "mobile_hotspot": "ON"
}

json

Example Responses

No example

plain

Account - SIM Swap

POST

https://api.onsimapp.com

/account/sim-swap

Update the SIM (perform a SIM Swap) used by an Account

Account - SIM Swap › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - SIM Swap › Request Body

mpnstring · required
Account's mobile phone number
Example: 447777777777
new_iccidstring · required
New ICCID for physical SIM or if set to eSIM it will switch to the next available eSIM.
Example: 894400000000012345

Account - SIM Swap › Responses

Sim Swap update successful

No data returned

POST /account/sim-swap

curl --request POST \
  --url https://api.onsimapp.com/account/sim-swap \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpn": "447777777777",
  "new_iccid": "894400000000012345"
}
'

shell

Show example in

Request Body Example

{
  "mpn": "447777777777",
  "new_iccid": "894400000000012345"
}

json

Example Responses

No example

plain

Numbers - List all numbers

GET

https://api.onsimapp.com

/numbers/{state}

Get a list of reseller numbers filtered by state

Numbers - List all numbers › path Parameters

statestring · required
State of mpn - either 'ACTIVE' or 'RESERVED'

Numbers - List all numbers › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Numbers - List all numbers › Responses

List of numbers filtered by state

No data returned

GET /numbers/{state}

curl --request GET \
  --url https://api.onsimapp.com/numbers/:state \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Numbers - Add a number

POST

https://api.onsimapp.com

/numbers/{mpn}

Adds a number

Numbers - Add a number › path Parameters

mpnstring · required
mpn to add

Numbers - Add a number › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Numbers - Add a number › Responses

Number added

No data returned

POST /numbers/{mpn}

curl --request POST \
  --url https://api.onsimapp.com/numbers/:mpn \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Numbers - Delete a number

DELETE

https://api.onsimapp.com

/numbers/{mpn}

Deletes a number. NOTE: you can only delete numbers that are in a 'RESERVED' state (i.e not on an active account)

Numbers - Delete a number › path Parameters

mpnstring · required
mpn to delete

Numbers - Delete a number › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Numbers - Delete a number › Responses

Number deleted

No data returned

DELETE /numbers/{mpn}

curl --request DELETE \
  --url https://api.onsimapp.com/numbers/:mpn \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Reseller - List Groups

GET

https://api.onsimapp.com

/reseller/groups

Get a list of all reseller groups

Reseller - List Groups › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - List Groups › Responses

List of groups

No data returned

GET /reseller/groups

curl --request GET \
  --url https://api.onsimapp.com/reseller/groups \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Reseller - Add Group

POST

https://api.onsimapp.com

/reseller/groups

Add a new Group/Customer

Reseller - Add Group › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - Add Group › Request Body

namestring · required
Group Name. ((Must be unique, length 3-45 characters ('a-z' 'A-Z' '0-9' '_' '-'), MUST start with an alphanumeric character, MUST contain at least one Alphabetical character & No spaces or other characters))
Example: ExampleCustomer
address_line_1string · required
Line 1 of customer address
Example: Example Building
home_locationstring · required
A list of three character country codes (ISO-3166) for which the Group's service is primarily homed, comma separated when more than one location: current values limited to "GBR" or "USA" or a list of the two
Example: GBR

address_line_2string
Line 2 of customer address
Example: 18 Example Street
citystring
Customer City
Example: Example City
countrystring
Customer Country
Example: Example Country
post_codestring
Customer Post Code
Example: SW1A 0AA
descriptionstring
Description of the customer/group
Example: Example Group for testing API

Reseller - Add Group › Responses

New Group Successfully Added

No data returned

POST /reseller/groups

curl --request POST \
  --url https://api.onsimapp.com/reseller/groups \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "ExampleCustomer",
  "address_line_1": "Example Building",
  "address_line_2": "18 Example Street",
  "city": "Example City",
  "country": "Example Country",
  "post_code": "SW1A 0AA",
  "home_location": "GBR",
  "description": "Example Group for testing API"
}
'

shell

Show example in

Request Body Example

{
  "name": "ExampleCustomer",
  "address_line_1": "Example Building",
  "address_line_2": "18 Example Street",
  "city": "Example City",
  "country": "Example Country",
  "post_code": "SW1A 0AA",
  "home_location": "GBR",
  "description": "Example Group for testing API"
}

json

Example Responses

No example

plain

Reseller - List Product Catalogue

GET

https://api.onsimapp.com

/reseller/catalogue

Return a list of available bundles and product SKU's for provisioning ONSIM services

Reseller - List Product Catalogue › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - List Product Catalogue › Responses

List of Products and Bundles

catalogueobject · required

GET /reseller/catalogue

curl --request GET \
  --url https://api.onsimapp.com/reseller/catalogue \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Reseller - Provision Account (own UC)

POST

https://api.onsimapp.com

/reseller/provision

Provision a new SIM when using your own PBX.

Reseller - Provision Account (own UC) › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - Provision Account (own UC) › Request Body

mpnstring · required
Number to be used as the account's primary mobile number (used for SMS, iMessage, etc)
Example: 447777777777

iccidstring
19 digit ICCID of physical SIM (remove the final digit from printed version). If ICCID is not supplied the next available eSIM will be used.
Example: 8944530000000012345
pbx_userstring
Account's SIP address/username - if not included in request it will default to 'ONSIM[ICCID]'
Example: USER12345
pbx_passwordstring
Account's new SIP password - if not included in request we will create one and return this in the response
Example: 1a2B3c4D

Reseller - Provision Account (own UC) › Responses

Successful Provision of Subscriber

esim_codestring
The eSIM Activation Code
Example: LPA:XXXX
iccidstring
The ICCID of the eSIM with ONSIM appended at the beginning - this is the SIP Address/Username
Example: ONSIM8944000000000123456
pbx_passwordstring
This is the SIP Password for the provisioned user
Example: 1a2B3c4D

POST /reseller/provision

curl --request POST \
  --url https://api.onsimapp.com/reseller/provision \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpn": "447777777777",
  "iccid": "8944530000000012345",
  "pbx_user": "USER12345",
  "pbx_password": "1a2B3c4D"
}
'

shell

Show example in

Request Body Example

{
  "mpn": "447777777777",
  "iccid": "8944530000000012345",
  "pbx_user": "USER12345",
  "pbx_password": "1a2B3c4D"
}

json

Example Responses

No example

json

application/json

Reseller - Provision Account (ONSIM UC)

POST

https://api.onsimapp.com

/reseller/provision-onsim

Provision a new account and SIM on ONSIM.

Reseller - Provision Account (ONSIM UC) › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - Provision Account (ONSIM UC) › Request Body

mpnstring · required
Number to be used as the account's primary mobile number (used for SMS, iMessage, etc)
Example: 447777777777
group_namestring · required
Customer Group ID
Example: CUSTOMER_A
home_locationstring · enum · required
Home Location of USER (GBR, USA, FRA, etc)
Enum values:
GBR
USA
FRA
Example: USA
first_namestring · required
Account's First Name
Example: John
last_namestring · required
Account's Last Name
Example: Smith
emailstring · required
Account's Email Address
Example: j.smith@example.com
productinteger · required
ID of the product to provision
Example: 18
mobile_datastring · enum · required
Data Bundle to be applied to the subscriber
Enum values:
BACKGROUND-ONLY
2GB
4GB
10GB
20GB
UNLIMITED
Example: 2GB

iccidstring
19 digit ICCID of physical SIM (remove the final digit from printed version). If ICCID is not supplied the next available eSIM will be used.
Example: 8944530000000012345

Reseller - Provision Account (ONSIM UC) › Responses

Successful Provision of Subscriber

esim_codestring
The eSIM Activation Code
Example: LPA:XXXX
iccidstring
The ICCID of the eSIM with ONSIM appended at the beginning - this is the SIP Address/Username
Example: ONSIM8944000000000123456
pbx_passwordstring
This is the SIP Password for the provisioned user
Example: 1a2B3c4D

POST /reseller/provision-onsim

curl --request POST \
  --url https://api.onsimapp.com/reseller/provision-onsim \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpn": "447777777777",
  "iccid": "8944530000000012345",
  "group_name": "CUSTOMER_A",
  "home_location": "GBR",
  "first_name": "John",
  "last_name": "Smith",
  "email": "j.smith@example.com",
  "product": 18,
  "mobile_data": "BACKGROUND-ONLY"
}
'

shell

Show example in

Request Body Example

{
  "mpn": "447777777777",
  "iccid": "8944530000000012345",
  "group_name": "CUSTOMER_A",
  "home_location": "GBR",
  "first_name": "John",
  "last_name": "Smith",
  "email": "j.smith@example.com",
  "product": 18,
  "mobile_data": "BACKGROUND-ONLY"
}

json

Example Responses

No example

json

application/json

Reseller - List Subscribers

POST

https://api.onsimapp.com

/reseller/subscribers

Returns a list of existing Subscribers for the Reseller.

Reseller - List Subscribers › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - List Subscribers › Request Body

statestring · enum · required
Subscriber status/state. Must be 'PROVISIONED'.
Enum values:
PROVISIONED
Example: PROVISIONED

is_recordedboolean
Return the recording state of all subscribers
Example: true
groupstring
Optionally filter by group
Example: CUSTOMERA

Reseller - List Subscribers › Responses

JSON List of your Subscribers

No data returned

POST /reseller/subscribers

curl --request POST \
  --url https://api.onsimapp.com/reseller/subscribers \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "PROVISIONED",
  "is_recorded": true,
  "group": "CUSTOMERA"
}
'

shell

Show example in

Request Body Example

{
  "state": "PROVISIONED",
  "is_recorded": true,
  "group": "CUSTOMERA"
}

json

Example Responses

No example

plain

SIMs - List all sims

GET

https://api.onsimapp.com

/sims/{state}/{type}

Get a list of reseller sims filtered by state and type

SIMs - List all sims › path Parameters

statestring · required
State of SIM - either 'ACTIVE' or 'RESERVED'
typestring · required
Type of SIM - either 'ALL', 'eSIM' or 'pSIM'

SIMs - List all sims › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

SIMs - List all sims › Responses

List of sims filtered by state and type

No data returned

GET /sims/{state}/{type}

curl --request GET \
  --url https://api.onsimapp.com/sims/:state/:type \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

SMS - Terminate SMS

POST

https://api.onsimapp.com

/sms/terminate

Delivers a SMS message to an ONSIM subscriber - please make sure you have enabled SMS Gateway for this subscriber.

SMS - Terminate SMS › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

SMS - Terminate SMS › Request Body

idstring · required
Your unique reference for the SMS Message
Example: 39edf9a4-7e2d-4126-af69-5246da735278
Default:
fromstring · required
+e164 number of sender (i.e +44777...)
Example: +447777777777
Default:
tostring · required
+e164 number of ONSIM Subscriber (i.e +44777...)
Example: +447888888888
Default:
messagestring · required
Body of SMS encoded in UTF-8
Example: Hello ONSIM Subscriber!
Default:

SMS - Terminate SMS › Responses

SMS Successfully Terminated

No data returned

POST /sms/terminate

curl --request POST \
  --url https://api.onsimapp.com/sms/terminate \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "39edf9a4-7e2d-4126-af69-5246da735278",
  "from": "+447777777777",
  "to": "+447888888888",
  "message": "Hello ONSIM Subscriber!"
}
'

shell

Show example in

Request Body Example

{
  "id": "39edf9a4-7e2d-4126-af69-5246da735278",
  "from": "+447777777777",
  "to": "+447888888888",
  "message": "Hello ONSIM Subscriber!"
}

json

Example Responses

No example

plain

Porting - List All Ports

GET

https://api.onsimapp.com

/port/all/{state}

Returns a list of ports filtered by status. Valid state types = [ALL, INITIAL, IN PROGRESS, FAILED, COMPLETE, CLOSED]

Porting - List All Ports › path Parameters

statestring · required
State to filter results

Porting - List All Ports › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Porting - List All Ports › Responses

List of Ports filtered by State

portQueueobject[]
List of Ports filtered by State
Example: {"port":[{"trID":"1","number":"447777777771","orderDate":"2025-01-01","PAC":"ABC12345","portinDate":"2025-01-02","portinNumber":"447777777772","resellerId":"1","status":"COMPLETE","type":"PORT-IN","updatedDate":"Jan 2, 2025 1:20:30 PM"}]}

GET /port/all/{state}

curl --request GET \
  --url https://api.onsimapp.com/port/all/:state \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Porting - Lookup Port

GET

https://api.onsimapp.com

/port/{id}

Lookup the details of an ACTIVE Port with the supplied ID

Porting - Lookup Port › path Parameters

idstring · required
ID of the port to query

Porting - Lookup Port › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Porting - Lookup Port › Responses

Port Details

portobject
Port Details
Example: {"trID":"1","number":"447777777771","orderDate":"2025-01-01","PAC":"ABC12345","portinDate":"2025-01-02","portinNumber":"447777777772","resellerId":"1","status":"COMPLETE","type":"PORT-IN","updatedDate":"Jan 2, 2025 1:20:30 PM","validUntil":"2025-01-30"}

GET /port/{id}

curl --request GET \
  --url https://api.onsimapp.com/port/:id \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Porting - Port in UK MPN

POST

https://api.onsimapp.com

/port/port-in

Request PORT IN of UK MPN using a PAC obtained from another network. ⚠️ IMPORTANT:: The Number being replaced (the number currently in use on the target SIM) will be irrevocably removed from the system. If you need to keep both numbers please contact support.

Porting - Port in UK MPN › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Porting - Port in UK MPN › Request Body

numberstring · required
The Current MPN on the SIM which will be replaced by the number being ported in - this number will be irrevocably lost
Example: 447777777771
PACstring · required
PAC code from current provider
Example: ABC12345
portinNumberstring · required
The MPN being ported in that will replace the number on the SIM
Example: 447777777772
portinDatestring · required
The requested port in date - please note, this must be a minimum of 24 hours in the future, is not guaranteed and must be formatted YYYYMMDD. We would also strongly suggest not selecting weekend dates. Note: Ports can complete at any time on the day of porting.
Example: 20190129

Porting - Port in UK MPN › Responses

Port Request Response

port_requestobject
Port Request Response
Example: {"trID":"1","number":"447777777771","PAC":"ABC12345","portinDate":"2025-01-02","portinNumber":"447777777772","status":"INITIAL","type":"PORT-IN"}

POST /port/port-in

curl --request POST \
  --url https://api.onsimapp.com/port/port-in \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "447777777771",
  "PAC": "ABC12345",
  "portinNumber": "447777777772",
  "portinDate": "20190129"
}
'

shell

Show example in

Request Body Example

{
  "number": "447777777771",
  "PAC": "ABC12345",
  "portinNumber": "447777777772",
  "portinDate": "20190129"
}

json

Example Responses

No example

json

application/json

Porting - Request PAC

POST

https://api.onsimapp.com

/port/pac/{mpn}

Request PAC Code to Export a UK Mobile Number from the ONSIM network. PAC's are valid for 30 days and must be supplied to your new network provider. ⚠️ IMPORTANT:: porting a number does not terminate a subscriber or your contractual obligations.

Porting - Request PAC › path Parameters

mpnstring · required
MPN you wish to port and obtain a PAC Code

Porting - Request PAC › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Porting - Request PAC › Responses

PAC Request Response

pac_requestobject
PAC Request Info
Example: {"port_id":12345,"status":"INITIAL"}

POST /port/pac/{mpn}

curl --request POST \
  --url https://api.onsimapp.com/port/pac/:mpn \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

ONSIM API

Endpoint:https://api.onsimapp.com

Account - Cease Account

DELETE

https://api.onsimapp.com

/account

Cease Account. WARNING:: Please use with caution this will irrevocably cease the SIM and Account - it can not be reversed

Account - Cease Account › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Cease Account › Request Body

iccidstring · required
SIM ICCID
Example: 8944530000000012345

Account - Cease Account › Responses

Account Successfully Ceased

No data returned

DELETE /account

curl --request DELETE \
  --url https://api.onsimapp.com/account \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "iccid": "8944530000000012345"
}
'

shell

Show example in

Request Body Example

{
  "iccid": "8944530000000012345"
}

json

Example Responses

No example

plain

Account - Get Info

GET

https://api.onsimapp.com

/account/{mpn}

Get account information, services and bundle

Account - Get Info › path Parameters

mpnstring · required
mpn of account you want to retrieve info for

Account - Get Info › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Get Info › Responses

Info of Account

accountobject[]
Info Regarding the Account
Example: {"sim":"8944000000000123456","i_account":"123456","mpn":"447777777777","sip_address":"sipaddress","services":{"mobile_data":"ON","mobile_hotspot":"OFF","mobile_messaging":"ON","mobile_voice":"ON"},"bundles":{"data":{"bundle_name":"10GB","allowance":10240,"used":240,"remaining":10000,"unit":"megabyte","period_from":"2024-01-01 00:00:00","period_to":"2024-02-01 00:00:00"}}}

GET /account/{mpn}

curl --request GET \
  --url https://api.onsimapp.com/account/:mpn \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Account - Update Bundle

POST

https://api.onsimapp.com

/account/{mpn}/bundle/{bundle}

Use this method to update the bundle associated to the Account use either BASE (no data) or UNLIMITED (data)

Account - Update Bundle › path Parameters

mpnstring · required
mpn of account you want to update
bundlestring · required
Bundle SKU

Account - Update Bundle › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Update Bundle › Responses

Bundle Successfully Updated

No data returned

POST /account/{mpn}/bundle/{bundle}

curl --request POST \
  --url https://api.onsimapp.com/account/:mpn/bundle/:bundle \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Account - Recording

POST

https://api.onsimapp.com

/account/{mpn}/recording

Account - Recording › path Parameters

mpnstring · required
mpn of account you want to update

Account - Recording › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Recording › Request Body

voice_recordingstring · enum · required
Use a value of ON or OFF to enable or disable Voice Recording
Enum values:
ON
OFF
Example: ON
Default: ON
sms_recordingstring · enum · required
Use a value of ON or OFF to enable or disable SMS Recording
Enum values:
ON
OFF
Example: ON
Default: ON

Account - Recording › Responses

Account Recording Status

voice_recordingstring
Voice Recording Status
Example: Voice Recording Activated
sms_recordingstring
SMS Recording Status
Example: SMS Recording Activated

POST /account/{mpn}/recording

curl --request POST \
  --url https://api.onsimapp.com/account/:mpn/recording \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "voice_recording": "ON",
  "sms_recording": "ON"
}
'

shell

Show example in

Request Body Example

{
  "voice_recording": "ON",
  "sms_recording": "ON"
}

json

Example Responses

No example

json

application/json

Account - eSIM

POST

https://api.onsimapp.com

/account/esim

Account - eSIM › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - eSIM › Request Body

i_accountstring
Your account/subscriber's unique ID
Example: 12345
Default:
mpnstring
Enter any of your SIM's numbers, mobile or landline, in e164 (i.e 44777...)
Example: 447777777777
Default:
iccidstring
Your 19 digit SIM ID
Example: 8944444444444444444
Default:
refresh_codeinteger · enum
If set to 1 will refresh the activation code if eSIM has not yet been installed
Enum values:
0
1
Example: 1
Default: 0

Account - eSIM › Responses

eSIM Activation Code, Status of Installation & Refresh Confirmation

esim_codestring
The eSIM Activation Code
Example: LPA:XXXX
esim_statusstring
The eSIM Installation Status
Example: installed or ready to install
enabled_on_devicestring
Whether the installed eSIM is enabled or disabled on the device
Example: Y
refresh_codestring
Whether the call to refresh the code has been actioned
Example: esim code refreshed or error

POST /account/esim

curl --request POST \
  --url https://api.onsimapp.com/account/esim \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "i_account": "12345",
  "mpn": "447777777777",
  "iccid": "8944444444444444444",
  "refresh_code": 0
}
'

shell

Show example in

Request Body Example

{
  "i_account": "12345",
  "mpn": "447777777777",
  "iccid": "8944444444444444444",
  "refresh_code": 0
}

json

Example Responses

No example

json

application/json

Account - Generate QR

POST

https://api.onsimapp.com

/account/esim/generate

Pass a valid eSIM activation code in order to generate a QR Image. Note: Images are presigned S3 URLs with an expiry of 24 hours

Account - Generate QR › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Generate QR › Request Body

esim_codestring · pattern: ^LPA:1 · required
eSIM Activation Code
Example: LPA:XXXXXX

Account - Generate QR › Responses

Presigned QR code PNG URL

string

Example: https://onsimqrcodes.s3.amazonaws.com/UUID.png?X-Amz-Algorithm=XXXXX

POST /account/esim/generate

curl --request POST \
  --url https://api.onsimapp.com/account/esim/generate \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "esim_code": "LPA:XXXXXX"
}
'

shell

Show example in

Request Body Example

{
  "esim_code": "LPA:XXXXXX"
}

json

Example Responses

No example

plain

text/plain

Account - Update Mobile Settings

POST

https://api.onsimapp.com

/account/pbxinfo/{mpn}

Update Mobile Settings for Account

Account - Update Mobile Settings › path Parameters

mpnstring · required
mpn of account you are updating

Account - Update Mobile Settings › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - Update Mobile Settings › Request Body

mpnstring
Account's new mpn
Example: 447777777777
pbx_userstring
Account's new SIP address/username
Example: USER12345
pbx_passwordstring
Account's new SIP password
Example: PA$$W0RD!
first_namestring
Account's new First Name
Example: John
last_namestring
Account's new Last Name
Example: Smith
emailstring
Account's new Email Address
Example: j.smith@example.com
mobile_datastring · enum
Use a value of ON or OFF to enable or disable Mobile Data
Enum values:
ON
OFF
Example: ON
Default: ON
mobile_voicestring · enum
Use a value of ON or OFF to enable or disable Mobile Voice
Enum values:
ON
OFF
Example: ON
Default: ON
mobile_smsstring · enum
Use a value of ON or OFF to enable or disable Mobile SMS
Enum values:
ON
OFF
Example: ON
Default: ON
mobile_hotspotstring · enum
Use a value of ON or OFF to enable or disable Mobile Hotspot/Tethering of mobile data
Enum values:
ON
OFF
Example: ON
Default: OFF

Account - Update Mobile Settings › Responses

Account Updated

No data returned

POST /account/pbxinfo/{mpn}

curl --request POST \
  --url https://api.onsimapp.com/account/pbxinfo/:mpn \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpn": "447777777777",
  "pbx_user": "USER12345",
  "pbx_password": "PA$$W0RD!",
  "first_name": "John",
  "last_name": "Smith",
  "email": "j.smith@example.com",
  "mobile_data": "ON",
  "mobile_voice": "ON",
  "mobile_sms": "ON",
  "mobile_hotspot": "ON"
}
'

shell

Show example in

Request Body Example

{
  "mpn": "447777777777",
  "pbx_user": "USER12345",
  "pbx_password": "PA$$W0RD!",
  "first_name": "John",
  "last_name": "Smith",
  "email": "j.smith@example.com",
  "mobile_data": "ON",
  "mobile_voice": "ON",
  "mobile_sms": "ON",
  "mobile_hotspot": "ON"
}

json

Example Responses

No example

plain

Account - SIM Swap

POST

https://api.onsimapp.com

/account/sim-swap

Update the SIM (perform a SIM Swap) used by an Account

Account - SIM Swap › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Account - SIM Swap › Request Body

mpnstring · required
Account's mobile phone number
Example: 447777777777
new_iccidstring · required
New ICCID for physical SIM or if set to eSIM it will switch to the next available eSIM.
Example: 894400000000012345

Account - SIM Swap › Responses

Sim Swap update successful

No data returned

POST /account/sim-swap

curl --request POST \
  --url https://api.onsimapp.com/account/sim-swap \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpn": "447777777777",
  "new_iccid": "894400000000012345"
}
'

shell

Show example in

Request Body Example

{
  "mpn": "447777777777",
  "new_iccid": "894400000000012345"
}

json

Example Responses

No example

plain

Numbers - List all numbers

GET

https://api.onsimapp.com

/numbers/{state}

Get a list of reseller numbers filtered by state

Numbers - List all numbers › path Parameters

statestring · required
State of mpn - either 'ACTIVE' or 'RESERVED'

Numbers - List all numbers › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Numbers - List all numbers › Responses

List of numbers filtered by state

No data returned

GET /numbers/{state}

curl --request GET \
  --url https://api.onsimapp.com/numbers/:state \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Numbers - Add a number

POST

https://api.onsimapp.com

/numbers/{mpn}

Adds a number

Numbers - Add a number › path Parameters

mpnstring · required
mpn to add

Numbers - Add a number › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Numbers - Add a number › Responses

Number added

No data returned

POST /numbers/{mpn}

curl --request POST \
  --url https://api.onsimapp.com/numbers/:mpn \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Numbers - Delete a number

DELETE

https://api.onsimapp.com

/numbers/{mpn}

Deletes a number. NOTE: you can only delete numbers that are in a 'RESERVED' state (i.e not on an active account)

Numbers - Delete a number › path Parameters

mpnstring · required
mpn to delete

Numbers - Delete a number › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Numbers - Delete a number › Responses

Number deleted

No data returned

DELETE /numbers/{mpn}

curl --request DELETE \
  --url https://api.onsimapp.com/numbers/:mpn \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Reseller - List Groups

GET

https://api.onsimapp.com

/reseller/groups

Get a list of all reseller groups

Reseller - List Groups › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - List Groups › Responses

List of groups

No data returned

GET /reseller/groups

curl --request GET \
  --url https://api.onsimapp.com/reseller/groups \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

Reseller - Add Group

POST

https://api.onsimapp.com

/reseller/groups

Add a new Group/Customer

Reseller - Add Group › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - Add Group › Request Body

namestring · required
Group Name. ((Must be unique, length 3-45 characters ('a-z' 'A-Z' '0-9' '_' '-'), MUST start with an alphanumeric character, MUST contain at least one Alphabetical character & No spaces or other characters))
Example: ExampleCustomer
address_line_1string · required
Line 1 of customer address
Example: Example Building
home_locationstring · required
A list of three character country codes (ISO-3166) for which the Group's service is primarily homed, comma separated when more than one location: current values limited to "GBR" or "USA" or a list of the two
Example: GBR

address_line_2string
Line 2 of customer address
Example: 18 Example Street
citystring
Customer City
Example: Example City
countrystring
Customer Country
Example: Example Country
post_codestring
Customer Post Code
Example: SW1A 0AA
descriptionstring
Description of the customer/group
Example: Example Group for testing API

Reseller - Add Group › Responses

New Group Successfully Added

No data returned

POST /reseller/groups

curl --request POST \
  --url https://api.onsimapp.com/reseller/groups \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "ExampleCustomer",
  "address_line_1": "Example Building",
  "address_line_2": "18 Example Street",
  "city": "Example City",
  "country": "Example Country",
  "post_code": "SW1A 0AA",
  "home_location": "GBR",
  "description": "Example Group for testing API"
}
'

shell

Show example in

Request Body Example

{
  "name": "ExampleCustomer",
  "address_line_1": "Example Building",
  "address_line_2": "18 Example Street",
  "city": "Example City",
  "country": "Example Country",
  "post_code": "SW1A 0AA",
  "home_location": "GBR",
  "description": "Example Group for testing API"
}

json

Example Responses

No example

plain

Reseller - List Product Catalogue

GET

https://api.onsimapp.com

/reseller/catalogue

Return a list of available bundles and product SKU's for provisioning ONSIM services

Reseller - List Product Catalogue › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - List Product Catalogue › Responses

List of Products and Bundles

catalogueobject · required

GET /reseller/catalogue

curl --request GET \
  --url https://api.onsimapp.com/reseller/catalogue \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Reseller - Provision Account (own UC)

POST

https://api.onsimapp.com

/reseller/provision

Provision a new SIM when using your own PBX.

Reseller - Provision Account (own UC) › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - Provision Account (own UC) › Request Body

mpnstring · required
Number to be used as the account's primary mobile number (used for SMS, iMessage, etc)
Example: 447777777777

iccidstring
19 digit ICCID of physical SIM (remove the final digit from printed version). If ICCID is not supplied the next available eSIM will be used.
Example: 8944530000000012345
pbx_userstring
Account's SIP address/username - if not included in request it will default to 'ONSIM[ICCID]'
Example: USER12345
pbx_passwordstring
Account's new SIP password - if not included in request we will create one and return this in the response
Example: 1a2B3c4D

Reseller - Provision Account (own UC) › Responses

Successful Provision of Subscriber

esim_codestring
The eSIM Activation Code
Example: LPA:XXXX
iccidstring
The ICCID of the eSIM with ONSIM appended at the beginning - this is the SIP Address/Username
Example: ONSIM8944000000000123456
pbx_passwordstring
This is the SIP Password for the provisioned user
Example: 1a2B3c4D

POST /reseller/provision

curl --request POST \
  --url https://api.onsimapp.com/reseller/provision \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpn": "447777777777",
  "iccid": "8944530000000012345",
  "pbx_user": "USER12345",
  "pbx_password": "1a2B3c4D"
}
'

shell

Show example in

Request Body Example

{
  "mpn": "447777777777",
  "iccid": "8944530000000012345",
  "pbx_user": "USER12345",
  "pbx_password": "1a2B3c4D"
}

json

Example Responses

No example

json

application/json

Reseller - Provision Account (ONSIM UC)

POST

https://api.onsimapp.com

/reseller/provision-onsim

Provision a new account and SIM on ONSIM.

Reseller - Provision Account (ONSIM UC) › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - Provision Account (ONSIM UC) › Request Body

mpnstring · required
Number to be used as the account's primary mobile number (used for SMS, iMessage, etc)
Example: 447777777777
group_namestring · required
Customer Group ID
Example: CUSTOMER_A
home_locationstring · enum · required
Home Location of USER (GBR, USA, FRA, etc)
Enum values:
GBR
USA
FRA
Example: USA
first_namestring · required
Account's First Name
Example: John
last_namestring · required
Account's Last Name
Example: Smith
emailstring · required
Account's Email Address
Example: j.smith@example.com
productinteger · required
ID of the product to provision
Example: 18
mobile_datastring · enum · required
Data Bundle to be applied to the subscriber
Enum values:
BACKGROUND-ONLY
2GB
4GB
10GB
20GB
UNLIMITED
Example: 2GB

iccidstring
19 digit ICCID of physical SIM (remove the final digit from printed version). If ICCID is not supplied the next available eSIM will be used.
Example: 8944530000000012345

Reseller - Provision Account (ONSIM UC) › Responses

Successful Provision of Subscriber

esim_codestring
The eSIM Activation Code
Example: LPA:XXXX
iccidstring
The ICCID of the eSIM with ONSIM appended at the beginning - this is the SIP Address/Username
Example: ONSIM8944000000000123456
pbx_passwordstring
This is the SIP Password for the provisioned user
Example: 1a2B3c4D

POST /reseller/provision-onsim

curl --request POST \
  --url https://api.onsimapp.com/reseller/provision-onsim \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpn": "447777777777",
  "iccid": "8944530000000012345",
  "group_name": "CUSTOMER_A",
  "home_location": "GBR",
  "first_name": "John",
  "last_name": "Smith",
  "email": "j.smith@example.com",
  "product": 18,
  "mobile_data": "BACKGROUND-ONLY"
}
'

shell

Show example in

Request Body Example

{
  "mpn": "447777777777",
  "iccid": "8944530000000012345",
  "group_name": "CUSTOMER_A",
  "home_location": "GBR",
  "first_name": "John",
  "last_name": "Smith",
  "email": "j.smith@example.com",
  "product": 18,
  "mobile_data": "BACKGROUND-ONLY"
}

json

Example Responses

No example

json

application/json

Reseller - List Subscribers

POST

https://api.onsimapp.com

/reseller/subscribers

Returns a list of existing Subscribers for the Reseller.

Reseller - List Subscribers › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reseller - List Subscribers › Request Body

statestring · enum · required
Subscriber status/state. Must be 'PROVISIONED'.
Enum values:
PROVISIONED
Example: PROVISIONED

is_recordedboolean
Return the recording state of all subscribers
Example: true
groupstring
Optionally filter by group
Example: CUSTOMERA

Reseller - List Subscribers › Responses

JSON List of your Subscribers

No data returned

POST /reseller/subscribers

curl --request POST \
  --url https://api.onsimapp.com/reseller/subscribers \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "PROVISIONED",
  "is_recorded": true,
  "group": "CUSTOMERA"
}
'

shell

Show example in

Request Body Example

{
  "state": "PROVISIONED",
  "is_recorded": true,
  "group": "CUSTOMERA"
}

json

Example Responses

No example

plain

SIMs - List all sims

GET

https://api.onsimapp.com

/sims/{state}/{type}

Get a list of reseller sims filtered by state and type

SIMs - List all sims › path Parameters

statestring · required
State of SIM - either 'ACTIVE' or 'RESERVED'
typestring · required
Type of SIM - either 'ALL', 'eSIM' or 'pSIM'

SIMs - List all sims › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

SIMs - List all sims › Responses

List of sims filtered by state and type

No data returned

GET /sims/{state}/{type}

curl --request GET \
  --url https://api.onsimapp.com/sims/:state/:type \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

plain

SMS - Terminate SMS

POST

https://api.onsimapp.com

/sms/terminate

Delivers a SMS message to an ONSIM subscriber - please make sure you have enabled SMS Gateway for this subscriber.

SMS - Terminate SMS › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

SMS - Terminate SMS › Request Body

idstring · required
Your unique reference for the SMS Message
Example: 39edf9a4-7e2d-4126-af69-5246da735278
Default:
fromstring · required
+e164 number of sender (i.e +44777...)
Example: +447777777777
Default:
tostring · required
+e164 number of ONSIM Subscriber (i.e +44777...)
Example: +447888888888
Default:
messagestring · required
Body of SMS encoded in UTF-8
Example: Hello ONSIM Subscriber!
Default:

SMS - Terminate SMS › Responses

SMS Successfully Terminated

No data returned

POST /sms/terminate

curl --request POST \
  --url https://api.onsimapp.com/sms/terminate \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "39edf9a4-7e2d-4126-af69-5246da735278",
  "from": "+447777777777",
  "to": "+447888888888",
  "message": "Hello ONSIM Subscriber!"
}
'

shell

Show example in

Request Body Example

{
  "id": "39edf9a4-7e2d-4126-af69-5246da735278",
  "from": "+447777777777",
  "to": "+447888888888",
  "message": "Hello ONSIM Subscriber!"
}

json

Example Responses

No example

plain

Porting - List All Ports

GET

https://api.onsimapp.com

/port/all/{state}

Returns a list of ports filtered by status. Valid state types = [ALL, INITIAL, IN PROGRESS, FAILED, COMPLETE, CLOSED]

Porting - List All Ports › path Parameters

statestring · required
State to filter results

Porting - List All Ports › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Porting - List All Ports › Responses

List of Ports filtered by State

portQueueobject[]
List of Ports filtered by State
Example: {"port":[{"trID":"1","number":"447777777771","orderDate":"2025-01-01","PAC":"ABC12345","portinDate":"2025-01-02","portinNumber":"447777777772","resellerId":"1","status":"COMPLETE","type":"PORT-IN","updatedDate":"Jan 2, 2025 1:20:30 PM"}]}

GET /port/all/{state}

curl --request GET \
  --url https://api.onsimapp.com/port/all/:state \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Porting - Lookup Port

GET

https://api.onsimapp.com

/port/{id}

Lookup the details of an ACTIVE Port with the supplied ID

Porting - Lookup Port › path Parameters

idstring · required
ID of the port to query

Porting - Lookup Port › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Porting - Lookup Port › Responses

Port Details

portobject
Port Details
Example: {"trID":"1","number":"447777777771","orderDate":"2025-01-01","PAC":"ABC12345","portinDate":"2025-01-02","portinNumber":"447777777772","resellerId":"1","status":"COMPLETE","type":"PORT-IN","updatedDate":"Jan 2, 2025 1:20:30 PM","validUntil":"2025-01-30"}

GET /port/{id}

curl --request GET \
  --url https://api.onsimapp.com/port/:id \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Porting - Port in UK MPN

POST

https://api.onsimapp.com

/port/port-in

Porting - Port in UK MPN › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Porting - Port in UK MPN › Request Body

numberstring · required
The Current MPN on the SIM which will be replaced by the number being ported in - this number will be irrevocably lost
Example: 447777777771
PACstring · required
PAC code from current provider
Example: ABC12345
portinNumberstring · required
The MPN being ported in that will replace the number on the SIM
Example: 447777777772
portinDatestring · required
The requested port in date - please note, this must be a minimum of 24 hours in the future, is not guaranteed and must be formatted YYYYMMDD. We would also strongly suggest not selecting weekend dates. Note: Ports can complete at any time on the day of porting.
Example: 20190129

Porting - Port in UK MPN › Responses

Port Request Response

port_requestobject
Port Request Response
Example: {"trID":"1","number":"447777777771","PAC":"ABC12345","portinDate":"2025-01-02","portinNumber":"447777777772","status":"INITIAL","type":"PORT-IN"}

POST /port/port-in

curl --request POST \
  --url https://api.onsimapp.com/port/port-in \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "447777777771",
  "PAC": "ABC12345",
  "portinNumber": "447777777772",
  "portinDate": "20190129"
}
'

shell

Show example in

Request Body Example

{
  "number": "447777777771",
  "PAC": "ABC12345",
  "portinNumber": "447777777772",
  "portinDate": "20190129"
}

json

Example Responses

No example

json

application/json

Porting - Request PAC

POST

https://api.onsimapp.com

/port/pac/{mpn}

Porting - Request PAC › path Parameters

mpnstring · required
MPN you wish to port and obtain a PAC Code

Porting - Request PAC › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Porting - Request PAC › Responses

PAC Request Response

pac_requestobject
PAC Request Info
Example: {"port_id":12345,"status":"INITIAL"}

POST /port/pac/{mpn}

curl --request POST \
  --url https://api.onsimapp.com/port/pac/:mpn \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json