VeloeSIM quick start

Use the wholesale API to list plans, check your organization balance, purchase eSIMs, and buy top-ups.

Connect and authenticate

The GitHub reference uses this base URL:

https://api.veloesim.com:2053

Send your wholesale API key in the Authorization header, including the literal Apikey prefix:

In Apidog's VeloeSIM endpoint authentication, set veloesimApiKey to your own key. In generated examples, replace the placeholder locally. The wholesale API uses a different authentication value from VeloConnect or VeloVerify.

Read before purchasing

Call GET /api/wholesale/organizations to read the organization name and balance.

Call GET /api/wholesale/plans to find a plan. For multiple area IDs, repeat the query key: areaIds=5&areaIds=151.

Select a returned plan ID for the purchase request.

Read-only example:

curl 'https://api.veloesim.com:2053/api/wholesale/plans?limit=6&offset=0&areaIds=5&areaIds=151' \
  --header 'Authorization: Apikey YOUR_API_KEY'

List calls return count and rows. The source does not specify pagination defaults or maximum sizes. Use explicit limit and offset values appropriate for your integration.

Purchase and install

POST /api/wholesale/orders purchases an eSIM plan. Its JSON body requires planId:

{"planId": 2604}

Optional customerEmail assigns the plan to that customer, creates a VeloeSIM user, and sends the customer a password for the application. customerFullName is optional.

The documented response contains iccid, iosSetup, matchingId, smdpAddress, profileStatus, installedAt, and assignedPlans. Use the returned installation details for that eSIM. Keep ICCIDs as strings so their full value is preserved. Assigned-plan quantities are explicitly in bytes.

Read an eSIM and buy a top-up

Use GET /api/wholesale/esims to list organization eSIMs and GET /api/wholesale/esims/{iccid} to read one.

Retrieve available top-up plans with GET /api/wholesale/esims/{iccid}/top-up.

Select a returned plan ID.

Send POST /api/wholesale/esims/{iccid}/top-up with {"planId": 1} using the selected ID.

Both POST calls purchase service. The source does not document idempotency or retry guarantees; resolve an uncertain purchase outcome before repeating it.

Reference limitations to confirm

getOnePlan appears in the contents, but has no endpoint description, request, or response. It is not included in this draft.

GET top-up plans lists planId as mandatory in its input table but omits it from the request example and does not specify its location. The draft follows the example and flags this unresolved input.

The areaNames and areaRegions descriptions appear reversed in the source. Names are preserved; verify the matching behavior before relying on these filters.

HTTP response status codes, error bodies, rate limits, currency, plan dataAmount/duration units, and the non-null type of installedAt are not specified. No values or error contracts have been invented.

Response schemas describe the supplied JSON examples. They do not assert backend field requiredness or a complete runtime contract. Examples are illustrations, not live pricing or inventory.

The public /api/data-plans catalog is outside this wholesale reference.

VeloeSIM quick start

Connect and authenticate#

Read before purchasing#

Purchase and install#

Read an eSIM and buy a top-up#

Reference limitations to confirm#

Connect and authenticate

Read before purchasing

Purchase and install

Read an eSIM and buy a top-up

Reference limitations to confirm