Karlsgate Identity Exchange (KIE) User Guide

Getting started

Getting started

Using the Karlsgate Identity Exchange (KIE) requires the following steps:

  1. Register for an account on the Karlsgate Identity Exchange (KIE) Portal
  2. Install the Karlsgate Identity Exchange (KIE) node software (aka. node) [root access in the installation environment may be required]
  3. Activate your node (only required once per node) [the activating user must have the Node Manager user role]
  4. Create a listing (or multiple listings) on your node
  5. Make a trade using the KIE Portal

These summarized steps are detailed here (below) and in subsequent sections of this user guide.

Create a user account

Visit the Karlsgate Identity Exchange (KIE) Portal to register for your user account. To register, you will need to provide your name, your email address, and a password.

Register user account

To register for a user account, join the exchange by clicking here.

Confirm user account

Using the confirmation email message that you receive, please confirm your email address. The email message you receive will contain a hyperlink for you to confirm your email address. (Your user account will not be ready for use until you have confirmed your email address.)

Create/associate member account

If you are the first person registering for an account with your organization, then you will need to supply a member name plate. (A name plate allows you to establish your organization's identity to potential trading partners. A company's name is commonly used as the name plate's value.)

NOTE: If your organization already has a member account with Karlsgate, then please send an email message to the Karlsgate Support team (help@karlsgate.com) to associate your new user account with your organization's existing member account.

Invite your colleague (or a trading partner)

You may invite your colleagues, or potential trading partners, by sending each of them an email invitation directly from the Karlsgate Identity Exchange (KIE) Portal. Some appropriate colleagues to invite might be an IT coordinator who will be installing the KIE node software as well as helping to create a listing or a trade manager who will be managing trades via KIE.

To invite a colleague to your own member account, do the following:

  1. choose the Invitations option under Membership (main menu: Membership → Invitations) and press the Add invitation button;
  2. enter your colleague's email address;
  3. choose the "user to my membership" invitation type; and,
  4. press the Create invitation button.

It is recommended to use your colleague's organization email address (i.e., work email address).

To invite a potential trading partner to join KIE as a separate member, do the following:

  1. choose the Invitations option under Membership (main menu: Membership → Invitations) and press the Add invitation button;
  2. enter the email address of a user at the trading partner;
  3. choose the "trading partner" invitation type; and,
  4. press the Create invitation button.

Be sure to communicate your intention to invite the trading partner before doing so.

All sent invitations expire in 10 calendar days. After an invitation has expired, a new invitation must be sent to your colleague (or trading partner).

If you have any questions, please contact the Karlsgate Support team (help@karlsgate.com) regarding user account support for your organization's member account.

Install a Karlsgate Identity Exchange (KIE) node

Once your IT coordinator is registered and linked to your member account, please visit the Installing a node page for details on how to install a new node. The referenced help provides detailed information (e.g., system requirements, installation options and command-line syntax for the creation & management of listings).

Prepare your KIE node (Quick Test installation)

We recommend the Quick Test installation for learning the system and scenarios without administrator access to the server.

Choose the Quick Test installation command, below, for your operating system:


In the Linux shell, paste the following command:

/bin/bash <(curl -s https://portal.karlsgate.com/scripts/quickstart-linux.sh) && source ~/.profile 2>/dev/null || source ~/.bash_profile 2>/dev/null

In the MacOS terminal, paste the following command:

/bin/bash -c "$(curl -fsSL https://portal.karlsgate.com/scripts/quickstart-osx.sh)"

In the Windows 10 command prompt, paste the following command:

curl -O https://portal.karlsgate.com/scripts/quickstart-windows.cmd && .\quickstart-windows.cmd

You can relaunch the Quick Test script by rerunning the above command from your Linux, MacOS, or Windows terminal. This will also retry a failed installation.

  • To stop the running process, press: Ctrl+C.
  • To relaunch the process, execute the kie node run command.

Please note that the Quick Test installation is intended to demonstrate trading functionality and to inspect the software for information security (InfoSec) purposes only. To test a trade, we have an automated trading account, named SampleBot, available to trade using the sample file provided as part of the Quick Test installation. If you have any questions or would like to schedule a demonstration, please contact the Karlsgate Support team (help@karlsgate.com).

Please note that the Quick Test is not intended for production use as this version of the software will not remain online nor be kept up to date with the latest feature enhancements.

Remove your KIE node (uninstall Quick Test)

Once you have completed your testing using the Quick Test installation, we recommend uninstalling this test version of the software. This makes sure that this test version of the node software does not remain your system, which due to regular feature updates will become out of date. This will also help clear your system of unwanted test-related artifacts (e.g., sample files).

To uninstall the Quick Test installation, paste and execute the following command (any operating system):


Please note that since the Quick Test installation may be performed without administrator (or root) access, it may be necessary to perform the Quick Test uninstallation using the full path of the uninstall command. For Linux/MacOS, this may be: ~/kie/bin/kie-uninstall.sh, and for Windows it may be: %LocalAppData%\Karlsgate\kie\kie-uninstall.cmd (The actual full paths for the uninstall command are specific to each environment & Quick Test installation and may be different than the full path values shown here.) Note, the Quick Test uninstall command should not be executed from within the folder containing the uninstall command itself, since that folder is also removed.

For a non-testing version of the node software, use one of the installation methods available for the production version of the node software (see below).

View complete KIE node install guide

For additional information on how to install the node software for production use, visit the Installing a node page.