Purchases and assigns an eSIM with a specific data plan to a licensed user. This endpoint combines product purchase and eSIM provisioning in a single operation, returning a transaction ID to track the activation status.

Purpose

• Purchase data plans for specific licenses
  
• Provision new eSIMs with selected products
  
• Assign eSIMs to registered users/devices
  
• Enable immediate connectivity for licensed entities
  

Prerequisites

1. Valid license created via License Activation API
2. License CLI obtained from Activation Transaction Status
3. Product ID from the Products endpoint

Request

• Method: POST
  
• URL: https://api.bnesim.com/v2.0/enterprise/simcard/add-esim
  
• Content-Type: multipart/form-data
  
• Authentication: Bearer token required
  

Parameters

• license_cli (Required): Customer Line Identifier of the target license
  • Obtained from Activation Transaction Status endpoint
    
  • Identifies which license will receive the eSIM
    
  • Format: Numeric string (e.g., "123456789")
    
• product_id (Required): ID of the data plan to purchase
  • Obtained from Products endpoint
    
  • Determines data volume, validity, and pricing
    
  • Must be available in the target region
    
• scheduled_activation_date (Optional): scheduled date to activate the eSIM
  

Response

• success: Boolean indicating if the request was successful
  
• activationTransaction: Transaction ID for tracking eSIM activation
  • Use with Activation Transaction Status endpoint
    
  • Required to retrieve eSIM details (ICCID, QR code, etc.)
    

Activation Workflow

1. Select a product using the Products endpoint
2. Call this endpoint with license_cli and product_id
3. Save the returned activationTransaction ID
4. Check status using Activation Transaction Status endpoint
5. Once activated, retrieve eSIM details using Simcard Detail endpoint

Example cURL

curl --request POST \
     --url https://api.bnesim.com/v2.0/enterprise/simcard/add-esim \
     --header "accept: application/json" \
     --header "authorization: Bearer {{bearerToken}}" \
     --header "content-type: multipart/form-data" \
     --form license_cli={{license_cli}} \
     --form product_id={{product_id}}

Important Notes

• The eSIM is automatically provisioned upon successful activation
  
• Billing occurs immediately upon successful request
  
• Multiple eSIMs can be assigned to a single license (check account limits)
  
• The activation process typically completes within seconds
  
• Failed activations will not result in charges
  
• Product availability depends on the target region/country

Errors

Errors are returned with HTTP 200 and success: false, plus a translation_key and an UPPER_CASE error_code you can branch on: