> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/works/platform/architecture/low-level-design/registries/bank-account.md).

# Bank Account

## Overview

The Bank Account service stores the financial account details of entities (individuals or organizations).

## API Specifications

**Base path**: `/bankaccount-service/bankaccounts/`

### API Contract Link

The API specification is available [here](https://github.com/egovernments/DIGIT-Works/tree/master/backend/bankaccounts/docs). To view it in the Swagger editor, click below.

{% embed url="<https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-Works/master/backend/bankaccounts/docs/bank-account-v1.0.0.yaml>" %}

## Data Model&#x20;

### DB Schema Diagram

<figure><img src="https://github.com/egovernments/DIGIT-Works/blob/master/backend/bankaccounts/docs/Bank_Account_DB_Schema.png?raw=true" alt=""><figcaption></figcaption></figure>

### Web Sequence Diagrams

TBD

### Persister

[Bank account service persister](https://github.com/egovernments/works-configs/blob/UAT/egov-persister/bankaccounts-persister.yml)

### Indexer

No indexer has been configured for this service.&#x20;


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digit.org/works/platform/architecture/low-level-design/registries/bank-account.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.