{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-products/class/apis/partner/feeds.yaml","sidebar":"sidebar-sidebar.yaml__products_class_apis_partner_feeds","current-catalog-info":"current-catalog-info-/products/class/apis/partner/feeds"},"props":{"definitionId":"products/class/apis/partner/feeds.yaml","settings":{"baseUrlPath":"/products/class/apis/partner/feeds"},"disableAutoScroll":true,"seo":{"title":"Feeds"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"Feeds","version":"1.0","description":"A **feed** (in Class, a *fund holding reference*) links a bank account, or a broker or\nplatform account and the holdings within it, in a Class fund to the source of its\ntransaction data: usually an automated feed from the provider, or manual import where\nno feed is available.\n\n**Why set up a data feed?**\n\nClass receives electronic data directly from more than 220 banks, stockbrokers and\nwrap providers, as well as employer contributions. Linking a feed to a fund replaces\nmanual transaction and holding entry. Once the feed is authorised and the provider has\nactivated it, data updates overnight.\n\nAuthority to share that data is granted in one of two ways:\n\n- **By the account holder**, who either signs an authority form that is uploaded to\n Class, or activates the feed online with the provider.\n- **By a third party (adviser)**, whose credentials are recorded in Class for each\n provider, and who is linked to each feed that data should flow to.\n\nFor the full product explanation, see\n[Introduction to Data Feeds](https://support.class.com.au/hc/en-au/articles/360001383056-Introduction-to-Data-Feeds).\n\n**Creating a feed, in this order**\n\n1. **Feed products** — list the products available for a feed type (`Cash`, `Broker`\n or `Platform`) and read their authorisation, managed-account and linked-holding\n capabilities. For cash, supply a `bsb` to resolve the financial institution and its\n bank products. Each product lists the authorisation types its provider supports,\n and only those can be used.\n2. **New feed** — create the feed against the chosen product. Supply exactly one of\n the `Cash`, `Broker` or `Platform` blocks, matching `FeedType`, and choose an\n `AuthorisationType` from the product's `SupportedAuthorisationTypes`.\n3. **Complete authorisation**, depending on the authorisation type:\n - `AccountHolder` — upload the signed form with **Upload authority form**. These\n feeds start at `AuthorityNotRequested` and do not progress until a signed form is\n supplied.\n - `AdviserOrDealer` — supply the adviser's `AuthorityId` when creating the feed.\n Without it, the feed is created on `NoAuthoritySet` and receives no data.\n - `Online` — the account holder activates the feed online with the provider. Where\n the provider uses token activation, **New feed** returns an\n `AuthorityActivationNumber` for the account holder to enter. Confirm that your\n business is authorised either by sending `AuthorisationVerified: true` on\n **New feed**, or later with **Update feed status**, moving the feed to\n `WaitingOnProvider`.\n4. **Feeds** and **Feed detail** — read the feed and track its status until the\n provider activates it and data begins to load.\n\n**Changing a feed**\n\n- **Update feed** replaces a feed's configuration. It is a full replacement, so read\n the feed with **Feed detail** first and send everything you want to keep.\n- **Update feed status** requests a status transition, such as confirming\n authorisation on an online feed.\n\nDeleting a feed is not currently supported through this API.\n\n---\n\n**A `200` does not always mean nothing needs your attention.** Four operations return `200`\nalongside a populated `Warnings` array, and the meaning is different in each:\n\n| Operation | What a warning means | Warning shape |\n|-----------|----------------------|---------------|\n| **New feed** | The feed **was** created. `FeedId` is returned as normal and the warning is advisory. | `{ Code, Message }` objects |\n| **Update feed** | The feed **was** updated. Warnings can report authority changes or a missing adviser authority. | `{ Code, Message }` objects |\n| **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 |\n| **Upload authority form** | The file was stored but **was not recognised**. The feed will not progress until the form is verified. | Plain strings |\n\nAlways inspect `Warnings`, not just the status code. See **Errors and warnings** for the\nfull reference.\n\n\n
Servers
Partner Integration Environment (Sandbox)
https://api.class-pie.com.au/api/1.0
Production Environment
https://api.class.com.au/api/1.0
","tags":["Class Partner"]},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"nonprod.developer.myhub.com.au","port":4000,"ipAddress":"216.73.216.208"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"develop"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/products/class/apis/partner/feeds","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}