Income Confirmation
Summary
Income Confirmation provides a categorized summary of an end-user’s income sources in the past 3 months based on bank transaction data obtained via Kontomatik.
When the endpoint is called for a given ownerExternalId
, all imported bank accounts are split by currencies and for each of them we create a summary divided into months - M-0, M-1, M-2 - which mean current month, previous month and two months ago respectively. The summary for each month provides sum totals of incoming transaction amounts in different categories (e.g. salary, pension, other income).
We also provide a summary for the last 90 days in the same categories, but in this case the totals are divided by 3, creating a monthly average for this period.
The categories in which the calculations are made are based on the Transaction Labeling performed by our Machine Learning and other algorithms.
For billing purposes, for a single end-user identified by ownerExternalId
and the scope of imported data at the moment of using this feature, all requests to the Income Confirmation endpoint are treated as one event.
Income Confirmation content
Income Confirmation classifies income into various categories, such as:
- Salary
- Pension
- Welfare and Alimony
- Invoice payments
- Other income
Monthly and 90-Day Summaries
- Income Confirmation provides both monthly breakdowns for the current and past two months (
M-0
,M-1
,M-2
) and a 90-day average.- The 90-day average divides total income into equal monthly estimates, making it easier to assess consistent earning patterns.
Currency-Based Insights
- Summaries are generated for each currency present in the user’s bank accounts.
- Detailed overviews for each IBAN ensure transparency, even for customers with multiple accounts.
Integration
Integrating our scoring system is straightforward and designed for developers. Here’s how:
- Import end-user data
-
Call the
/v1/owner-income-confirmation
endpoint. Pass theownerExternalId
assigned to the end-user. - Save the data from our API
For more technical details, refer to the Income Confirmation section in our documentation. There, you’ll find everything you need to implement the solution, from the endpoint specification to an example of an API call.
Responses returned from Income Confirmation are available in JSON format.
Digital Signature
For compliance purposes please use the Accept-Signature: SHA256withRSA
header in the API call in order for us to digitally sign the response (see: Digitally Signed Responses). This will give you certainty that the data comes from our servers and hasn’t been modified by anyone during the transfer.