Release - 02/09/2021
about 3 years ago by Bradley McInnes
Release Overview
This release covers the usual bug fixes and enhancements. New for this release is an endpoint for agent details, GET / servicing-agents & GET / servicing-organisations.
Breaking Changes
GET / addresses
- externalId
- number → string
- addressLines
- array of objects → array of strings
New Endpoints
GET /servicing-agents
- Requires ReadAgents consent. Retrieve account servicing agents from the the source system, e.g. Advisers, Para-planners, Wealth or Discretionary managers.
GET /servicing-organisations
- Requires ReadAgents consent. Retrieve account servicing organisations from the the source system, e.g. Financial Advice Firms, Wealth Management Firms, or other financial intermediary organisation.
Other Updates
GET / customers
- New Query Parameters
- type - Filter between Individual and Organisation customers
- New Payload Attributes
- gender
- maritalStatus
- phoneNumbers
- emails[].type
- string → enum
GET / accounts
- New Query Parameters
- externalId - Filter accounts based on their externalId
- accountServicerId - Filter accounts based on account servicer
GET / account-groups
- New Query Parameters
- externalId - Filter accounts based on their externalId
ReadAgents consent
- A new consent type for two endpoints that return details for account servicing agents on the source system, e.g. Advisers, Para-planners, Wealth or Discretionary managers. As well as details about the organisations the servicing-agent is a part of. Please see the latest version of the API spec for my details.