The branding API described below allows you to brand Hosted Authentication-related material (company logo, header, footer,etc.) using canned code.


  • IT Billable set-up must be selected.
  • Allow Self-Registration must be enabled.
  • Allowed Email Domains must be specified.

For more details on fulfilling the perquisites listed above, please contact Customer Care.

1. Include the iPass Javascript library in the header section.

  <script type="text/javascript" src=""></script>

2. Include the attribute ipass-data in the input element of the form. For self-registration, the following fields are mandatory:

  • First Name: ipass-data=”firstName”
  • Last Name: ipass-data=”lastName”
  • Username: ipass-data=”username”
  • Email: ipass-data=”email”
  • CompanyId: ipass-data=“companyId”
Make the companyId field “hidden,” if you do not want users to see it.
<form id="register_form">


  <input type="hidden"size="20"ipass-data="companyId" value="001"/>

3. Create an event handler which listens to an onclick event on the button or onsubmit event on the form.

  <button type="submit"onclick="doRegister()"SignOn</button>

4. Inside the event handler, call iPass register function and pass the id of the form and name of the callback function, like responseHandler as show in the example.

    Ipass.register("register_form", responseHandler);

5. Declare the callback function. The response from iPass will be passed to the response argument.

function responseHandler(response){
         if (response.success){
                var errorMsg = ";
                for (var i=0;<response.error.length;i++){
                         errorMsg = errorMsg + response.error[i].errorCode+';';
                alert('errorMsg = ' + errorMsg);

Response in XML format:

In successful case:


In failed case:

                       <message>Sorry! The email is already taken.</message>

In case of failure, the error information will be contained in an error element which includes an errorCode, fieldName, and message of the error. Based on errorCode, you can customize your error message. The following is the list of errorCode options:

  • InvalidCharsFName
  • InvalidCharsLName
  • InvalidCharsEmail
  • InvalidFormatEmail
  • MaxCharsFName
  • MaxCharsLName
  • MaxCharsEmail
  • MaxCharsUsername
  • MaxCharsDepartmentCode
  • MinCharsEmail
  • MinCharsUsername
  • EmailUnavailable
  • EmailAlreadyRegistered
  • UsernameMultipleAt
  • FirstnameNotPresent
  • LastnameNotPresent
  • EmailNotPresent
  • UsernameNotPresent
  • CompanyNotPresent
  • CompanyNotFound
  • SelfRegistrationNotAllowed
  • NoDomainConfiguredCompany
  • UnknownError

Go to: Portal Home > REST API Overview


©2015 iPass Inc. All rights reserved. Terms of Use