Skip to main content
Select a package to read more about the Attributes available in each package.
You can call more than one Attributes package with the same requestId. Attributes calls do not complete the session, so a single requestId can retrieve multiple packages.

Income

Use the /GetIncomeAttributes endpoint if you need a high-level overview of your users’ income sources.


This is a primary basic use-case of Attributes and is often utilized by organizations that need a high-level, standard overview of your users Total Income, Employment Income, and Government Income. It will provide the following Attributes to enable a quick and easy standard Income verification. This is often used in manual processes.

Income Attributes

Please find a breakdown of the Attributes contained within this use-case below:

Note:

If you need a deeper review of Income, please refer to our Lending use-case.

Employer Income:

  • Employer name
  • Average monthly (complex)
  • Trend
  • Sum per calendar month
  • Count per calendar month

Non-Employer Income:

  • Average monthly (complex)

Government Income:

  • Average monthly (complex) (overall Government Income)
  • Sum of Government Income per calendar month
  • Count of Government Income per calendar month
  • Sum of Employment Insurance Income in the last 90 days
  • Sum of Social Assistance Income in the last 90 days
  • Sum of WSIB Income in the last 90 days
  • Sum of Pension Income in the last 90 days
  • Sum of Child Support Income in the last 90 days
  • Sum of Other Government Income in the last 90 days

Others:

  • Sum of Total Income per calendar month
  • Sum of Total Credits per calendar month
  • Account age in days
  • Average monthly free cash flow