Skip to main content

Getting Started

Account Access Required: BranchKey accounts are currently provisioned by our team. If you do not have an account, please contact us to request access.

You can interact with the BranchKey platform in two ways:

  1. Web Application (Dashboard link in navbar) - Recommended for initial setup
  2. REST APIs (API Reference links in navbar) - For programmatic integration

This guide walks through creating a federation using both approaches.

Note: UI screenshots in this guide may not reflect the latest interface. The web application provides the simplest setup experience.

Invited to a shared resource?​

If you have been issued an account and invited to a shared resource (tree or branch), some of these quick start points may not apply to you. You can simply login and directly access these shared resources, and participate in already active federated algorithms.

You can skip directly to:

  1. Docker Client Template: A template guide on getting a docker container connected to the BranchKey deployment.
  2. Platform Overview: An overview of the BranchKey entities and other useful information.