VEvectorize
Banks

Add an alias to the bank

Changed on

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.

post/v1/default/banks/{bank_id}/aliases

Request

Path parameters

bank_idstring required

Headers

authorizationstring nullable

Request body

aliasstring 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.

primaryboolean

Also show the bank under this alias, replacing whichever alias is shown today.

Example request

{
  "alias": "user-123"
}

Response

Successful Response

bank_idstring required

The bank's own id, which an alias never replaces

Example response

{
  "aliases": [
    {
      "alias": "user-123",
      "primary": true
    },
    {
      "alias": "legacy-user123",
      "primary": false
    }
  ],
  "bank_id": "user123"
}

Changes