Release Overview

The 7th beta release brings a lot of updates, some of which are breaking changes. Please see below for details.

Universal API - Breaking Changes

  1. Open Wealth Scope Changes

  2. GET /customer

    • The name field has been split into separate givenName and familyName fields.

    • emailAddress has been replaced by an array that can return multiple emails with an optional associated type.

      • emailAddress --> emails [array]

        • email

        • type

Other Updates

  1. POST /account-access-consent

    • The following additional optional parameters have been added:

      1. accountServicerId - If you wish to direct the authorisingUser to a particular ASP this should be populated with the relevant accountServiceId.

      2. consentTypes - The data points you wish to gain consent from your end-user to access on their behalf e.g. ReadAccounts. Must be a subset of the values configured as part of the Application setup. If omitted will default to the full list of values configured against the Application.

  2. GET /transactions

    • The following additional resource fields have been added:

      1. createdAt - when the record was first fetched from the ASP

      2. updatedAt - when the record was last fetched from the ASP

      3. sourceInstrument - represents the instrument data as presented by the ASP

  3. GET /documents Endpoint

    1. Retrieve metadata about documents generated on an ASP. Documents are in the context of a customer that has a relationship with the authorisingUser. Please see the API reference documentation for further detail.

  4. Single active consent record

    1. There can now only be one active consent record for a given authorising user and ASP pairing at any one time. Requesting a new consent for an existing pairing will revoke the previous consent.

  5. Schema definition for the ‘expand’ query parameter

    1. The OpenAPI schema definitions for the expand parameters present on various GET endpoints has been changed to list out the valid enumerations for each endpoint.