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
Activate/Reactivate a Global eSIM Profile	✔	✔	POST /devices/profile/actions/activate	✔
Set Fallback Attributes	✔	✔	POST /devices/profile/actions/setfallbackattribute	N/A
Retrieve Account Information	✔	✔	GET /accounts/{accountName}	✔
Retrieve the List of Service Plans	✔	✔	GET /plans/{accountName}	✔
Download a Global eSIM profile	N/A	✔	POST /devices/profile/actions/download	✔
Enable a Global eSIM Profile	✔	✔	POST /devices/profile/actions/enable	✔
Download_Enable a Global eSIM Profile	N/A	✔	POST /devices/profile/actions/download_enable	✔
Deactivate a Global eSIM Profile	✔	✔	POST /devices/profile/actions/deactivate	✔
Delete a Global eSIM Profile	N/A	✔	POST /devices/profile/actions/delete	✔
Suspend a Global eSIM profile	N/A	✔	POST /v1/devices/profile/actions/profile_suspend	✔
Resume a Global eSIM Profile	✔	✔	POST /v1/devices/profile/actions/profile_resume	✔
Suspend a Global eUICC Device	✔	✔	POST /v1/devices/profile/actions/device_suspend	✔
Resume a Global eUICC Device	✔	✔	POST /v1/devices/profile/actions/device_resume	✔
Change the eSIM Profile Service Plan	✔	✔	POST /v1/devices/profile/actions/serviceplan	✔
Send an SMS Message to Devices	✔	✔	POST /sms	✔
Start an SMS Callback	✔	✔	PUT /sms/{accountName}/startCallbacks	✔
Get SMS Messages	✔	✔	GET /sms/{accountName}/history	✔
Retrieve SMS Event History	✔	✔	POST /devices/sms/history/actions/list	N/A
Retrieve the Global Device List	✔	✔	POST /v2/devices/actions/list	✔
Retrieve Device Provisioning History	✔	✔	POST /v2/devices/history/actions/list	N/A
Get the Status of an Asynchronous Request	✔	✔	GET /v2/accounts/{accountName}/requests/{requestID}/status	N/A
Retrieve Daily Usage	✔	✔	POST /devices/usage/actions/list	N/A
Retrieve Aggregate Usage	✔	✔	POST /devices/usage/actions/list/aggregate	N/A