Banks

Remove an alias from the bank

Changed on

Stop an id reaching this bank. The bank and its memories are untouched; only the extra name goes away, and callers still using it get the same 404 (or new empty bank) they would have got before it existed.

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

Request

Path parameters

bank_idstring required
aliasstring required

Headers

authorizationstring nullable

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