Catalogue
Packages for every country and region in your catalogue, each with its data allowance, validity and price for your account.
eSIMify Partners API
Sell travel eSIMs inside your own app or website. One API to list packages, place orders, deliver eSIMs and top up data.
Next steps
Section titled “Next steps”1. Get partner accessRegister in the Business portal, or tell us about your business and we set up your partner account.
2. Create a test keyIn the Business portal, under Developers. It works in the sandbox straight away.
3. Follow the Quick StartFind a package, place an order, deliver the eSIM, top it up and receive a webhook.
4. Test, then go liveRun the sandbox test plan and the checklist, then switch to your live key.
What you can build
Section titled “What you can build”Orders
Buy one eSIM or up to 50 in a single call. Every order is safe to retry, so a timeout never charges you twice.
eSIMs and top-ups
QR code, one-tap install links and activation details for delivery, data usage, and top-ups on the eSIM your customer already has.
Webhooks
Be told when an order completes, an eSIM is activated, data is running low or your balance needs attention.
Guides
Section titled “Guides”Integration patternsBook then issue, processing orders, reconciliation and retries.
SandboxVirtual balance, failure triggers and simulated eSIM events.
WebhooksEvents, signature checks in Node, PHP and Python, and retries.
Errors & rate limitsEvery error code, idempotency rules and limits.
SecurityKeys, IP allowlists, rotating secrets and what is logged.
FAQStraight answers to common questions.
Reference
Section titled “Reference”API v1 overviewBase URL, authentication, pagination, money, time and identifiers.
ObjectsEvery field of Package, Order, Esim, Topup, Event and Error.
OpenAPI descriptionThe API as an OpenAPI 3.1 file.
Postman collectionEvery endpoint, ready to run against the sandbox.
Postman environmentThe two variables the collection needs: your base URL and your test key.