Feeds (1.0)
A feed (in Class, a fund holding reference) links a bank account, or a broker or platform account and the holdings within it, in a Class fund to the source of its transaction data: usually an automated feed from the provider, or manual import where no feed is available.
Why set up a data feed?
Class receives electronic data directly from more than 220 banks, stockbrokers and wrap providers, as well as employer contributions. Linking a feed to a fund replaces manual transaction and holding entry. Once the feed is authorised and the provider has activated it, data updates overnight.
Authority to share that data is granted in one of two ways:
- By the account holder, who either signs an authority form that is uploaded to Class, or activates the feed online with the provider.
- By a third party (adviser), whose credentials are recorded in Class for each provider, and who is linked to each feed that data should flow to.
For the full product explanation, see Introduction to Data Feeds.
Creating a feed, in this order
- Feed products — list the products available for a feed type (
Cash,BrokerorPlatform) and read their authorisation, managed-account and linked-holding capabilities. For cash, supply absbto resolve the financial institution and its bank products. Each product lists the authorisation types its provider supports, and only those can be used. - New feed — create the feed against the chosen product. Supply exactly one of the
Cash,BrokerorPlatformblocks, matchingFeedType, and choose anAuthorisationTypefrom the product'sSupportedAuthorisationTypes. - Complete authorisation, depending on the authorisation type:
AccountHolder— upload the signed form with Upload authority form. These feeds start atAuthorityNotRequestedand do not progress until a signed form is supplied.AdviserOrDealer— supply the adviser'sAuthorityIdwhen creating the feed. Without it, the feed is created onNoAuthoritySetand receives no data.Online— the account holder activates the feed online with the provider. Where the provider uses token activation, New feed returns anAuthorityActivationNumberfor the account holder to enter. Confirm that your business is authorised either by sendingAuthorisationVerified: trueon New feed, or later with Update feed status, moving the feed toWaitingOnProvider.
- Feeds and Feed detail — read the feed and track its status until the provider activates it and data begins to load.
Changing a feed
- Update feed replaces a feed's configuration. It is a full replacement, so read the feed with Feed detail first and send everything you want to keep.
- Update feed status requests a status transition, such as confirming authorisation on an online feed.
Deleting a feed is not currently supported through this API.
A 200 does not always mean nothing needs your attention. Four operations return 200 alongside a populated Warnings array, and the meaning is different in each:
| Operation | What a warning means | Warning shape |
|---|---|---|
| New feed | The feed was created. FeedId is returned as normal and the warning is advisory. | { Code, Message } objects |
| Update feed | The feed was updated. Warnings can report authority changes or a missing adviser authority. | { Code, Message } objects |
| Update feed status | The request was processed. The effective status may differ from the requested status, or confirming authorisation may produce a warning. | { Code, Message } objects |
| Upload authority form | The file was stored but was not recognised. The feed will not progress until the form is verified. | Plain strings |
Always inspect Warnings, not just the status code. See Errors and warnings for the full reference.