Banks

List the bank's aliases

Changed on

Extra bank ids that reach this bank. Every endpoint accepts an alias wherever it accepts a bank id, so callers can be moved onto a new id in phases while the old one keeps working.

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

Request

Path parameters

bank_idstring 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