Skip to content

institutions.md

Latest commit

 

History

History
85 lines (73 loc) · 3.37 KB

institutions.md

File metadata and controls

85 lines (73 loc) · 3.37 KB
Raw

Institution catalogue

The list of institutions is served live and is not duplicated here, because it changes as connectors ship:

GET https://api.wealthreader.com/entities/

Pass your api_key to get the subset enabled for your contract; without it you get the public catalogue. What follows is the shape of that response and how to read it — that part is stable.

As of this build the public catalogue holds 287 institutions across 26 countries, 56 of them reachable over the PSD2 channel and the rest over the non-PSD2 channel, which returns richer data (investment portfolio composition, ISIN and DGS codes). That is the unauthenticated subset; a contracted api_key reaches considerably more, across 61 countries. Always read the catalogue with your own key rather than assuming this list.

Fields

Field What it is
code The institution identifier. This is what you send as code and what comes back in statistics.code.
name Display name.
logo SVG on our CDN.
color The institution's brand colour, for your own selector.
country_code ISO country of the institution.
country_code_list Every country the institution operates in.
bic BIC/SWIFT, when the institution has one.
psd2 "1" regulatory PSD2 channel, "0" non-PSD2 channel.
personal_account / business_account Whether it serves retail, business or both.
status Whether the connector is currently enabled.
url_login The institution's own login page, for reference.
inputs Which credential fields this institution needs. See below.

Reading inputs

Do not assume every institution asks for a username and a password. inputs describes the exact credential form for that institution: each of document_type, user, password, second_password and third_password carries required, a localized name, a placeholder and a validation_rule you can apply directly to your input element. A field with an empty required is not used by that institution.

Across the current catalogue: user on 286, password on 232, second_password on 73, document_type on 19, third_password on 7.

If you use the iframe widget you never touch this: the widget renders the right form per institution. It matters when you build your own selector.

Example entry:

{
  "code": "abanca",
  "name": "Abanca",
  "logo": "https://cdn.wealthreader.com/abanca.svg",
  "psd2": "0",
  "color": "#5f89c6",
  "inputs": {
    "document_type": {
      "required": "",
      "name": "",
      "placeholder": "",
      "validation_rule": ""
    },
    "user": {
      "required": "1",
      "name": "NIF",
      "placeholder": "",
      "validation_rule": "type=\"text\""
    },
    "password": {
      "required": "1",
      "name": "PIN (Contraseña)",
      "placeholder": "",
      "validation_rule": "class=\"form-control asterisks\" type=\"password\" maxlength=\"6\""
    },
    "second_password": {
      "required": "",
      "name": "",
      "placeholder": "",
      "validation_rule": ""
    },
    "third_password": {
      "required": "",
      "name": "",
      "placeholder": "",
      "validation_rule": ""
    }
  },
  "url_login": "https://bancaelectronica.abanca.com",
  "country_code": "ES",
  "business_account": "0",
  "personal_account": "1",
  "country_code_list": "[\"ES\"]",
  "bic": "CCRIES2A",
  "status": "1"
}