Web On-Prem Documentation


Please note that IPass On-Prem operates as a connected container and requires an active internet connection at all times for proper functionality.


How to add and activate your license.

After successfully completing Step 1, you will need to add and activate your license. To do this, open the frontend URL in your browser, which will automatically direct you to the upload license page.

How to create a user.

After uploading your license successfully, you must create a customer account to log in and use the system. You will be redirected to the create customer form after the license upload.

How to use the api's.

To execute the web APIs, please refer to the instructions below.

Click the button to view the list of APIs Api Documentation

Everything else will remain the same; you only need to replace the base URL with your on-prem backend URL e.g (your domain or IP/node/api/v1/ipass/create/authenticate/login) when executing the APIs. Please note that these APIs must be executed in Postman, as they cannot be executed in Swagger.

Possible error you will face in api's

If you encounter the error message "License not found" or "Please activate your license", you need to upload your license through the upload license page on the frontend. To access this page, simply open the frontend URL, and it will direct you to the upload license page which is already mentioned above.

If you encounter the error message "License expired" or "You have exceeded the transaction limit," you need to upload a new license.

Steps to upload new License-

1.Log in to your iPass dashboard.

2.Navigate to the My Profile section(located in the top-right corner).

3.Click the Edit button and upload the new license in the designated field and click on save the license is updated.