Mifundo Consumer API.
Mifundo Consumer API 1.0 (1.0)
Request
Returns aggregated categorization summary with insights by category and institution. Provides a high-level overview of categorized transaction data aggregated across all institutions and accounts linked in the session, including income sources, creditors, spending patterns, and detailed breakdowns by category, subcategory, and counterparty.
Security
keycloakAuthLive or keycloakAuthTest
- Mock serverhttps://doc.mifundo.com/_mock/mca/v1/sessions/{sessionId}/categorizations-summary
- Production APIhttps://api.mifundo.com/mca/v1/sessions/{sessionId}/categorizations-summary
- Test APIhttps://apitest.mifundo.com/mca/v1/sessions/{sessionId}/categorizations-summary
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.mifundo.com/_mock/mca/v1/sessions/{sessionId}/categorizations-summary' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
Overall summary statistics aggregated across all institutions and accounts. Includes key metrics like income sources, creditors, average monthly income and liabilities.
Shows the overall status of bank account categorization across all connected countries and providers. If some data sources are pending or errored, status shows "Some data missing". Possible values: SUCCESS (All relevant data successfully retrieved and processed), SOME_DATA_MISSING (Partial success — some providers still pending, errored, or missing customer input), WAITING_FOR_CUSTOMER (Waiting for user to provide necessary input - only when one source involved), WAITING_FOR_PROVIDER (Waiting for data provider's response - only when one source involved), FORBIDDEN (Access not permitted for this provider), UNSUPPORTED_COUNTRY (Data not available in the given country), PACKAGE_UPGRADE_REQUIRED (Access requires a higher data package), ERROR (Technical or validation error encountered), UNKNOWN (Unexpected or undefined status).
| Enum Value | Description |
|---|---|
| UNKNOWN | Status is not specified. |
| SUCCESS | The Data Provider has successfully returned a response. This means:
Note: an empty response can be a valid result. For example:
|
| ERROR | An error occurred when attempting to collect or process the data. Typical causes include:
|
| FORBIDDEN | The client is not authorized to access the requested data. Common reasons include:
|
| UNSUPPORTED_COUNTRY | The requested data is not available for the selected country. This may occur when:
|
| WAITING_FOR_CUSTOMER | The customer (Data Subject) still needs to provide one or more required data elements. This may include:
|
| WAITING_FOR_PROVIDER | All required data has been submitted by the customer (Data Subject). Mifundo has forwarded the request to the respective Data Provider, but a response has not yet been received. |
| PACKAGE_UPGRADE_REQUIRED | You haven't requested the information in original query, Please upgrade the Session to get this info. |
| SOME_DATA_MISSING | Partial success — some providers still pending, errored, or missing customer input. |
| ID_TAX_ONLY | Customer identity code granted only for tax purposes. |
Number of financial institutions (e.g. banks) the user has connected in this session. Example: If the user adds accounts from Bank A, Bank B, and Bank C -> value = 3
Number of bank accounts the user has connected during this session. Includes all types of accounts, from all providers. Example: 2 current accounts from Bank A + 1 savings account from Bank B -> value = 3
Number of different income sources detected across all connected accounts. Includes employers, government agencies, or platforms that paid the user over the past 6 months. Only regular income types are counted: salary, pension, government support, disability benefits, or gig income. Example: If income comes from 1 employer + 1 pension fund -> value = 2
Number of different creditors the user is currently making payments to, based on their connected accounts. Includes payments for loans, credit cards, BNPL services, mortgages, and other recurring debts. Example: If the user pays a car loan, mortgage, and credit card from different banks -> value = 3
The user's average monthly income over the last 6 months, calculated separately for each currency. All connected banks and accounts are included. Regular income includes salary, pension, government support, and similar. Example: If the user receives €1000 in Jan, €1200 in Mar, €1400 in Apr -> Average = €600/month (over 6 months)
Shows the user's average monthly loan or debt payments over the past 6 months, calculated separately for each currency. Includes payments for mortgages, personal loans, credit cards, and similar liabilities across all connected accounts. Example: If the user paid €300 (Jan), €200 (Apr), €400 (May) -> Average = €150/month
Aggregated insights grouped by transaction category (INCOMES, LIABILITIES, EXPENSES, OTHER_INCOMING_PAYMENTS). Each category includes subcategory breakdowns and counterparty details where applicable.
Response
application/json
{ "summary": { "status": "UNKNOWN", "countOfInstitutions": 0, "countOfAccounts": 0, "countOfIncomeSources": 0, "countOfCreditors": 0, "averageMonthlyIncome": null, "averageMonthlyLiabilities": null }, "categoryInsights": null, "institutions": null }
- Mock serverhttps://doc.mifundo.com/_mock/mca/v1/sessions/{sessionId}/categorizations
- Production APIhttps://api.mifundo.com/mca/v1/sessions/{sessionId}/categorizations
- Test APIhttps://apitest.mifundo.com/mca/v1/sessions/{sessionId}/categorizations
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://doc.mifundo.com/_mock/mca/v1/sessions/{sessionId}/categorizations' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "sources": null, "summary": { "periodWithIncomeMonths": null, "periodWithLiabilitiesMonths": null }, "categorizations": null }