# XYB Console - Quick Start Guide

The **XYB Console** is your central workspace for building and operating financial products. It provides a visual interface for managing services, configuring product behavior, defining workflows, and assigning roles.

{% hint style="info" %}
**Note:** This guide is for **product managers** and **operators** using the Console UI. If you're a developer working directly with APIs, refer to the [XYB API Reference](https://app.gitbook.com/s/GQM0YMMfucakXc0QJuEq/apis-and-events).
{% endhint %}

### Parts of the Console

XYB Console provides a set of **general features** available to all users and **core service areas** like **ledger, accounts, payments**, or **credit** that are provisioned based on your business needs.

Click on the tabs below to learn more about each part of the Console.

{% tabs %}
{% tab title="Product Configuration" %}
The product configuration layer in the Console lets you define not just what the product is, but also how it behaves throughout its lifecycle. You can:

* **Create offerings** like current accounts, savings products, or revolving credit lines, tailored to customer segments.
* **Predefine key settings** such as supported currencies, interest or fee structures, transaction limits, and more so you can deploy at scale with consistency.
* **Link core services** like ledger behaviors, coordinate types, and account states directly into product blueprints to automate financial operations.

[Learn more about Product Configuration.](https://docs.xyb.co/xyb-console/product-configurations)
{% endtab %}

{% tab title="Entities" %}
Entities represent the core actors in your product ecosystem, such as customers, businesses, partners, and owners. In XYB, every financial relationship, transaction, or product is tied to an entity.

* **Classify Entity Types**: Set up different entity roles like **Customer**, **Business**, **Partner**, or **Owner** based on their relationship to your financial product.
* **Capture Core Identity Data**: Define required fields including names, personal or business identification (e.g., national ID, SSN), date of birth, contact details, and more.
* **Segment by Sector and Use Case**: Tag entities by **sector** (e.g., fintech, retail) and **segment** (e.g., SMB, enterprise) to tailor product offerings and workflows.

[Learn more about entities](https://docs.xyb.co/xyb-console/understanding-entities-in-xyb).
{% endtab %}

{% tab title="Workflows" %}
The workflow engine in the Console allows you to design and automate operational processes across your financial stack. You can:

* **Build workflows** for tasks like customer onboarding, identity verification, fund transfers, or payment approvals, reducing manual overhead.
* **Define custom logic** and business rules that trigger based on system events, user actions, or external inputs.
* **Connect internal systems** and third-party tools using configurable steps and conditions to orchestrate processes end-to-end.

[Learn more about workflows.](https://docs.xyb.co/xyb-console/workflow-management)
{% endtab %}

{% tab title="Access Management" %}
The access control layer in the Console helps you manage who can do what across your environments. You can:

* **Define roles and permissions** for team members based on responsibilities and environments (e.g., sandbox or production).
* **Apply fine-grained access controls** across services, product configurations, and operational workflows.
* **Manage API keys** and secure integrations with third-party systems using built-in tooling.

[Learn more about Access Management.](https://docs.xyb.co/xyb-console/access-and-permissions-overview)
{% endtab %}
{% endtabs %}

### Console Set Up

Check out the video and detailed steps to understand how to set up the Console for your team.

{% embed url="<https://www.canva.com/design/DAGtyuptH8k/HUjVIAi34jdYpmLuxvFo9Q/watch>" %}

#### 1. Assign Roles and Permissions

When your Console is first provisioned, the **super admin** receives login credentials. This user is responsible for:

* [Accessing the Console](https://docs.xyb.co/xyb-console/access-and-permissions-overview/access-management-dashboard)
* [Creating and managing employee accounts](https://docs.xyb.co/manage-employees-roles-and-permissions)
* [Assigning roles and setting permissions](https://docs.xyb.co/manage-employees-roles-and-permissions/create-roles-with-permissions)

{% hint style="info" %}
Roles can be assigned at various scopes per service, per environment (e.g., sandbox, production), or by workflow. Use the Access and Permissions Matrix to define access levels for teams managing services, workflows, or product areas.
{% endhint %}

***

#### 2. Verify Available Services

Next, confirm that the services you’ve opted into are active in your Console. To do this:

* Navigate to **Product Configuration < Services**
* Review the list of available modules
* Typical services include:
  * [**Accounts**](https://docs.xyb.co/core-banking-components/account-creation-and-management)
  * [**Ledger**](https://app.gitbook.com/o/ejR7mr9SHYUkyGo7EVhT/s/akJn6TxWIBAbZwLlYoVP/)
  * [**Entities**](https://docs.xyb.co/xyb-console/understanding-entities-in-xyb)
  * [**Product Configuration**](https://docs.xyb.co/xyb-console/product-configurations)

Each service can be customized and integrated into your products. Once configured, those service settings are inherited by all products that use them.

***

#### 3. Create Products with linked Services and Entities

After roles and services are in place, begin designing your business architecture.

* [**Create entities:**](https://docs.xyb.co/xyb-console/understanding-entities-in-xyb) These represent your customers, business units, or legal entities.
* [**Define financial products**](https://docs.xyb.co/xyb-console/product-configurations)**:** Set up offerings such as savings accounts, credit lines, or payment wallets.
* [**Configure workflows:**](https://docs.xyb.co/xyb-console/workflow-management) Automate processes like onboarding, verification, fund transfers, or approvals using the Workflow Builder.

***

#### 4. Monitor and Operate in Real Time

Once your products are launched, financial operators can use operational view to stay in control of daily activities:

* **Track Core Metrics**: [Monitor account balances](https://app.gitbook.com/s/GQM0YMMfucakXc0QJuEq/account-management), [ledger postings](https://app.gitbook.com/s/akJn6TxWIBAbZwLlYoVP/integrate-with-xyb-ledger/set-up-transaction-workflows/create-and-manage-postings), transaction histories, repayment statuses, and more in real time.
* **Access Operational Dashboards**: Use [prebuilt and customizable views ](https://app.gitbook.com/s/GQM0YMMfucakXc0QJuEq/account-management/managing-account-lifecycle-in-xyb)to review service activity, customer behavior, and financial performance.
* **Perform Manual Adjustments**: [Make operational entries when needed ](https://app.gitbook.com/s/akJn6TxWIBAbZwLlYoVP/ledger-use-case-and-operations)(e.g., balance corrections, backdated ledger movements) in line with permissions and audit controls.

### Additional Information

The XYB Console also supports **orchestration workflows** to simplify multi-step configurations. These orchestration flows allow you to:

* Automate the setup of products and services
* Pre-define rules, templates, and activation steps
* Launch preconfigured product bundles quickly

Check out the video below to understand how you can create and manage products using orchestration tools.

{% embed url="<https://youtu.be/2vZHc63Kcsk?si=qV6b_l_jiekKRY7Z>" %}

### Also check out:

{% content-ref url="../xyb-console/product-configurations" %}
[product-configurations](https://docs.xyb.co/xyb-console/product-configurations)
{% endcontent-ref %}

{% content-ref url="../xyb-console/understanding-entities-in-xyb" %}
[understanding-entities-in-xyb](https://docs.xyb.co/xyb-console/understanding-entities-in-xyb)
{% endcontent-ref %}

{% content-ref url="../xyb-console/workflow-management" %}
[workflow-management](https://docs.xyb.co/xyb-console/workflow-management)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.xyb.co/overview/xyb-console-quick-start-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
