API Reference

Complete API documentation

API Reference

Complete reference documentation for CS Vault APIs

Base URL
All API requests should be made to the following base URL:
https://api.esm.mobi/v1
Authentication
CS Vault APIs use API keys for authentication. Include your API key in the header of each request.
Authorization: Bearer YOUR_API_KEY
Learn more about authentication

Endpoints

List eSIMs
GET
Returns a list of all eSIMs associated with your account.
/esims
Create eSIM
POST
Creates a new eSIM profile.
/esims
Get eSIM
GET
Retrieves details of a specific eSIM profile.
/esims/{esim_id}
Update eSIM
PUT
Updates an existing eSIM profile.
/esims/{esim_id}
Delete eSIM
DELETE
Deletes an eSIM profile.
/esims/{esim_id}
Activate eSIM
POST
Activates an eSIM profile.
/esims/{esim_id}/activate
View detailed documentation
Deactivate eSIM
POST
Deactivates an eSIM profile.
/esims/{esim_id}/deactivate
List Data Plans
GET
Returns a list of available data plans.
/data-plans
Get Data Plan
GET
Retrieves details of a specific data plan.
/data-plans/{plan_id}
Get Usage
GET
Retrieves usage information for a specific eSIM.
/esims/{esim_id}/usage

Response Formats

Success Response
All successful responses follow this format:
{
  "success": true,
  "data": {
    // Response data here
  }
}
Error Response
All error responses follow this format:
{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "Human-readable error message",
    "details": {
      // Additional error details (optional)
    }
  }
}

Rate Limits

API Rate Limits
CS Vault APIs implement rate limiting to ensure fair usage and system stability.

Rate limits are applied on a per-API key basis. The current limits are:

  • 100 requests per minute for standard endpoints
  • 20 requests per minute for resource-intensive endpoints (e.g., eSIM creation)

Rate limit information is included in the response headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1620000000
Learn more about rate limits