---
title: "Show this alias in place of the bank id"
method: PATCH
path: "/v1/default/banks/{bank_id}/aliases/{alias}"
tags: ["Banks"]
---

# Show this alias in place of the bank id

`PATCH /v1/default/banks/{bank_id}/aliases/{alias}`

## Request

- Base URL: `https://hindsight.vectorize.io` (the document declares no server; this is the origin it was published from)
- URL: `https://hindsight.vectorize.io/v1/default/banks/{bank_id}/aliases/{alias}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vectorize/apis/hindsight-http-api/docs/v1/default/banks/:bank_id/aliases/:alias/patch.ts> (a function with typed inputs; its response is checked against the schema)

Present the bank under one of its aliases. Purely cosmetic: the bank keeps its own `bank_id`, which every other part of the system — authorisation, metering, exports, audit logs — continues to use.

Promoting an alias demotes whichever one was shown before, so a bank is presented under at most one alias. Send `primary: false` to go back to showing its own id.

## Path parameters

- `bank_id` string, required
- `alias` string, required

## Headers

- `authorization` string, nullable

## Request body

- SetBankAliasPrimaryRequest: Request model for showing (or no longer showing) an alias in place of the bank id.
  - `primary` boolean, required: True to present the bank under this alias; False to go back to its own id.

## Response `200`

Successful Response

- BankAliasesResponse: Response model for a bank's aliases.
  - `bank_id` string, required: The bank's own id, which an alias never replaces
  - `aliases` BankAliasEntry[], required: Extra ids that also reach this bank, the primary one first then oldest first
    - `alias` string, required
    - `primary` boolean: Whether this alias is shown in place of the bank's own id. Display only — the bank keeps its id, and everything that names a bank still uses it. At most one alias per bank can be primary, and none has to be.

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-04** `4fda98b75f63`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vectorize/apis/hindsight-http-api/changes/v1/default/banks/:bank_id/aliases/:alias/patch.md)

---

[API](https://skmtc.dev/vectorize/apis/hindsight-http-api.md) - [All operations](https://skmtc.dev/vectorize/apis/hindsight-http-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vectorize/apis/hindsight-http-api/revisions/45e711cd0897?raw)