{"items":[{"type":"separator","label":"Mifundo Consumer API"},{"type":"link","fsPath":"texts/Introduction.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/texts/introduction","routeSlug":"/texts/introduction"},{"type":"link","fsPath":"texts/Authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/texts/authentication","routeSlug":"/texts/authentication"},{"type":"link","fsPath":"texts/TestingInBrowser.md","metadata":{"type":"markdown"},"label":"Testing API with Mock server","link":"/texts/testinginbrowser","routeSlug":"/texts/testinginbrowser"},{"type":"separator","separatorLine":true},{"type":"separator","label":"API reference"},{"type":"link","label":"Mifundo Consumer API 1.0","link":"/mca","routeSlug":"/mca"},{"type":"group","label":"AccountStatements","link":"/mca/accountstatements","routeSlug":"/mca/accountstatements","items":[{"label":"Get all account statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/accountstatements/getaccountstatements","routeSlug":"/mca/accountstatements/getaccountstatements","metadata":{"seo":{"title":"Get all account statements","description":"Returns all account statements"}},"httpPath":"/v1/sessions/{sessionId}/account-statements"},{"label":"Get transactions from all account statements in Excel format","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/accountstatements/getaccountstatementstransactionsexcelfile","routeSlug":"/mca/accountstatements/getaccountstatementstransactionsexcelfile","metadata":{"seo":{"title":"Get transactions from all account statements in Excel format","description":"Gets transactions from all account statements in Excel format as a binary stream"}},"httpPath":"/v1/sessions/{sessionId}/account-statements/transactions/excel"}]},{"type":"group","label":"Attachments","link":"/mca/attachments","routeSlug":"/mca/attachments","items":[{"label":"Get all attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/attachments/getattachments","routeSlug":"/mca/attachments/getattachments","metadata":{"seo":{"title":"Get all attachments","description":"Returns all attachments"}},"httpPath":"/v1/sessions/{sessionId}/attachments"},{"label":"Get attachment content by attachment ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/attachments/getattachmentcontent","routeSlug":"/mca/attachments/getattachmentcontent","metadata":{"seo":{"title":"Get attachment content by attachment ID","description":"Gets attachment content by ID as a binary stream"}},"httpPath":"/v1/sessions/{sessionId}/attachments/{attachmentId}/content"}]},{"type":"group","label":"Categorizations","link":"/mca/categorizations","routeSlug":"/mca/categorizations","items":[{"label":"Get categorizations summary for a session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/categorizations/getcategorizationssummary","routeSlug":"/mca/categorizations/getcategorizationssummary","metadata":{"seo":{"title":"Get categorizations summary for a session","description":"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."}},"httpPath":"/v1/sessions/{sessionId}/categorizations-summary"}]},{"type":"group","label":"Consumer","link":"/mca/consumer","routeSlug":"/mca/consumer","items":[{"label":"Get authorized packages for the authenticated consumer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/consumer/getconsumerpackages","routeSlug":"/mca/consumer/getconsumerpackages","metadata":{"seo":{"title":"Get authorized packages for the authenticated consumer","description":"Returns a list of countries and packages that can be used to create or upgrade sessions"}},"httpPath":"/v1/consumer/packages"}]},{"type":"group","label":"Court","link":"/mca/court","routeSlug":"/mca/court","items":[{"label":"Get court and insolvency cases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/court/getcourtandinsolvencycases","routeSlug":"/mca/court/getcourtandinsolvencycases","metadata":{"seo":{"title":"Get court and insolvency cases","description":"Returns all court and insolvency cases"}},"httpPath":"/v1/sessions/{sessionId}/court-and-insolvencies"}]},{"type":"group","label":"Identity verification","link":"/mca/identity-verification","routeSlug":"/mca/identity-verification","items":[{"label":"Get all identity verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/identity-verification/getidentityverifications","routeSlug":"/mca/identity-verification/getidentityverifications","metadata":{"seo":{"title":"Get all identity verifications","description":"Returns all identity verifications performed by the subject"}},"httpPath":"/v1/sessions/{sessionId}/identity-verifications"},{"label":"Get identity verification images by verification ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/identity-verification/getidentityverificationimages","routeSlug":"/mca/identity-verification/getidentityverificationimages","metadata":{"seo":{"title":"Get identity verification images by verification ID","description":"Gets identity verification images by verification ID"}},"httpPath":"/v1/sessions/{sessionId}/identity-verifications/{verificationId}/images"},{"label":"Get identity verification image content by image ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/identity-verification/getidentityverificationimagecontent","routeSlug":"/mca/identity-verification/getidentityverificationimagecontent","metadata":{"seo":{"title":"Get identity verification image content by image ID","description":"Gets identity verification image content by ID as a binary stream"}},"httpPath":"/v1/sessions/{sessionId}/identity-verifications/{verificationId}/images/{imageId}/content"}]},{"type":"group","label":"Immovables","link":"/mca/immovables","routeSlug":"/mca/immovables","items":[{"label":"Get immovables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/immovables/getimmovables","routeSlug":"/mca/immovables/getimmovables","metadata":{"seo":{"title":"Get immovables","description":"Returns all immovables"}},"httpPath":"/v1/sessions/{sessionId}/immovables"}]},{"type":"group","label":"LegalEntities","link":"/mca/legalentities","routeSlug":"/mca/legalentities","items":[{"label":"Get legal entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/legalentities/getlegalentities","routeSlug":"/mca/legalentities/getlegalentities","metadata":{"seo":{"title":"Get legal entities","description":"Returns a list of legal entities"}},"httpPath":"/v1/sessions/{sessionId}/legal-entities"}]},{"type":"group","label":"Metrics","link":"/mca/metrics","routeSlug":"/mca/metrics","items":[{"label":"Get metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/metrics/getmetrics","routeSlug":"/mca/metrics/getmetrics","metadata":{"seo":{"title":"Get metrics","description":"Returns a list of metrics"}},"httpPath":"/v1/sessions/{sessionId}/metrics"}]},{"type":"group","label":"NegativeTradelines","link":"/mca/negativetradelines","routeSlug":"/mca/negativetradelines","items":[{"label":"Get negative tradelines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/negativetradelines/getnegativetradelines","routeSlug":"/mca/negativetradelines/getnegativetradelines","metadata":{"seo":{"title":"Get negative tradelines","description":"Returns a list of negative tradelines"}},"httpPath":"/v1/sessions/{sessionId}/negative-tradelines"}]},{"type":"group","label":"PersonDetails","link":"/mca/persondetails","routeSlug":"/mca/persondetails","items":[{"label":"Get person details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/persondetails/getpersondetails","routeSlug":"/mca/persondetails/getpersondetails","metadata":{"seo":{"title":"Get person details","description":"Returns person details"}},"httpPath":"/v1/sessions/{sessionId}/person-details"}]},{"type":"group","label":"PositiveTradelines","link":"/mca/positivetradelines","routeSlug":"/mca/positivetradelines","items":[{"label":"Get positive tradelines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/positivetradelines/getpositivetradelines","routeSlug":"/mca/positivetradelines/getpositivetradelines","metadata":{"seo":{"title":"Get positive tradelines","description":"Returns a list of positive tradelines"}},"httpPath":"/v1/sessions/{sessionId}/positive-tradelines"}]},{"type":"group","label":"RegistryIncomes","link":"/mca/registryincomes","routeSlug":"/mca/registryincomes","items":[{"label":"Get registry incomes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/registryincomes/getregistryincomes","routeSlug":"/mca/registryincomes/getregistryincomes","metadata":{"seo":{"title":"Get registry incomes","description":"Returns a list of registry incomes"}},"httpPath":"/v1/sessions/{sessionId}/registry-incomes"}]},{"type":"group","label":"Scores","link":"/mca/scores","routeSlug":"/mca/scores","items":[{"label":"Get scores","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/scores/getscores","routeSlug":"/mca/scores/getscores","metadata":{"seo":{"title":"Get scores","description":"Returns a list of scores"}},"httpPath":"/v1/sessions/{sessionId}/scores"}]},{"type":"group","label":"Session input","link":"/mca/session-input","routeSlug":"/mca/session-input","items":[{"label":"Get unfulfilled input requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/session-input/getinputrequirements","routeSlug":"/mca/session-input/getinputrequirements","metadata":{"seo":{"title":"Get unfulfilled input requirements","description":"Returns all unfulfilled input requirements for the session"}},"httpPath":"/v1/sessions/{sessionId}/input-requirements"}]},{"type":"group","label":"Sessions","link":"/mca/sessions","routeSlug":"/mca/sessions","items":[{"label":"Creates a new session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sessions/createsession","routeSlug":"/mca/sessions/createsession","metadata":{"seo":{"title":"Creates a new session","description":"Defines search input for a person and returns a session ID based on which results can be requested"}},"httpPath":"/v1/sessions"},{"label":"Search for existing sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sessions/getsessions","routeSlug":"/mca/sessions/getsessions","metadata":{"seo":{"title":"Search for existing sessions","description":"Gets all sessions optionally filtered by request parameters"}},"httpPath":"/v1/sessions"},{"label":"Get session by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sessions/getsession","routeSlug":"/mca/sessions/getsession","metadata":{"seo":{"title":"Get session by ID","description":"Gets a session by ID"}},"httpPath":"/v1/sessions/{sessionId}"},{"label":"Upgrades an existing session","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sessions/upgradesession","routeSlug":"/mca/sessions/upgradesession","metadata":{"seo":{"title":"Upgrades an existing session","description":"Appends query parameters to an existing session"}},"httpPath":"/v1/sessions/{sessionId}"},{"label":"Extends customer input deadline for the session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sessions/extendcustomerinputdeadline","routeSlug":"/mca/sessions/extendcustomerinputdeadline","metadata":{"seo":{"title":"Extends customer input deadline for the session","description":"Extends customer input deadline from the current date by the number of days defined in the authenticated user configuration"}},"httpPath":"/v1/sessions/{sessionId}/actions/extend-customer-input-deadline"},{"label":"Resends the customer onboarding email containing the secure onboarding link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sessions/resendcustomernotification","routeSlug":"/mca/sessions/resendcustomernotification","metadata":{"seo":{"title":"Resends the customer onboarding email containing the secure onboarding link","description":"Resends the onboarding email, allowing the customer to access and complete the onboarding process if the original email was lost or deleted."}},"httpPath":"/v1/sessions/{sessionId}/actions/resend-customer-notification"},{"label":"Get PDF report by session ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sessions/getpdfreport","routeSlug":"/mca/sessions/getpdfreport","metadata":{"seo":{"title":"Get PDF report by session ID","description":"Gets PDF report by session ID as a binary stream"}},"httpPath":"/v1/sessions/{sessionId}/pdf-report"}]},{"type":"group","label":"SourceFiles","link":"/mca/sourcefiles","routeSlug":"/mca/sourcefiles","items":[{"label":"Get source files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sourcefiles/getsourcefiles","routeSlug":"/mca/sourcefiles/getsourcefiles","metadata":{"seo":{"title":"Get source files","description":"Returns all source files"}},"httpPath":"/v1/sessions/{sessionId}/source-files"},{"label":"Get source file by source file ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sourcefiles/getsourcefile","routeSlug":"/mca/sourcefiles/getsourcefile","metadata":{"seo":{"title":"Get source file by source file ID","description":"Returns a source file by source file ID"}},"httpPath":"/v1/sessions/{sessionId}/source-files/{sourceFileId}"},{"label":"Get source file content by source file ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/sourcefiles/getsourcefilecontent","routeSlug":"/mca/sourcefiles/getsourcefilecontent","metadata":{"seo":{"title":"Get source file content by source file ID","description":"Returns source file content by source file ID"}},"httpPath":"/v1/sessions/{sessionId}/source-files/{sourceFileId}/content"}]},{"type":"group","label":"Webhook subscriptions","link":"/mca/webhook-subscriptions","routeSlug":"/mca/webhook-subscriptions","items":[{"label":"Subscribe to webhooks of a session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/webhook-subscriptions/createwebhooksubscription","routeSlug":"/mca/webhook-subscriptions/createwebhooksubscription","metadata":{"seo":{"title":"Subscribe to webhooks of a session","description":"Registers an HTTPS endpoint to receive CloudEvents-formatted webhook notifications for the given session. Payloads are signed with your organization's static webhook signing secret (Standard Webhooks, HMAC-SHA256, 'webhook-signature' header)."}},"httpPath":"/v1/sessions/{sessionId}/webhook-subscriptions"},{"label":"List webhook subscriptions of a session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/webhook-subscriptions/getwebhooksubscriptions","routeSlug":"/mca/webhook-subscriptions/getwebhooksubscriptions","metadata":{"seo":{"title":"List webhook subscriptions of a session","description":"List webhook subscriptions of a session"}},"httpPath":"/v1/sessions/{sessionId}/webhook-subscriptions"},{"label":"Delete a webhook subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mca/webhook-subscriptions/deletewebhooksubscription","routeSlug":"/mca/webhook-subscriptions/deletewebhooksubscription","metadata":{"seo":{"title":"Delete a webhook subscription","description":"Delete a webhook subscription"}},"httpPath":"/v1/sessions/{sessionId}/webhook-subscriptions/{id}"}]},{"type":"group","label":"Webhooks","link":"/mca/webhooks","routeSlug":"/mca/webhooks","items":[{"label":"Customer input received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/mca/webhooks/customerinputreceivedv1webhook","routeSlug":"/mca/webhooks/customerinputreceivedv1webhook","metadata":{"seo":{"title":"Customer input received","description":"Sent when a customer has provided all required input. This event can occur multiple times if customer is asked to provide additional input. The request body is a CloudEvents 1.0 JSON envelope. Each delivery includes Standard Webhooks headers: 'webhook-id' (unique event id, use for idempotency), 'webhook-timestamp' (unix seconds) and 'webhook-signature' ('v1,' + base64 HMAC-SHA256 of '{id}.{timestamp}.{body}' computed with your consumer secret). Respond with any 2xx status code to acknowledge receipt; failed deliveries are retried with backoff."}},"httpPath":"com.mifundo.customer.input-received.v1"}]}]}