> 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/accounts/apis-and-events/api-quick-reference-guide.md).

# API Quick Reference Guide

**Base URL:** `/api/v2.0/account`\
**Description:** Account-related operations for querying, creating, updating, and managing account entities, wallets, coordinates, and states.

| Endpoint                                                     | Method             | Description                                    |
| ------------------------------------------------------------ | ------------------ | ---------------------------------------------- |
| `/account`                                                   | GET                | Query accounts                                 |
| `/account`                                                   | POST               | Create a new account                           |
| `/account/list`                                              | GET                | Fetch accounts by UUIDs or external references |
| `/account/owner/{customerType}/{reference}`                  | GET                | Fetch account by owner                         |
| `/account/search`                                            | GET                | Search accounts                                |
| `/account/{idRef}`                                           | GET                | Fetch single account by idRef                  |
| `/account/{idRef}/attributes`                                | PUT, DELETE, PATCH | Replace, delete, or add account attributes     |
| `/account/{idRef}/coordinates`                               | POST               | Add banking coordinates to account             |
| `/account/{idRef}/coordinates/{id}`                          | PUT, DELETE, PATCH | Manage coordinate tags                         |
| `/account/{idRef}/exists`                                    | GET                | Check if account exists                        |
| `/account/{idRef}/state`                                     | POST               | Update account state                           |
| `/account/{idRef}/wallets`                                   | GET                | Get live balances                              |
| `/account/{idRef}/wallets/gcb`                               | GET                | Get global balances                            |
| `/account/{idRef}/wallets/gcb/{walletType}/{walletCurrency}` | GET                | Get global balance by wallet/currency          |
| `/account/{idRef}/wallets/{walletType}/{walletCurrency}`     | GET                | Get live balance by wallet/currency            |

***

### Key Schemas

#### Account

Includes fields like `id`, `reference`, `currency`, `product_reference`, `name`, `state`, and nested arrays of `wallets`, `coordinates`, and `jurisdictions`.

**State Values:**

* `PENDING`, `OPEN`, `SUSPENDED`, `SUSPENDED_OUT`, `SUSPENDED_IN`, `CLOSED`, `TERMINATED`, `BLOCKED`

#### Account Request

Used in account creation with fields such as:

* `id`, `reference`, `name`, `owner`, `product_id`, `coordinates`, `attributes`, `jurisdiction`

#### WalletLive

Shows current balances:

* `available_balance`, `hold_balance`, `account_balance`, `currency`, `updated_at`

#### Account Coordinates

Details coordinates such as:

* `IBAN`, `account_number`, `bank_code`, `routing_code`, etc., along with `tags` and `external` data

#### State Change

Tracks account state transitions, including:

* `previous_state`, `state`, `applied_at`, `reason`, `id`

***

###


---

# 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/accounts/apis-and-events/api-quick-reference-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.