VEvectorize
Banks

Show this alias in place of the bank id

Changed on

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.

patch/v1/default/banks/{bank_id}/aliases/{alias}

Request

Path parameters

bank_idstring required
aliasstring required

Headers

authorizationstring nullable

Request body

primaryboolean required

True to present the bank under this alias; False to go back to its own id.

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