# MIS Connect Documentation

> Documentation for MIS Connect

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Introduction to Financial Data](https://docs.misconnect.co/docs/introduction-to-financial-data.md)
- [Implementation Guide of Financial Data.](https://docs.misconnect.co/docs/implementation-guide-of-financial-data.md)
- [Fetching Account & Transaction Data](https://docs.misconnect.co/docs/fetching-account-transaction-data.md)
- [Introduction to Multibanking](https://docs.misconnect.co/docs/introduction-to-multibanking-1.md)
- [Implementation Guide of Multibanking](https://docs.misconnect.co/docs/implementation-guide-of-multibanking.md)
- [Fetching Account & Transaction Data - Multibanking](https://docs.misconnect.co/docs/fetching-account-transaction-data-copy.md)
- [Introduction to Financial Ident Verification](https://docs.misconnect.co/docs/introduction-to-financial-ident-verification.md)
- [MISConnect Financial Identity Verification Service Implementation Guide](https://docs.misconnect.co/docs/misconnect-financial-identity-verification-service-implementation-guide.md)
- [Getting your Verification Report](https://docs.misconnect.co/docs/getting-your-verification-report.md)
- [Widget Integration](https://docs.misconnect.co/docs/widget-integration.md)

## API Reference
- [Account Verification](https://docs.misconnect.co/reference/createaccountverification.md): Start the onetime account verification flow.
- [Get Account Verification Receipt](https://docs.misconnect.co/reference/getaccountverificationreceipt.md): Retrieve detailed information about the result of an account verification process. This verification receipt will give insights into the bank account connected by the user and how good the provided person name does match with the account-holder names.
- [Onetime Income Report](https://docs.misconnect.co/reference/createonetimeincomereport.md): Create a widget link to initiate the income report generation.
- [Retrieve Income Report](https://docs.misconnect.co/reference/getincomereport.md): Get Income Report for an account or an access
- [Client Authorization](https://docs.misconnect.co/reference/client-authorization.md)
- [Create access token](https://docs.misconnect.co/reference/createaccesstoken.md): Create a new token to access user resources.
- [Revoke token](https://docs.misconnect.co/reference/revokeoauthtoken.md): Use this endpoint to invalidate an access token or refresh token. If you want to revoke the refresh token associated with an access token see [here](/reference/createaccesstoken).
- [Revoke token (cascading)](https://docs.misconnect.co/reference/revokeoauthtokenwithcascade.md): Use this endpoint to invalidate an access token or refresh token.  If you revoke an access token and the `cascade`-flag is set to `true` the associated refresh token is also revoked.
- [Create a user](https://docs.misconnect.co/reference/createuser.md): The client has to have the `create_user` scope in order to be able to perform this operation.
- [Get user](https://docs.misconnect.co/reference/getuser.md): Show details about the user associated with the access token used for authentication.
- [Modify user](https://docs.misconnect.co/reference/updateuser.md): Update details of the user associated with the access token used for authentication.
- [Delete user](https://docs.misconnect.co/reference/deleteuser.md): Delete the user associated with the access token used for authentication. This will also completely remove all financial data of the user from the finX API backend.
- [List complete catalog (client_auth)](https://docs.misconnect.co/reference/listcatalogclientauth.md): The real catalog contains thousands of entries, so expect the call to cause some traffic and delay. The example is only to highlight the data structure. *Note*: The client has to have the `accounts=rw` scope in order to retrieve the catalog.
- [List complete catalog](https://docs.misconnect.co/reference/listcatalog.md): The real catalog contains thousands of entries, so expect the call to cause some traffic and delay. The example is only to highlight the data structure.
- [List banks](https://docs.misconnect.co/reference/listbanks.md): List banks of the provider catalog.
- [List services](https://docs.misconnect.co/reference/listservices.md): List all available services of the provider catalog.
- [Ongoing access](https://docs.misconnect.co/reference/createongoingaccess.md): Start the flow to create an ongoing account access.
- [Onetime access](https://docs.misconnect.co/reference/createonetimeaccess.md): Create a widget link for onetime account information access.
- [Manual synchronization](https://docs.misconnect.co/reference/createmanualsync.md): Initiate a manual synchronization flow to fetch new data (e.g. transactions) for already connected accounts from the respective bank(s).
- [Add provider access](https://docs.misconnect.co/reference/addprovideraccess.md): Attach a new provider access to the user's account. If the provider uses an authentication flow where customer credentials have to be presented, use the information from the catalog to identify available input fields. All mandatory (`is_optional=false`) public (`is_secret=false`) fields have to be provided when creating an access. All credentials that are sent with the request are securely stored in the finX backend.
- [List provider accesses](https://docs.misconnect.co/reference/listprovideraccesses.md): List all connected provider accesses of user.
- [Get provider access](https://docs.misconnect.co/reference/getprovideraccess.md): Retrieve the details of a specific provider access identified by its ID.
- [Delete provider access](https://docs.misconnect.co/reference/deleteprovideraccess.md): Delete a specific provider access identified by its ID.
- [List credentials](https://docs.misconnect.co/reference/listcredentials.md): List all credentials that have been used to access the provider sorted by the `created_at` field. The first credential in the list is the currently active one whereas the remaining ones are either revoked or expired.
- [Get credential](https://docs.misconnect.co/reference/getcredential.md): Retrieve the details of a specific credential of a provider access identified by its ID.
- [Revoke credential](https://docs.misconnect.co/reference/patchcredential.md): Revoke a specific credential of a provider access identified by its ID. Revoking a credential of type `CONSENT` will trigger a revocation call to the financial provider. The `status` field **must** be set to `REVOKED`.
- [List synchronization challenges](https://docs.misconnect.co/reference/listsyncchallenges.md)
- [Get synchronization challenge](https://docs.misconnect.co/reference/getsyncchallenge.md)
- [Solve synchronization challenge](https://docs.misconnect.co/reference/solvesyncchallenge.md): This endpoint is used to answer an authorization challenge that was issued by the financial provider.  In addition to the normal transport layer encryption it is possible to encrypt the challenge response using [JSON web encryption](/reference/jwe-encryption). Note that a challenge can only be answered once. Subsequent submission of a response to the same challenge will result in an error (HTTP status `409`).
- [Start provider synchronization](https://docs.misconnect.co/reference/createsync.md): In order for the finX API to have up-to-date transaction and account information, it needs to query the bank servers, a process which is called synchronization. With this call you can create a new synchronization to fetch updated data from the provider. If the confidential parts of the provider credentials have not been given when creating the access they have to be send with this request.
- [Get synchronization status](https://docs.misconnect.co/reference/getsyncstatus.md)
- [List accounts](https://docs.misconnect.co/reference/listaccounts.md): Get a list of all available accounts to which the user has granted access.
- [List accounts of access.](https://docs.misconnect.co/reference/listaccountsofaccess.md): Get a list of accounts that belong to this access.
- [Get account](https://docs.misconnect.co/reference/getaccount.md): Retrieve detailed information about an account identified by its ID.
- [Delete account](https://docs.misconnect.co/reference/deleteaccount.md): Delete account and all data associated with it (e.g. balance, transactions and other entities tied to it)
- [Get account balance](https://docs.misconnect.co/reference/getaccountbalance.md): Retrieve the balance of an account identified by its ID.
- [List transactions](https://docs.misconnect.co/reference/listtransactions.md): Get a list of the transactions of all accounts. You can additionally constrain the amount of transactions being returned by using the query parameters described below as filters.
- [List transactions of account](https://docs.misconnect.co/reference/listtransactionsofaccount.md): Get a list of the transactions associated with a specific account. You can additionally constrain the amount of transactions being returned by using the query parameters described below as filters.
- [Get transaction](https://docs.misconnect.co/reference/gettransaction.md): Retrieve the details of a single transaction by its ID.
- [Get transaction of account](https://docs.misconnect.co/reference/gettransactionofaccount.md): Retrieve the details of a single transaction by its ID associated to a specific account.
- [List contracts](https://docs.misconnect.co/reference/listcontracts.md): Retrieve a list of contracts associated with this user.
- [Create contract](https://docs.misconnect.co/reference/createcontract.md): Create a new contract based on a given set of transactions.
- [List contracts of access](https://docs.misconnect.co/reference/listcontractsofaccess.md): Retrieve a list of contracts associated with this access.
- [List contracts of account](https://docs.misconnect.co/reference/listcontractsofaccount.md): Retrieve a list of contracts associated with this account.
- [Get contract](https://docs.misconnect.co/reference/getcontract.md): Get contract by ID
- [Modify contract](https://docs.misconnect.co/reference/updatecontract.md): Update the properties of a contract. This is only possible as long as the contract properties are not automatically derived from the transaction history but are still managed by the user (`is_recognized` is `false`).
- [Delete contract](https://docs.misconnect.co/reference/deletecontract.md): Delete a contract.
- [Onetime Risk Report](https://docs.misconnect.co/reference/createonetimeriskreport.md): Create a widget link to initiate the onetime risk report generation.
- [Ongoing Risk Report](https://docs.misconnect.co/reference/createongoingriskreport.md): Create a widget link to initiate the ongoing risk report generation.
- [Get risk report](https://docs.misconnect.co/reference/getriskreport.md): Get the risk report which was created earlier. The language of the categories can be customized by using the `Accept-Language` HTTP header.
- [Get timeline](https://docs.misconnect.co/reference/gettimeline.md): Aggregated account characteristics are accumulated for all accounts of this user.
- [Get timeline for access](https://docs.misconnect.co/reference/gettimelineforaccess.md): Aggregated account characteristics are accumulated for all accounts of this access.
- [Get timeline for account](https://docs.misconnect.co/reference/gettimelineforaccount.md): Aggregated account characteristics are calculated for a single account.
- [Get categories](https://docs.misconnect.co/reference/getcategories.md): Retrieve a list of categories associated to the transactions of this user. Each category entry also includes aggregated statistics of the referenced transactions like total amount, number of transactions, high and low values.
- [Get categories for access](https://docs.misconnect.co/reference/getcategoriesforaccess.md): Retrieve a list of categories associated to the transactions of this access. Each category entry also includes aggregated statistics of the referenced transactions like total amount, number of transactions, high and low values.
- [Get categories for account](https://docs.misconnect.co/reference/getcategoriesforaccount.md): Retrieve a list of categories associated to the transactions of this account. Each category entry also includes aggregated statistics of the referenced transactions like total amount, number of transactions, high and low values.
- [Get payment partners](https://docs.misconnect.co/reference/getpaymentpartners.md): Retrieve a list of payment partners associated to the transactions of this user. Each entry includes aggregated statistics of the referenced transactions like total amount, number of transactions and average payment amount.
- [Get payment partners for access](https://docs.misconnect.co/reference/getpaymentpartnersforaccess.md): Retrieve a list of payment partners associated to the transactions of this access. Each entry includes aggregated statistics of the referenced transactions like total amount, number of transactions and average payment amount.
- [Get payment partners for account](https://docs.misconnect.co/reference/getpaymentpartnersforaccount.md): Retrieve a list of payment partners associated to the transactions of this account. Each entry includes aggregated statistics of the referenced transactions like total amount, number of transactions and average payment amount.
- [Categorize transactions](https://docs.misconnect.co/reference/categorizetransactions.md): Categorize transactions on the fly. The transaction data is provided in the request rather than fetched from the bank. **Note**: Currently the number of transactions that can be sent in one request is limited to 2000.
- [Get Category Tree](https://docs.misconnect.co/reference/getcategorytree.md): Retrieve the complete category tree as a single-linked list. The category name is rendered depending on the language given in the `Accept-Language` header. Each list entry has an `id` and a `parent_id` linking a category to its parent category (e.g. the category "Online-Shopping" is linked to the parent category "Living"). Categories on the 1st level have a `parent_id` value set to `null`.
- [Notifications](https://docs.misconnect.co/reference/notifications.md)
- [Create notification](https://docs.misconnect.co/reference/createnotification.md): Create a new notification.
- [Replace notifications](https://docs.misconnect.co/reference/replacenotifications.md): Replace all existing notifications with a list of new ones.
- [List notifications](https://docs.misconnect.co/reference/listnotifications.md): List all available notifications.
- [Get notification](https://docs.misconnect.co/reference/getnotification.md): Get details of a specific notification identified by its ID.
- [Modify notification](https://docs.misconnect.co/reference/updatenotification.md): Update the properties of a notification.
- [Delete notification](https://docs.misconnect.co/reference/deletenotification.md): Delete a notification so that no further events will be triggered for the given condition.
- [Get version](https://docs.misconnect.co/reference/getversion.md): Shows the current version and the environment of the finX API.
- [List standing orders](https://docs.misconnect.co/reference/liststandingorders.md): Get a list of all available standing orders that belong to the user accounts.
- [List scheduled payments](https://docs.misconnect.co/reference/listscheduledpayments.md): Get a list of all available scheduled payments that belong to the user accounts.
- [List direct debits of the user](https://docs.misconnect.co/reference/listdirectdebits.md): Fetch all direct debits of the user - can be filtered by accounts, access and synchronization
- [List beneficiaries of the user](https://docs.misconnect.co/reference/listbeneficiaries.md): Fetch all beneficiaries of the user - can be filtered by accounts, access and synchronization
- [List parties of the user](https://docs.misconnect.co/reference/listparties.md): Fetch all parties of the user - can be filtered by accounts, access and synchronization
- [Create a transaction upload job](https://docs.misconnect.co/reference/createupload.md): Creates a new user and associates it with the products and transactions received in the body of the request.
- [Get upload status](https://docs.misconnect.co/reference/getuploadstatus.md): Update details of the user associated with the access token used for authentication.