Indicators

The Indicators product lets you retrieve metrics computed on end user’s banking data

Authentication: endpoint in this page requires header authentication with a user token.

Get indicators data for the user

GET https://{domain}.biapi.pro/2.0/users/{userId}/indicators

Get indicators metrics computed on end user’s banking data by user ID.

Path Parameters

Name
Type
Description

userId*

Integer

ID of the user

Response body: UserIndicators object

Data model

UserIndicators object

Property
Type
Description

id_user

Integer

Id of the user.

indicators

Indicators object

User's indicators metrics.

Indicators object

Property
Type
Description

avg_current_month

Current month average indicators.

total_current_month

Current month sum of indicators.

avg_last_30days

Last 30 day average indicators.

total_last_30days

Last 30 day sum of indicators.

avg_last_60days

Last 60 day average indicators.

total_last_60days

Last 60 day sum of indicators.

avg_last_90days

Last 90 day average indicators.

total_last_90days

Last 90 day sum of indicators.

MonthlyIndicators object

Property
Type
Description

incoming

Integer

Sum/average of positive transactions.

outgoing

Integer

Sum/average of negative transactions.

net_cash_flow

Integer

Sum/average of transactions.

leverage_ratio

String or null

Proportion of total of loans amount compared to total of recurrent income.

recurrent_income

Recurring income indicators.

recurrent_outcome

Recurring outcome indicators.

gambling

Gambling indicators.

loans

Loans indicators.

return_debit

Return debit indicators.

MonetaryAmount object

Property
Type
Description

num_statements

Decimal or Integer

Number of transactions of recurring income categories in the analyzed period. Integer if it is in total_current_month, total_last_30days, total_last_60days or total_last_90days, otherwise it is a Decimal after calculating the average.

total_amount

Integer

Sum of transactions of recurring income categories in the analyzed period.

details

String or null

GamblingIndicators object

Property
Type
Description

gambling_ratio

String or null

Proportion of total of gambling negative amounts compared to total of recurrent income.

income_num_statements

Decimal or Integer

Number of positive transactions of category Gambling in the analyzed period. Integer if it is in total_current_month, total_last_30days, total_last_60days or total_last_90days, otherwise it is a Decimal after calculating the average.

income_total_amount

Integer

Sum of positive transactions of category Gambling in the analyzed period.

outcome_num_statements

Decimal or Integer

Number of negative transactions of category Gambling in the analyzed period.

Integer if it is in total_current_month, total_last_30days, total_last_60days or total_last_90days, otherwise it is a Decimal after calculating the average.

outcome_total_amount

Integer

Sum of negative transactions of category Gambling in the analyzed period.

LoansIndicators object

Property
Type
Description

income_num_statements

Decimal

Number of positive transactions of category Loans in the analyzed period.

income_total_amount

Integer

Sum of positive transactions of category Loans in the analyzed period.

outcome_num_statements

Decimal

Number of negative transactions of category Loans in the analyzed period.

outcome_total_amount

Integer

Sum of negative transactions of category Loans in the analyzed period.

details

List of DetailsIndicators.

DetailsIndicators object

Property
Type
Description

category_id

Integer

Id of category.

amount

Integer

Amount of transaction.

date

String

Date in string.

ReturnDebitIndicators object

Property
Type
Description

num_statements

Decimal

Number of transactions of category Return Debit in the analyzed period.

total_amount

Integer

Sum of transactions of category Return Debit in the analyzed period.

Last updated