# Mifundo Consumer API 1.0

Mifundo Consumer API.

Version: 1.0

## Servers

Production API
```
https://api.mifundo.com/mca
```

Test API
```
https://apitest.mifundo.com/mca
```

## Security

### keycloakAuthTest

Keycloak (TEST). Supports both Authorization Code and Client Credentials flows.

Type: oauth2

### keycloakAuthLive

Keycloak (LIVE). Supports both Authorization Code and Client Credentials flows.

Type: oauth2

## Download OpenAPI description

[Mifundo Consumer API 1.0](https://doc.mifundo.com/_bundle/MCA.yaml)

## Sessions

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

### Creates a new session

 - [POST /v1/sessions](https://doc.mifundo.com/mca/sessions/createsession.md): Defines search input for a person and returns a session ID based on which results can be requested

### Search for existing sessions

 - [GET /v1/sessions](https://doc.mifundo.com/mca/sessions/getsessions.md): Gets all sessions optionally filtered by request parameters

### Get session by ID

 - [GET /v1/sessions/{sessionId}](https://doc.mifundo.com/mca/sessions/getsession.md): Gets a session by ID

### Updates an existing session

 - [PATCH /v1/sessions/{sessionId}](https://doc.mifundo.com/mca/sessions/updatesession.md): Appends query parameters to an existing session

### Extends customer input deadline for the session

 - [POST /v1/sessions/{sessionId}/actions/extend-customer-input-deadline](https://doc.mifundo.com/mca/sessions/extendcustomerinputdeadline.md): Extends customer input deadline from the current date by the number of days defined in the authenticated user configuration

## SourceFiles

Original responses from credit bureaus and other sources of information

### GetSourceFiles

 - [GET /v1/sessions/{sessionId}/source-files](https://doc.mifundo.com/mca/sourcefiles/getsourcefiles.md)

### GetSourceFile

 - [GET /v1/sessions/{sessionId}/source-files/{sourceFileId}](https://doc.mifundo.com/mca/sourcefiles/getsourcefile.md)

### GetSourceFileContent

 - [GET /v1/sessions/{sessionId}/source-files/{sourceFileId}/content](https://doc.mifundo.com/mca/sourcefiles/getsourcefilecontent.md)

## AccountStatements

### GetAccountStatements

 - [GET /v1/sessions/{sessionId}/account-statements](https://doc.mifundo.com/mca/accountstatements/getaccountstatements.md)

### GetAccountStatementExcelFile

 - [GET /v1/sessions/{sessionId}/account-statements/{accountStatementId}/excel](https://doc.mifundo.com/mca/accountstatements/getaccountstatementexcelfile.md)

## Attachments

### Get all attachments

 - [GET /v1/sessions/{sessionId}/attachments](https://doc.mifundo.com/mca/attachments/getattachments.md): Returns all attachments

### Get attachment content by attachment ID

 - [GET /v1/sessions/{sessionId}/attachments/{attachmentId}/content](https://doc.mifundo.com/mca/attachments/getattachmentcontent.md): Gets attachment content by ID as a binary stream

## Categorizations

### Get categorizations summary for a session

 - [GET /v1/sessions/{sessionId}/categorizations-summary](https://doc.mifundo.com/mca/categorizations/getcategorizationssummary.md): 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.

### GetCategorizations (deprecated)

 - [GET /v1/sessions/{sessionId}/categorizations](https://doc.mifundo.com/mca/categorizations/getcategorizations.md)

## Consumer

### Get authorized packages for the authenticated consumer

 - [GET /v1/consumer/packages](https://doc.mifundo.com/mca/consumer/getconsumerpackages.md): Returns a list of countries and packages that can be used to create or upgrade sessions

## Court

### GetCourtAndInsolvencyCases

 - [GET /v1/sessions/{sessionId}/court-and-insolvencies](https://doc.mifundo.com/mca/court/getcourtandinsolvencycases.md)

## Identity verification

### Get all identity verifications

 - [GET /v1/sessions/{sessionId}/identity-verifications](https://doc.mifundo.com/mca/identity-verification/getidentityverifications.md): Returns all identity verifications performed by the subject

### Get identity verification images by verification ID

 - [GET /v1/sessions/{sessionId}/identity-verifications/{verificationId}/images](https://doc.mifundo.com/mca/identity-verification/getidentityverificationimages.md): Gets identity verification images by verification ID

### Get identity verification image content by image ID

 - [GET /v1/sessions/{sessionId}/identity-verifications/{verificationId}/images/{imageId}/content](https://doc.mifundo.com/mca/identity-verification/getidentityverificationimagecontent.md): Gets identity verification image content by ID as a binary stream

## Immovables

### GetImmovables

 - [GET /v1/sessions/{sessionId}/immovables](https://doc.mifundo.com/mca/immovables/getimmovables.md)

## LegalEntities

### GetLegalEntities

 - [GET /v1/sessions/{sessionId}/legal-entities](https://doc.mifundo.com/mca/legalentities/getlegalentities.md)

## Metrics

### GetMetrics

 - [GET /v1/sessions/{sessionId}/metrics](https://doc.mifundo.com/mca/metrics/getmetrics.md)

## NegativeTradelines

### GetNegativeTradelines

 - [GET /v1/sessions/{sessionId}/negative-tradelines](https://doc.mifundo.com/mca/negativetradelines/getnegativetradelines.md)

## PersonDetails

### GetPersonDetails

 - [GET /v1/sessions/{sessionId}/person-details](https://doc.mifundo.com/mca/persondetails/getpersondetails.md)

## PositiveTradelines

### GetPositiveTradelines

 - [GET /v1/sessions/{sessionId}/positive-tradelines](https://doc.mifundo.com/mca/positivetradelines/getpositivetradelines.md)

## RegistryIncomes

### GetRegistryIncomes

 - [GET /v1/sessions/{sessionId}/registry-incomes](https://doc.mifundo.com/mca/registryincomes/getregistryincomes.md)

## Scores

### GetScores

 - [GET /v1/sessions/{sessionId}/scores](https://doc.mifundo.com/mca/scores/getscores.md)