Incomes
The Incomes group in Credit Insights can be used to check the user's main income and its source.
This object is divided into several sections:
indicators, contains ratios and common indicators.employers, retrieves the names of employers in the user's transactions.categories, gives a summary of all the positive categories reported by Credit Insights. For each category, we provide a breakdown for each month. This list is sorted in descending order of total amounts.
The Employers feature is based on an algorithm that is not available in all markets. As of today, we are only able to detect the name and the amount of employees of a company for projects with the "France 🇫🇷" market.
Data Sample
Incomes can be retrieved using the GET /credit-insights/incomes endpoint:
{ "totalAmount":8624.35, "monthlyAmount":2874.78, "indicators":{ "allowancesRatio":0 }, "categories":[ { "name":"WAGE", "totalAmount":7744.35, "monthlyAmount":2581.45, "monthlyAmountExcludingMonthsWithoutValues": 2581.45, "calendar":[ { "month":"2022-01", "amount":2581.45 }, { "month":"2022-02", "amount":2581.45 }, { "month":"2022-03", "amount":2581.45 } ], "transactions":[ { "currency":"EUR", "amount":2581.45, "description":"VIR SEPA RECU /DE FNAC DARTY PARTICIPATIONS ET SERVICES /MOTIF SALAIRE /REF 106837-1", "dates":{ "debitedAt":"2022-03-21T22:00:00.000Z", "bookedAt":"2022-03-21T22:00:00.000Z" }, "isComing":true, "aggregator":{ "id":"6062", "type":"CREDIT" }, "enrichments":{ "category":"WAGE", "type":"INCOMING_TRANSFER", "isRejected":false, "relatedTransactions":{ }, "groupId":"label_1_0-label_1_0", "descriptionGroupId":"label_1_0", "isInternationalTransfer":false }, "createdAt":"2022-04-04T13:32:10.891Z", "updatedAt":"2022-04-04T13:32:10.891Z", "id":"624af3553cbf19956830cfab" } ] } ], "employers":[]}Was this page helpful?