Skip to content

Mifundo Consumer API 1.0 (1.0)

Mifundo Consumer API.

Download OpenAPI description
Languages
Servers
Mock server
https://doc.mifundo.com/_mock/mca/
Production API
https://api.mifundo.com/mca/
Test API
https://apitest.mifundo.com/mca/

Sessions

Session is a collection of inputs for retrieving various sets of information

Operations

SourceFiles

Original responses from credit bureaus and other sources of information

Operations

AccountStatements

Operations

Attachments

Operations

Categorizations

Operations

Get categorizations summary for a session

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
keycloakAuthTest or keycloakAuthLive
Path
sessionIdstring(uuid)required
curl -i -X GET \
  'https://doc.mifundo.com/_mock/mca/v1/sessions/{sessionId}/categorizations-summary' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
summaryobject or nullrequired
summary.​statusstringrequired
Enum ValueDescription
UNKNOWN

Status is not specified.

SUCCESS

The Data Provider has successfully returned a response. This means:

  • All required customer data was submitted and verified.
  • The Data Provider returned a valid response (including cases where the response is empty).

Note: an empty response can be a valid result. For example:

  • No active liabilities or defaults are found.
  • The customer (Data Subject) is not listed in the credit bureau's database, indicating no negative or reportable credit history.
ERROR

An error occurred when attempting to collect or process the data. Typical causes include:

  • Invalid or incomplete input from the customer (Data Subject).
  • Failed identity verification.
  • Legal restrictions (e.g. protected identity).
  • Check the error_code and error_message fields for detailed diagnostics.
FORBIDDEN

The client is not authorized to access the requested data. Common reasons include:

  • Missing agreements between the Client and the Data Provider.
  • Restricted access to certain data sources based on jurisdiction or product configuration.
UNSUPPORTED_COUNTRY

The requested data is not available for the selected country. This may occur when:

  • The specific data type (e.g. positive tradelines) is not available in that market.
  • Mifundo has not yet integrated with relevant local Data Providers.
WAITING_FOR_CUSTOMER

The customer (Data Subject) still needs to provide one or more required data elements. This may include:

  • Consent(s)
  • Identification
  • Residential address (if required)
  • National identification number (if required)
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.

ID_TAX_ONLY

Customer identity code granted only for tax purposes.

summary.​countOfInstitutionsinteger or null(int32)

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

summary.​countOfAccountsinteger or null(int32)

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

summary.​countOfIncomeSourcesinteger or null(int32)

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

summary.​countOfCreditorsinteger or null(int32)

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

summary.​averageMonthlyIncomeArray of objects or null(Money)

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)

summary.​averageMonthlyLiabilitiesArray of objects or null(Money)

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

categoryInsightsArray of objects or null(CategoryInsightItem)

Aggregated insights grouped by transaction category (INCOMES, LIABILITIES, EXPENSES, OTHER_INCOMING_PAYMENTS). Each category includes subcategory breakdowns and counterparty details where applicable.

institutionsArray of objects or null(CategorizationsInstitutionItem)

List of financial institutions (banks) with their accounts and categorized transactions. Each institution includes summary statistics and detailed account-level data.

Response
application/json
{ "summary": { "status": "UNKNOWN", "countOfInstitutions": 0, "countOfAccounts": 0, "countOfIncomeSources": 0, "countOfCreditors": 0, "averageMonthlyIncome": [ … ], "averageMonthlyLiabilities": [ … ] }, "categoryInsights": [ { … } ], "institutions": [ { … } ] }

GetCategorizationsDeprecated

Request

Security
keycloakAuthTest or keycloakAuthLive
Path
sessionIdstring(uuid)required
curl -i -X GET \
  'https://doc.mifundo.com/_mock/mca/v1/sessions/{sessionId}/categorizations' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
sourcesArray of objects or null(Source)

List of Data Provider sources indicating where the response data was obtained from.

summaryobject or null
categorizationsArray of objects or null(CategorizationItem)

Detailed list of categorized financial transactions.

Response
application/json
{ "sources": [ { … } ], "summary": { "periodWithIncomeMonths": 0, "periodWithLiabilitiesMonths": 0 }, "categorizations": [ { … } ] }

Consumer

Operations

Court

Operations

Identity verification

Operations

Immovables

Operations

LegalEntities

Operations

Metrics

Operations

NegativeTradelines

Operations

PersonDetails

Operations

PositiveTradelines

Operations

RegistryIncomes

Operations

Scores

Operations