> For the complete documentation index, see [llms.txt](https://docs.xyb.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xyb.co/xyb-platform-1/accounts/getting-started-with-accounts/planning-your-account-structure-and-setup/accounts-quick-start-guide.md).

# Accounts Quick Start Guide

This article walks through the **entire customer experience** with XYB's Accounts capabilities—from setup to production. It includes touchpoints across the hosted developer environment, APIs, and the configuration console.

***

#### 1. Starting Point: Access to the Platform

As a customer of XYB:

* You are onboarded into a **hosted developer environment**, with secure access to:
  * **API credentials and sandbox URLs**
  * A **web console** for **product configuration**

You receive a **fully isolated instance** with the capability to configure and simulate the full account lifecycle.

***

#### 2. Product Configuration (via Console)

**What happens:**

You define **account products** through the **Product Configuration Console**.

**Key actions:**

* Create **account product definitions** (e.g., "Retail GBP Account", "FX Wallet")
* Assign:
  * Default currency
  * Supported jurisdictions
  * Initial state
  * Optional flags like "silent statement push"
* Link accounts to services (e.g., balance management, account rules)

Interface used:

* **Products tab** in the Console: define names, references, descriptions.
* **Services tab**: attach service behavior (e.g., wallet rules, lifecycle rules).
* **Schema Builder**: customize metadata, tags, or compliance rules.

Outcome:\
This product becomes **the template** for account creation via API or UI.

***

#### 3. API Integration: Account Lifecycle

After configuration, you begin integrating with XYB’s **Accounts APIs**.

**Use cases:**

* Create new accounts
* Fetch accounts by ID or owner
* Attach banking coordinates (like IBANs)
* Query live balances or statements

 **Typical flow:**

<table><thead><tr><th width="108.2274169921875">Step</th><th>API Action</th><th>Description</th></tr></thead><tbody><tr><td><strong>1</strong></td><td><code>POST /account</code></td><td>Create a new account for a user using a configured product</td></tr><tr><td><strong>2</strong></td><td><code>GET /account/{id}</code></td><td>Retrieve full account details</td></tr><tr><td><strong>3</strong></td><td><code>PATCH /account/{id}/attributes</code></td><td>Add metadata like tax tags, product overrides</td></tr><tr><td><strong>4</strong></td><td><code>POST /account/{id}/coordinates</code></td><td>Attach internal or banking coordinates</td></tr><tr><td><strong>5</strong></td><td><code>GET /account/{id}/wallets</code></td><td>Fetch real-time balances</td></tr><tr><td><strong>6</strong></td><td><code>POST /account/{id}/state</code></td><td>Change state (e.g. block, close) with audit trail</td></tr></tbody></table>

***

#### 4. Real-Time Monitoring & Testing

As a developer or product owner:

* You test your integration in **XYB's sandbox** environment.
* Use tools like:
  * **Query explorer** in the Console
  * **Transaction simulators**
  * **Schema validation checks**
* API responses include:
  * Account UUIDs
  * Wallet balance snapshots
  * Audit logs and timestamps

You can simulate full flows like account blocking, attribute changes, or balance sweeping via test hooks.

***

#### 5. Account States, Rules & Governance

Accounts support a **comprehensive lifecycle**:

| State                   | Use case                                          |
| ----------------------- | ------------------------------------------------- |
| `PENDING`               | Initial creation                                  |
| `OPEN`                  | Account is usable                                 |
| `SUSPENDED_IN/OUT`      | Temporarily frozen for incoming or outgoing funds |
| `BLOCKED`               | Restricted due to compliance or fraud             |
| `CLOSED` / `TERMINATED` | Final state after deactivation                    |

You define **rules and status transitions** in the Console (e.g., “when UNDERAGE, map to SUSPENDED”).

All transitions are API-triggered and audited. Some require **approval workflows** if configured.

***

#### 6. Advanced Features: Wallets & Sweeping

Every account has:

* One or more **wallets** (currency-specific balance holders)
* Support for:
  * **Live balances** (`/wallets`)
  * **Global consolidated balances** (`/wallets/gcb`)
  * **Sweeping rules** to automate fund movement across wallets

Customers can:

* Configure rules for wallet prioritization (e.g., auto-drain secondary balances)
* View balance composition via wallet APIs
* Manage sweeping via APIs or backend logic

***

#### 7. Moving to Production

Once tested:

* You switch to **live environment endpoints**
* XYB enables:
  * Access control and role-based permissioning
  * Secure certificate handling for production
  * Rate limits, SLAs, and logging

All product configurations carry over—no need to redefine products.

***

#### Summary: End-to-End Experience

| Stage         | Customer Touchpoint           | Purpose                                      |
| ------------- | ----------------------------- | -------------------------------------------- |
| Kickoff       | Hosted developer environment  | Get started with sandbox access              |
| Configuration | Product Console               | Define account types and behaviors           |
| Integration   | API Suite                     | Programmatically create and manage accounts  |
| Testing       | Sandbox + Query tools         | Validate flows and simulate edge cases       |
| Advanced      | Wallets, sweeping, attributes | Add financial logic and operational metadata |
| Production    | Live switch + access control  | Move to real-world usage with stability      |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.xyb.co/xyb-platform-1/accounts/getting-started-with-accounts/planning-your-account-structure-and-setup/accounts-quick-start-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.