Documentation

Connection Status

Suggest Edits

Connections that have been created successfully can be retrieved from our API from the following endpoint:

GET https://identity.moneyhub.co.uk/users/:id/connections

Example response

{
    "data": [
        {
            "id": "b74f1a79f0be8bdb857d82d0f041d7d2:567da9db-7296-4dc0-8a99-7b20dea8d21f",
            "name": "Modelo Open Banking Mock",
            "type": "test",
            "connectedOn": "2019-09-27T14:29:43.687Z",
            "lastUpdated": "2019-09-27T14:30:30.284Z",
            "expiresAt": "2019-12-26T14:29:30.715Z",
            "accountIds": [
                "10c6e372-64a4-4d80-add1-ba8549d668ed"
            ],
            "status": "ok",
            "error": null,
        },
        {
            "id": "3c4637d3178c9a28ce655bfbf8e27a10:ae9cf42a-2fcb-40f1-a1ad-da0a5f1beed5",
            "name": "Aviva",
            "type": "legacy",
            "connectedOn": "2019-09-23T18:29:43.687Z",
            "lastUpdated": "2019-09-23T18:30:30.284Z",
            "expiresAt": "2019-12-22T12:29:30.715Z",
            "accountIds": [
                "ee429506-5565-4ee9-9c31-e375283c0497"
            ],
            "status": "ok",
            "error": null,
        },
        {
            "id": "b74f1a79f0be8bdb857d82d0f041d7d2:6fbebd5e-fb2a-4814-bdaf-9a8871167f43",
            "name": "Nationwide Open Banking",
            "type": "api",
            "connectedOn": "2019-09-27T14:28:47.072Z",
            "lastUpdated": "2019-09-27T14:29:34.792Z",
            "expiresAt": "2019-12-26T14:27:51.576Z",
            "accountIds": [
                "11b6f582-3013-4c71-8af3-9c2d83444c14"
            ],
            "status": "error",
            "error": "resync"
        }
    ],
    "meta": {}
}

Connection lastUpdated

The lastUpdated field on the connection shows the date of when data was last successfully retrieved from the provider. This date can be older or more recent depending on the frequency of syncs and how often the provider refreshes data.

For example, valuation connections such as zoopla, mouseprice and autotrader sync once a month so it would be expected to see a date between 0-30 days ago for these connections. Likewise, certain legacy connection account types like loans and mortgages may also show older dates in the lastUpdated field.

If the lastUpdated field is not populated and not returned on the connection, it means the connection has never synced successfully.

Connection status

  • ok - The connection has a healthy status.
  • error - The connection has encountered an error while syncing, the error code is specified under the error property.
  • never - The connection will not be able to sync ever again as the bank/provider has been permanently removed from the list of available connections.

Connection errors

  • resync: This connection hasn’t been updated recently, most likely due to the requirement for the user to enter multi factor authentication. We advise to trigger a sync. If problem persists a reauth flow can be used for api connections and a refresh flow can be used for legacy connections.
  • sync_error: There was an error syncing this connection. This may be due to the connection expiring. Please wait for us to automatically resync this connection later or trigger a sync. If problem persists a reauth or reconsent flow can be used for api connections and a refresh flow can be used for legacy connections.
  • sync_partial: There was an error syncing some of the transactions on this account. Please wait for us to automatically resync this connection later or trigger a sync.
  • mfa_required: This connection requires multi factor authentication and needs user input. Please take the user through a refresh flow.
  • credentials_error: This connection can no longer be updated, the user may have changed their credentials, revoked access or access has expired with the provider. Please take the user through a reauth flow.

Please see our section on connection error handling in the connections management page for more information on how to handle error statuses.

Expired At

All connections will set an expired at value except for ones from the following connections:

  • Handlesbanken
  • PensionBee
  • Société Générale
  • All legacy type connections

Updated 9 months ago