---
title: "Add an alias to the bank"
method: POST
path: "/v1/default/banks/{bank_id}/aliases"
tags: ["Banks"]
---

# Add an alias to the bank

`POST /v1/default/banks/{bank_id}/aliases`

## 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`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vectorize/apis/hindsight-http-api/docs/v1/default/banks/:bank_id/aliases/post.ts> (a function with typed inputs; its response is checked against the schema)

Give the bank another id to answer to. Nothing is copied or moved: the bank keeps its own id and all of its data, and the alias is only a second way to reach it — which is what makes it a zero-downtime alternative to renaming.

Returns 409 if the name is already a bank or another alias.

## Path parameters

- `bank_id` string, required

## Headers

- `authorization` string, nullable

## Request body

- CreateBankAliasRequest: Request model for adding an alias to a bank.
  - `alias` string, required: The extra bank id. Same rules as a bank id (non-empty, at most 192 bytes of UTF-8, no '/', no control characters, no leading underscore), and it must not already name a bank or another alias.
  - `primary` boolean: Also show the bank under this alias, replacing whichever alias is shown today.

## Response `201`

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/post.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)