# 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 ### keycloakAuthLive Keycloak (LIVE). Supports both Authorization Code and Client Credentials flows. Type: oauth2 ### keycloakAuthTest Keycloak (TEST). 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) ## AccountStatements ### Get all account statements - [GET /v1/sessions/{sessionId}/account-statements](https://doc.mifundo.com/mca/accountstatements/getaccountstatements.md): Returns all account statements ### Get transactions from all account statements in Excel format - [GET /v1/sessions/{sessionId}/account-statements/transactions/excel](https://doc.mifundo.com/mca/accountstatements/getaccountstatementstransactionsexcelfile.md): Gets transactions from all account statements in Excel format as a binary stream ## 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. ## 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 ### Get court and insolvency cases - [GET /v1/sessions/{sessionId}/court-and-insolvencies](https://doc.mifundo.com/mca/court/getcourtandinsolvencycases.md): Returns all court and insolvency cases ## 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 ### Get immovables - [GET /v1/sessions/{sessionId}/immovables](https://doc.mifundo.com/mca/immovables/getimmovables.md): Returns all immovables ## LegalEntities ### Get legal entities - [GET /v1/sessions/{sessionId}/legal-entities](https://doc.mifundo.com/mca/legalentities/getlegalentities.md): Returns a list of legal entities ## Metrics ### Get metrics - [GET /v1/sessions/{sessionId}/metrics](https://doc.mifundo.com/mca/metrics/getmetrics.md): Returns a list of metrics ## NegativeTradelines ### Get negative tradelines - [GET /v1/sessions/{sessionId}/negative-tradelines](https://doc.mifundo.com/mca/negativetradelines/getnegativetradelines.md): Returns a list of negative tradelines ## PersonDetails ### Get person details - [GET /v1/sessions/{sessionId}/person-details](https://doc.mifundo.com/mca/persondetails/getpersondetails.md): Returns person details ## PositiveTradelines ### Get positive tradelines - [GET /v1/sessions/{sessionId}/positive-tradelines](https://doc.mifundo.com/mca/positivetradelines/getpositivetradelines.md): Returns a list of positive tradelines ## RegistryIncomes ### Get registry incomes - [GET /v1/sessions/{sessionId}/registry-incomes](https://doc.mifundo.com/mca/registryincomes/getregistryincomes.md): Returns a list of registry incomes ## Scores ### Get scores - [GET /v1/sessions/{sessionId}/scores](https://doc.mifundo.com/mca/scores/getscores.md): Returns a list of scores ## Session input ### Get unfulfilled input requirements - [GET /v1/sessions/{sessionId}/input-requirements](https://doc.mifundo.com/mca/session-input/getinputrequirements.md): Returns all unfulfilled input requirements for the session ## 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 ### Upgrades an existing session - [PATCH /v1/sessions/{sessionId}](https://doc.mifundo.com/mca/sessions/upgradesession.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 ### Resends the customer onboarding email containing the secure onboarding link - [POST /v1/sessions/{sessionId}/actions/resend-customer-notification](https://doc.mifundo.com/mca/sessions/resendcustomernotification.md): Resends the onboarding email, allowing the customer to access and complete the onboarding process if the original email was lost or deleted. ### Get PDF report by session ID - [GET /v1/sessions/{sessionId}/pdf-report](https://doc.mifundo.com/mca/sessions/getpdfreport.md): Gets PDF report by session ID as a binary stream ## SourceFiles Original responses from credit bureaus and other sources of information ### Get source files - [GET /v1/sessions/{sessionId}/source-files](https://doc.mifundo.com/mca/sourcefiles/getsourcefiles.md): Returns all source files ### Get source file by source file ID - [GET /v1/sessions/{sessionId}/source-files/{sourceFileId}](https://doc.mifundo.com/mca/sourcefiles/getsourcefile.md): Returns a source file by source file ID ### Get source file content by source file ID - [GET /v1/sessions/{sessionId}/source-files/{sourceFileId}/content](https://doc.mifundo.com/mca/sourcefiles/getsourcefilecontent.md): Returns source file content by source file ID