Credit Insights

The Credit Insights' history is regardless of the month history current setting.

Field	Type	Description
cash_flows	CashFlow[]	Groups transactions that share some similarities in descriptions, amounts and regularity
loans	Loans	Provides details on the customer’s loans
risks	Risks	Contains indicators related to Credit Risk

CashFlow object

Field	Type	Description
type	string	Type of the cashflow
category	string	Category of the cashflow
label_root	string	Common description root shared by the transactions within the same Cashflow
label	string	This value differs from labelRoot when a Cashflow can be split into two smaller pieces. These pieces share similarities in terms of amount and dates
total_amount	string	Total amount of the cash flow over the period of analysis. Transactions that are or has been rejected are included in this sum. Negative if expense, positive if income.
calendar	Calendar[]	Calendar of the cashflow
transactions	Transaction[]	Concerned transactions

Loans object

Field	Type	Description
repayments	Repayments	Information about loan repayments. This section does not take into account rejected loan repayment.
drawdowns	Drawdowns	Information about loan drawdowns

Risks object

Field	Type	Description
incidents	Incidents	List of all incidents detected in a user's cashflows.
overdraft	Overdraft	User's overdraft behaviour.
heavy_failures	HeavyFailures	Events that occur after either a legal decision or when an institution fetches its due directly on the user's account.

Incidents

Field	Type	Description
payment_rejections	RejectionDetail	Payment rejection details.
check_rejections	RejectionDetail	Check rejection details.

Overdraft

Field	Type	Description
duration	int	Number of days in hard overdraft. This number is the sum of all overdraft period.
fees	TransactionsGroupDetail	Overdrafts fees transaction detail

HeavyFailures

Field	Type	Description
direct_recovery_of_debt	TransactionsGroupDetail	Direct debt recovery transactions by an institution
bank_account_seizure	TransactionsGroupDetail	Bank account seizure transactions following a legal decision

RejectionDetail

Field	Type	Description
total_amount	int	Total amount of the related transactions.
total_fees_amount	int	Total amount of fees due to payment rejection.
transactions	Transaction[]	Detected rejected transactions.
fees_transactions	Transaction[]	Detected rejection fees. They may be disassociated from the rejections transaction as some rejections can be charged month after.

TransactionsGroupDetail

Field	Type	Description
total_amount	int	Total amount of the related transactions
transactions	Transaction[]	Transactions

Repayments

Field	Type	Description
total_amount	float	Total amount of all detected repayments over the period of analysis
monthly_amount	float	Mean amount of loan repayments per month
details	CashFlow[]	All cash flows related to loan repayments

Drawdowns

Field	Type	Description
count	float	Number of concerned transactions
total_amount	float	Total amount of draw downs
details	CashFlow[]	All cash flows related to loan drawdowns

Transaction

Field	Type	Description
description	string	Description of the transaction
dates	Date	Dates associated with the transaction
amount	float	Amount of the transaction (negative if debit)
currency	string	Transaction's currency
enrichements	Enrichement	Properties of transaction
is_coming	bool	Indicates if the transaction will be debited or credited on the account in the future

Date

Field	Type	Description
debited_at	datetime	Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debitted. This can occurs if there's a differed payement.
booked_at	datetime	Realization date of the transaction

Calendar

Field	Type	Description
month	Month	Calendar month of the transaction
amount	string	Amount of the transaction

Enrichement

Field	Type	Description
category	string	Transaction's category. This property describe the reason why a transaction is made.
type	string	Transaction's nature computed. This property describe the medium of the transaction.

Endpoints

GET/api/v6/users/{userId}/banking-credit-insights

Returns the credit insights analysis for the user, including cashflows, loans, and risk indicators.