API Reference

You can find the Quick Reference for Global IoT Orchestration API Endpoints to help you manage Verizon US eSIM profiles and the global (local carrier) eSIM profiles here. You must first activate a Verizon US eSIM profile before downloading and enabling a global eSIM profile as outlined below:

See the table for a list of APIs for managing both Verizon US (lead carrier) eSIM profiles and global (local carrier) eSIM profiles. Please note that Verizon US eSIM profiles must be bootstrapped to the IoT devices and cannot be deleted from the IoT devices.

 

✔ = Supported

N/A = Not applicable

API

Verizon US eSIM Profile

Global eSIM Profile

HTTP Request

Bulk Operation Support
API

Activate/Reactivate a Global eSIM Profile

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /devices/profile/actions/activate

 Bulk Operation Support

✔
API

Download a Global eSIM profile

 Verizon US eSIM Profile

N/A

 Global eSIM Profile

✔

 HTTP Request

POST /devices/profile/actions/download

 Bulk Operation Support

✔
API

Enable a Global eSIM Profile

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /devices/profile/actions/enable

 Bulk Operation Support

✔
API

Download_Enable a Global eSIM Profile

 Verizon US eSIM Profile

N/A

 Global eSIM Profile

✔

 HTTP Request

POST /devices/profile/actions/download_enable

 Bulk Operation Support

✔
API

Deactivate a Global eSIM Profile

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /devices/profile/actions/deactivate

 Bulk Operation Support

✔
API

Delete a Global eSIM Profile

 Verizon US eSIM Profile

N/A

 Global eSIM Profile

✔

 HTTP Request

POST /devices/profile/actions/delete

 Bulk Operation Support

✔
API

Suspend a Global eSIM profile

 Verizon US eSIM Profile

N/A

 Global eSIM Profile

✔

 HTTP Request

POST /v1/devices/profile/actions/profile_suspend

 Bulk Operation Support

✔
API

Resume a Global eSIM Profile

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /v1/devices/profile/actions/profile_resume

 Bulk Operation Support

✔
API

Suspend a Global eUICC Device

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /v1/devices/profile/actions/device_suspend

 Bulk Operation Support

✔
API

Resume a Global eUICC Device

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /v1/devices/profile/actions/device_resume

 Bulk Operation Support

✔
API

Change the eSIM Profile Service Plan 

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /v1/devices/profile/actions/serviceplan

 Bulk Operation Support

✔
API

Send an SMS Message to Devices

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /sms

 Bulk Operation Support

✔
API

Start an SMS Callback

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

PUT /sms/{accountName}/startCallbacks

 Bulk Operation Support

✔
API

Get SMS Messages

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

GET /sms/{accountName}/history

 Bulk Operation Support

✔
API

Retrieve SMS Event History

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /devices/sms/history/actions/list

 Bulk Operation Support

N/A
API

Retrieve the Global Device List

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /v2/devices/actions/list

 Bulk Operation Support

✔
API

Retrieve Device Provisioning History

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

POST /v2/devices/history/actions/list

 Bulk Operation Support

N/A
API

Get the Status of an Asynchronous Request

 Verizon US eSIM Profile

✔

 Global eSIM Profile

✔

 HTTP Request

GET /v2/accounts/{accountName}/requests/{requestID}/status

 Bulk Operation Support

N/A