---
title: "Get the bank form schema for a country"
method: GET
path: "/api/account/bank-form"
tags: ["Accounts"]
---

# Get the bank form schema for a country

`GET /api/account/bank-form`

Returns the required fields for a bank payout destination. Each field includes `requestBodyPath` (e.g. `bank.iban`) showing where it belongs in the nested `POST /api/account/bank` body under `bank`, `owner`, or `address`. Pass `includeExample=true` for a sample nested request body.

## Query parameters

- `country` string, required
- `type` 'INDIVIDUAL' | 'BUSINESS', required
- `includeExample` boolean

## Response `200`

Get the bank form schema for a country successful

Get the bank form schema for a country with nested request body example

- BankFormWithExampleDto
  - `form` BankFormBlockDto[], required — Form blocks with `requestBodyKey` / `requestBodyPath` metadata
    - `id` string, required — Section identifier (e.g. `bank`, `owner`, `address`)
    - `requestBodyKey` string — Top-level key in the nested POST /api/account/bank body for fields in this block.
    - `fields` BankFormFieldDto[], required — Ordered list of fields in this section
      - `id` string, required — Unique field identifier (dot-notation path, e.g. `bank.iban`, `owner.firstName`)
      - `requestBodyPath` string — Nested path in the POST /api/account/bank body. `bank.iban` maps to `{ "bank": { "iban": "…" } }`.
      - `type` 'input' | 'select', required — Rendered widget type
      - `size` 'full' | 'half' — Display width hint
      - `options` string[] — Allowed values for `select` fields
      - `value` string — Pre-filled value (e.g. the country code)
      - `schema` object, required — JSON Schema validation rules for the field
      - `props` object, required — Additional HTML attributes to pass to the input/select element
  - `requestBodyExample` object, required — Sample nested request body for `POST /api/account/bank` for the requested country and business type.

## Other responses

- `400` — Country or business type not supported
- `401` — Unauthorized - Invalid API key

---

[API](https://skmtc.net/inflowpay/apis/inflow-api.md) · [All operations](https://skmtc.net/inflowpay/apis/inflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/inflowpay/inflow-api/versions/3012dd3dd14a/schema)