Skip to main content
Use this endpoint to deliver eSIM activation PDFs to your customers. Pass type=email to send directly to an email address, or type=link to receive a download URL you can share however you like. 
POST https://bpm.mioesim.com/api_esim/handlerEsimPdf

​
Request parameters

​
token
string
required
Session token.
​
type
string
required
"email" = send to email address; "link" = return download URL.
​
orderId
string
required
Order number.
​
sign
string
required
Request signature.
​
iccids
string
Specific ICCID(s) to include, comma-separated. Leave empty to include all cards in the order.
​
email
string
Destination email address (required when type=email).
​
saveType
integer
1 = save this email address to the order (replaces existing). 0/empty = don’t save.

​
Response

When type=link, data is a map of ICCID → PDF URL: 
{
  "code": "0",
  "message": "Successful return of pdf link",
  "data": {
    "9000024041590216": "http://img.mioesim.com/phoneImage/202404//5072a173.pdf",
    "9000024041549678": "http://img.mioesim.com/phoneImage/202404//1852e23a.pdf"
  }
}
When type=email, data is null on success: 
{ "code": "0", "message": "PDF has been sent to the email", "data": null }

​
Example

curl -X POST https://bpm.mioesim.com/api_esim/handlerEsimPdf \
  -d "token=YOUR_TOKEN" \
  -d "type=link" \
  -d "orderId=EP20240124000013" \
  -d "sign=YOUR_SIGN"

​
Error codes

CodeMeaning
-1Token expired
-2Required parameter missing
4Order status abnormal
99PDF generation or delivery failure
-30Signature wrong