Sign in

v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
connections

Retrieve all connections

get/oidc/.well-known/all-connections

Query parameters

clientIdstring uuid

Filter connections available to this client

Response

Successful Response

idstring

Bank connection id (used to request an authorization url for a specific bank)

namestring

Bank Name

type'api' | 'autotrader' | 'legacy' | 'test' | 'zoopla'

The type of bank connection (api, legacy or test)

countrystring

Country Code

parentRefstring

This property is now deprecated. Please use bankRef instead

bankRefstring

Reference that uniquely identities a set of connections as being part of the same institution. It is used to group a set of connections by the banking institution they refer to. It can alse be used to retrieve the bank icon.

isBetaboolean

A beta boolean value flagging which connection is currently being developed and may not have a 100% success rate

singleSyncOnlyboolean

A boolean value flagging if this connection can be reSynced after the initial auth request. If this flag is true then the connection will need to go through the reAuth Process every time.

useMfaboolean

Indicates if MFA authentication is required for this connection

iconUrlstring

The url of the bank icon SVG. Please be aware we don’t have icons for all the connections we provide. For the missing icons you can either use your own set or use our generic bank icon found at this url: https://identity.moneyhub.co.uk/bank-icons/default

userTypesstring[]

An array of user account types supported by the bank connection

paymentsstring[]

An array of payments capabilities for the bank

isTestboolean

A boolean value flagging which connections are test connections

accountDetailsstring[]

An array of account capabilities

friendlyNamestring

The readable name of the bank (without terms such as Open Banking)

connectionGroupsstring[]

A list of connections groups that the connection belongs to e.g. various connections may belong to a single provider like Barclays or Halifax

Example response

[
  {
    "id": "9dccc89e82360a33ecda6a0c9a2457fc",
    "name": "Accord Mortgages",
    "type": "legacy",
    "country": "GB",
    "parentRef": "accord",
    "bankRef": "accord",
    "singleSyncOnly": true,
    "useMfa": true,
    "accountTypes": [
      {
        "beta": true,
        "name": "investment"
      }
    ],
    "iconUrl": "https://identity-dev.moneyhub.co.uk/bank-icons/aegon",
    "userTypes": [
      "personal"
    ],
    "payments": [
      "domestic"
    ],
    "status": {
      "sync": "AVAILABLE",
      "auth": "AVAILABLE"
    },
    "transactionHistory": {
      "monthsInitialConsent": 72,
      "months": 3,
      "description": "6 years for Current and Savings, 6 months for cards (only in first 45 mins)"
    },
    "beneficiaries": {
      "retrieveEnabled": true
    },
    "friendlyName": "Accord",
    "connectionGroups": [
      "Accord"
    ]
  }
]
All 125 operations