This documentation provides detailed information about the available API endpoints.
eSIM Management encompasses the full suite of tools and processes needed to control and maintain eSIM profiles and their associated data plans. This includes essential features like creating, deleting, and updating eSIMs, as well as managing their data plans.
An order represents a request for an eSIM and data plan. Orders contain details about the customer, the selected plan, and the eSIM activation process.
Orders can be rejected due to invalid plan selections, fraudulent requests, or incompatible eSIM devices. The rejection feature ensures that only valid orders proceed to activation.
Users can track order status from "pending" to "completed," with intermediate states like "inprogress" or "rejected." This allows for better order management and transparency.
For authentication,The Bearer token should be sent as a bearer tokens in the Authorization header of the request. Create account.
API endpoint:
Description:
Use this endpoint to get the eSIM list.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esims' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
API endpoint:
Description:
Use this endpoint to get the eSIM.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_id | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to delete the eSIM.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_iccid | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to update the eSIM.
Request example:
curl --location --request PATCH 'https://api.simvox.com/v1/esim/{esim_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"network_status": "active"
}'
| Parameter | Type | Description |
| esim_iccid | Required string | Unique ID of eSIM |
| network_status | Required string | Network Status |
API endpoint:
Description:
Get the Data Plans currently attached to an eSIM, including data usage for each Data Plan.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/{esim_id}/plans' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_id | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to get the topup list for esim
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/topups/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_id | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to delete the eSIM plan.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/plans/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_iccid | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to get the eSIM.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_id | Required string | Unique ID of eSIM |