Getting started
Introduction
This guide explains how to integrate Wealth Reader: the user picks their bank, authenticates, and your system receives the normalised data.
Example of the final result: https://widget.wealthreader.com/demo-all/
Before you start
You need:
- A completed signup and an
api_key. - An onboarding session with the technical team. Book yours from Support.
- To decide the integration type (below).
- An HTTPS URL that receives the callback, if you integrate via iframe.
Choose the integration type
| Criterion | Iframe (widget) | OAuth |
|---|---|---|
| When | Web app that can embed an iframe | Native app, or you cannot embed an iframe |
| Frontend | You insert the widget on your page | You redirect the user to oauth.wealthreader.com |
| Data | Arrive as a POST to your callback URL |
You obtain them by completing the challenge at /token/ |
| Start with | Iframe: frontend | OAuth: backend |
Most web clients use the iframe.
How it works (iframe)
- Your page loads the widget with an
operation_idthat you generate. - The user picks the institution, gives consent and completes two-factor authentication if needed. The widget handles those steps.
- Wealth Reader fetches the data and does two things, in this order:
- On the backend, it sends the full JSON to the callback URL you configured. The
operation_idtravels in that response so you can match it to the frontend operation. - On the frontend, the iframe notifies your page with
postMessage(flow completed) only if the callback succeeded. Use that to close the selector or show a success screen.
- On the backend, it sends the full JSON to the callback URL you configured. The
The operation_id is the bridge between frontend and backend. Without it you cannot match what happened in the browser with the data that arrives on your server.
The flow completed message does not contain the bank data. The data goes to the callback. If the callback does not respond HTTP 200 with {"status":"ok"}, the frontend does not receive flow completed.
Last updated