---
updatedAt: 2026-07-22T09:35:36.000Z
agentTools:
  projectIndex: https://docs.moneyhubenterprise.com/llms.txt
---

# Retreive the bank icon as SVG when providing a valid bank reference listed under our available connections. Can also return PNG or JPG images when .png or .jpg file extension is added.

Please be aware we don’t have icons for all the connections we provide, when this is the case the route returns 404 as response unless the defaultIcon parameter is used.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger 2.0 docs for the authentication/authorization Moneyhub API",
    "title": "Moneyhub Identity Service",
    "version": "2.0.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/bank-icons/{bankRef}": {
      "get": {
        "summary": "Retreive the bank icon as SVG when providing a valid bank reference listed under our available connections. Can also return PNG or JPG images when .png or .jpg file extension is added.",
        "description": "Please be aware we don’t have icons for all the connections we provide, when this is the case the route returns 404 as response unless the defaultIcon parameter is used.",
        "parameters": [
          {
            "description": "When value is true the route will return the default icon instead of 404 if bank icon is not available",
            "in": "query",
            "name": "defaultIcon",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "The bank reference",
            "in": "path",
            "name": "bankRef",
            "required": true,
            "example": "amex",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The pixel height for a PNG or JPG images",
            "in": "query",
            "name": "height",
            "example": 100,
            "schema": {
              "type": "number"
            }
          },
          {
            "description": "The pixel width for a PNG or JPG images",
            "in": "query",
            "name": "width",
            "example": 100,
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Bank Icon Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BankIcon"
                }
              }
            }
          },
          "404": {
            "description": "Unsuccessful Response - Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Unsuccessful Response - Unexpected Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "tags": [
          "bank-icons"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://identity.moneyhub.co.uk"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "Error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "The error code",
            "type": "string"
          },
          "message": {
            "description": "The error message",
            "type": "string"
          },
          "correlationId": {
            "description": "Id that identifies the request and can be used to ask for more details related to the error",
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "object"
      },
      "BankIcon": {
        "type": "string",
        "format": "binary",
        "example": "<svg width=\"500\" height=\"500\" xmlns=\"http://www.w3.org/2000/svg\"><radialGradient cx=\"17.541%\" cy=\"17.466%\" fx=\"17.541%\" fy=\"17.466%\" r=\"93.287%\" id=\"a\"><stop stop-color=\"#9DD5F6\" offset=\"0%\"/><stop stop-color=\"#98D3F5\" offset=\"7.11%\"/><stop stop-color=\"#89CEF3\" offset=\"15.75%\"/><stop stop-color=\"#70C6EF\" offset=\"25.16%\"/><stop stop-color=\"#4EBBEA\" offset=\"35.14%\"/><stop stop-color=\"#23ADE3\" offset=\"45.46%\"/><stop stop-color=\"#0DA6E0\" offset=\"50%\"/><stop stop-color=\"#2E77BC\" offset=\"100%\"/></radialGradient><path d=\"M448.006 50.842H50.9v398.544h397.106v-131.53c1.577-2.28 2.356-5.197 2.356-8.763 0-4.082-.779-6.61-2.356-8.74\" fill=\"url(#a)\"/><path d=\"M86.694 223.299l-7.64-18.616L71.46 223.3h15.235zm168.296-7.413c-1.534.93-3.348.962-5.521.962h-13.56v-10.372h13.745c1.945 0 3.974.087 5.292.842 1.448.68 2.344 2.128 2.344 4.128 0 2.041-.852 3.684-2.3 4.44zm96.73 7.413l-7.724-18.616-7.682 18.616h15.406zm-180.31 20.149h-11.442l-.043-36.572-16.184 36.572h-9.8l-16.227-36.604v36.604H95.013l-4.29-10.416H67.486l-4.333 10.416H51.03l19.987-46.696H87.6l18.983 44.211v-44.21H124.8l14.607 31.677 13.418-31.678h18.583v46.696h.002zm45.604 0h-37.286v-46.696h37.286v9.724H190.89v8.417h25.497v9.572H190.89v9.325h26.124v9.658zm52.572-34.12c0 7.445-4.97 11.292-7.865 12.447 2.442.93 4.528 2.571 5.521 3.932 1.576 2.323 1.848 4.397 1.848 8.568v9.173h-11.258l-.042-5.889c0-2.81.27-6.85-1.762-9.097-1.63-1.642-4.117-1.999-8.135-1.999h-11.982v16.985h-11.16v-46.696h25.672c5.704 0 9.907.15 13.515 2.237 3.531 2.086 5.648 5.13 5.648 10.34zm17.862 34.12h-11.389v-46.696h11.389v46.696zm132.124 0h-15.817L382.599 208.4v35.048h-22.731l-4.344-10.416h-23.186l-4.214 10.416h-13.06c-5.426 0-12.295-1.2-16.185-5.165-3.923-3.965-5.964-9.335-5.964-17.827 0-6.925 1.22-13.256 6.017-18.259 3.609-3.727 9.26-5.445 16.951-5.445h10.806v10.006h-10.58c-4.072 0-6.372.605-8.588 2.766-1.903 1.966-3.208 5.683-3.208 10.577 0 5.003.994 8.61 3.069 10.967 1.718 1.847 4.84 2.408 7.779 2.408h5.012l15.731-36.722h16.724l18.897 44.167v-44.167h16.995l19.62 32.52v-32.52h11.432v46.694zM50.9 252.62h19.07l4.3-10.372h9.627l4.289 10.372h37.522v-7.93l3.35 7.964h19.479l3.349-8.082v8.048h93.25l-.043-17.026h1.804c1.264.044 1.633.16 1.633 2.247v14.779h48.23v-3.964c3.89 2.085 9.94 3.964 17.902 3.964h20.29l4.342-10.372h9.627l4.247 10.372h39.1v-9.852l5.92 9.852h31.333v-65.127h-31.008v7.692l-4.343-7.692h-31.818v7.692l-3.987-7.692h-42.98c-7.193 0-13.517 1.004-18.626 3.803v-3.803H267.1v3.803c-3.25-2.885-7.68-3.803-12.606-3.803H146.138l-7.27 16.821-7.467-16.821h-34.13v7.692l-3.748-7.692H64.415L50.9 218.458v34.162h.001zm397.106 34.443h-20.343c-2.03 0-3.38.076-4.517.844-1.177.756-1.63 1.879-1.63 3.36 0 1.763.994 2.961 2.44 3.48 1.178.41 2.443.53 4.302.53l6.049.161c6.104.15 10.179 1.2 12.663 3.76.453.356.724.756 1.036 1.156v-13.29zm0 30.793c-2.712 3.965-7.995 5.975-15.147 5.975h-21.555v-10.016h21.468c2.13 0 3.62-.28 4.517-1.156a4.106 4.106 0 001.32-3.046c0-1.36-.543-2.441-1.364-3.09-.81-.712-1.989-1.036-3.932-1.036-10.48-.356-23.555.324-23.555-14.456 0-6.775 4.301-13.906 16.014-13.906h22.232v-9.293h-20.656c-6.234 0-10.762 1.493-13.97 3.814v-3.814h-30.553c-4.886 0-10.62 1.212-13.333 3.814v-3.814H314.93v3.814c-4.342-3.132-11.669-3.814-15.05-3.814h-35.99v3.814c-3.435-3.326-11.074-3.814-15.73-3.814h-40.278l-9.217 9.975-8.632-9.975h-60.166v65.172H188.9l9.498-10.132 8.946 10.132 36.389.033v-15.331h3.577c4.828.074 10.523-.12 15.547-2.292v17.589h30.014v-16.986h1.448c1.848 0 2.03.076 2.03 1.922v15.062h91.177c5.788 0 11.84-1.481 15.19-4.17v4.17h28.921c6.018 0 11.896-.843 16.368-3.004v-12.14zm-44.523-18.659c2.173 2.25 3.338 5.089 3.338 9.896 0 10.048-6.277 14.738-17.534 14.738h-21.74v-10.016H389.2c2.117 0 3.618-.28 4.56-1.156a4.142 4.142 0 001.317-3.046c0-1.36-.595-2.441-1.362-3.09-.853-.712-2.03-1.036-3.974-1.036-10.438-.356-23.51.324-23.51-14.456 0-6.775 4.256-13.906 15.958-13.906h22.376v9.941H384.09c-2.03 0-3.35.076-4.472.844-1.222.756-1.676 1.879-1.676 3.36 0 1.762 1.038 2.961 2.443 3.48 1.177.41 2.442.529 4.343.529l6.009.162c6.059.148 10.218 1.196 12.746 3.756zm-100.715-2.884c-1.493.886-3.34.962-5.512.962h-13.559v-10.49h13.744c1.987 0 3.976.042 5.327.843 1.446.757 2.31 2.203 2.31 4.202 0 1.998-.864 3.608-2.31 4.483zm6.74 5.812c2.485.917 4.516 2.56 5.468 3.921 1.576 2.28 1.804 4.409 1.85 8.526v9.259H305.62v-5.844c0-2.81.27-6.97-1.805-9.142-1.63-1.673-4.116-2.073-8.188-2.073h-11.928v17.059h-11.216v-46.707h25.77c5.65 0 9.765.25 13.429 2.204 3.522 2.128 5.738 5.044 5.738 10.372-.002 7.455-4.974 11.26-7.912 12.425zm14.1-25.001h37.253v9.66h-26.137v8.49h25.499v9.53h-25.5v9.293l26.138.042v9.692h-37.253v-46.707zm-75.305 21.555h-14.424v-11.894h14.553c4.03 0 6.827 1.642 6.827 5.726 0 4.04-2.667 6.168-6.956 6.168zm-25.541 20.904l-17.137-19.025 17.137-18.421v37.446zm-44.255-5.486h-27.442v-9.293h24.504v-9.53h-24.504v-8.49h27.983l12.208 13.61-12.749 13.703zm88.735-21.586c0 12.975-9.68 15.654-19.436 15.654h-13.927v15.666h-21.694l-13.744-15.462-14.283 15.462h-44.212v-46.707h44.892l13.732 15.31 14.198-15.31h35.664c8.858 0 18.81 2.452 18.81 15.387z\" fill=\"#FFF\"/></svg>"
      }
    }
  }
}
```