Wych Insights API provides analytical and document-generation capabilities over customer-permissioned financial data.
This API is focused on three main scenarios:
- Open queries for reusable, parameterised insight execution over accounts and transactions
- Bank statements for retrieving account statements in CSV or PDF format
- MogoPlus enrichment for enhancing transaction data with merchant, category, budgeting and movement information
What this API is for
Use the Insights API when you want to:
- execute predefined or grouped insights against a user's consented financial data
- retrieve downloadable bank statements for a selected account
- enrich transactions for downstream decisioning, servicing or reporting workflows
Typical flow
A typical integration follows this sequence:
- authenticate your application
- find or create the user
- exchange into user context
- choose the required Insights scenario:
- execute an open query
- retrieve bank statements
- enrich transactions
API sections
Core
Authentication and user-context endpoints required before calling Insights services.
Open Queries
Define, execute and retrieve reusable insight queries and grouped insight runs.
Bank Statements
Retrieve downloadable statements for a selected account in CSV or PDF format.
MogoPlus Enrichment
Submit transactions for enrichment and categorisation.
Prerequisites
Before calling this API, make sure you have:
- a registered application
- a valid API key
- client credentials
- a valid user-context token
- an active customer consent where required