Information such as the average monthly income value, the estimated salary received by a user, the yearly salary and the income sources count are part of the returned parameters that get returned on the Income endpoint.

API Reference

  • average_monthly_income

    This return the mean of the user's income monthly. We compute for this using sum of income divided by durations.

  • monthly_income

    This is the actual salary the user receives every month. sometimes you will see multiple results which means the user has a recurrent multiple streams of income

  • yearly_income

    This is the yearly estimated income of a user.

  • income sources

    This calculates the number of income streams or sources in the user transactions. some users might have two or more income source either from freelance or family.

API Object

{
  "average_income": 4500000,
  "monthly_income": 8600000,
  "yearly_income": 103200000,
  "income_sources": 0
}

Identity Fields

field description type
average_income The average monthly of a customer integer
monthly_income The estimated monthly salary/income from the user's bank account. integer
yearly_income The estimated yearly salary/income from the user's bank account. integer
income_sources The number of income streams or sources from a user's transaction data. integer

Did this page help you?