Authorization
section provides the OAuth endpoints to receive and manage access tokens which you need for any other service call.Mandator Administration
and Client Configuration
sections provide endpoints to configure your client. If you are a licensed TPP, the TPP Certificates
and TPP Credentials
sections are also relevant for your configuration.Users
section allows you to manage your user base.Banks
, Bank Connections
and Accounts
provide endpoints to receive bank accounts with their Transactions
or Securities
.Categories
and Labels
sections provide endpoints to re-categorize and/or label transactions.Payments
and Standing Orders
provide endpoints for executing money transfers, direct debits, and standing orders.Notification Rules
section allows you to configure push notifications that will be sent to your client when certain events take place.Mocks and Tests
section provides services which you can use to test your API integration. Note that these services can be used only on the Sandbox environment.Authorization
section provides the OAuth endpoints to receive and manage access tokens which you need for any other service call.Mandator Administration
and Client Configuration
sections provide endpoints to configure your client. If you are a licensed TPP, the TPP Certificates
and TPP Credentials
sections are also relevant for your configuration.Users
section allows you to manage your user base.Banks
, Bank Connections
and Accounts
provide endpoints to receive bank accounts with their Transactions
or Securities
.Categories
and Labels
sections provide endpoints to re-categorize and/or label transactions.Payments
and Standing Orders
provide endpoints for executing money transfers, direct debits, and standing orders.Notification Rules
section allows you to configure push notifications that will be sent to your client when certain events take place.Mocks and Tests
section provides services which you can use to test your API integration. Note that these services can be used only on the Sandbox environment.Payments
/Standing Orders
.Under the Risk Reports section you can find reports related to transactions which might be connected to a payment risk, if you provide goods with a payment plan to this customer. We detect these transactions and bundle them under one report, which your application can consume within seconds.
To have a deeper understanding of the cash flow of your users, we provide the whole Cash Flow Reports section. Here you can find a variety of income and expenditure related labels, in which we aggregate and summarize the according transactions belonging to a specific field, like insurances, income or rent and living.
Welcome to finAPI Schufa Services!The finAPI Schufa API is designed to support a Schufa Mobile Application by providing access to Schufa end-user functionality, as available on the meineSchufa Portal. Currently, it is connected to the meineSchufa Grow Portal via a set of web scrapers. |
Welcome to Schufa FraudPool!The Schufa FraudPool API is designed to support the Schufa FraudPool application. |
This service can be used to create process IDs. Behind a process ID is a user, which is managed by the system and returns an access token by retrieving the ID.
A process token can be attached to a link in emails or printed as a QR code, which includes the link.
User management in the Processmanager is largely automated. A user is created when a process token is created. This is automatically deleted after a configurable period of time for the mandator if it is not used.
Alternatively, the deletion of the user can be initiated directly by calling the invalidate
or complete
endpoint. In this case, a defined period of time also applies until the user is finally deleted, in order to be able to terminate other asynchronous internal system processes.