List Institutions

This institution endpoint is used to retrieve all available financial Institutions provided by Mono

API Object

[
    {
        "_id": "5f2d08be60b92e2888287702",
        "name": "GTBank",
        "type": "PERSONAL_BANKING",
        "auth_methods": [
            {
                "type": "internet_banking",
                "name": "Internet Banking",
                "ui": {
                    "title": "Log in to GTBank",
                    "form": [
                        {
                            "type": "elements.input",
                            "name": "username",
                            "hint": "UserID or Account Number",
                            "contentType": "string"
                        },
                        {
                            "type": "elements.input",
                            "name": "password",
                            "hint": "Password",
                            "contentType": "password"
                        }
                    ]
                },
                "_id": "60d071acf73e6468062ae8de"
            },
            {
                "type": "mobile_banking",
                "name": "Mobile Banking",
                "ui": {
                    "title": "Log in to GTBank",
                    "form": [
                        {
                            "type": "elements.input",
                            "name": "username",
                            "hint": "UserID or Account Number",
                            "contentType": "string"
                        },
                        {
                            "type": "elements.input",
                            "name": "password",
                            "hint": "Password",
                            "contentType": "password"
                        }
                    ]
                },
                "_id": "60d071adf73e6468062ae8e4"
            }
        ],
        "icon": "https://mono-public-bucket.s3.eu-west-2.amazonaws.com/images/gtbank-icon.png",
        "identifier": "mono.connections.gtbank",
        "primaryColor": "#E24407",
        "country": "ng",
        "ui": {
            "title": "Log in to GTBank",
            "form": [
                {
                    "type": "elements.input",
                    "name": "username",
                    "hint": "UserID or Account Number",
                    "contentType": "string"
                },
                {
                    "type": "elements.input",
                    "name": "password",
                    "hint": "Password",
                    "contentType": "password"
                }
            ]
        }
    },
    ...
]

Institution Fields

Field	Description	Type
_id	ID. of the Institution	string
name	Name of the Institution	string
type	PERSONAL_BANKING or BUSINESS_BANKING	string
auth_methods	list of authentication methods supported by the institution, (internet_banking, mobile_banking)	array
auth_methods[0].type	The authentication method type which is either `mobile_banking` or `internet_banking`	string
auth_methods[0].name	The authentication method name type	string
auth_methods[0]._id	The authentication method id	string
auth_methods[0].ui	The ui object describing the form and user interface of the login page.	object
auth_methods[0].ui.title	The title of the page	string
auth_methods[0].ui.form	This represents the array of inputs required for the login, and follows basic html naming convention.	array
icon	The icon of institution	string
identifier	Mono connection identifier from source	string
primaryColor	The theme colour of that institution	string
country	The country of that institution	string
ui	This represents the ui for the login and includes 2 fields, `title` and `form`	object
ui.title	The rendered title of the institution	string
ui.form	This represents the array of inputs required for the login, and follows basic html naming convention.	array
ui.form.type	There are 3 types of elements (`elements.input` \|\| `elements.switch` \|\| `elements.captcha_input`)