Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Income

Get Income

Get Income endpoint provides essential income verification data for credit decisioning and underwriting processes. This API analyzes transaction history to produce reliable income insights for a specific borrower identified by their entity_id.

The API returns comprehensive income information including categorization by source (salary vs. non-salary), monthly income patterns, and statistical analysis that helps lenders accurately assess an applicant's ability to pay. These insights can be used for:

  • Verifying user stated income on loan applications
  • Calculating debt-to-income ratios with precision
  • Identifying income stability and irregularities
  • Supporting automated credit decisioning systems
  • Reducing manual verification workloads in underwriting

Use this endpoint to streamline credit underwriting workflows, reduce time-to-decision, and make more informed lending decisions based on verified financial data.

post/insights/v2/income

Query parameters

asyncboolean

When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it's recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.

Request body

entity_idstring uuid required

The entity_id you are querying for. The entity needs to have permissions accounts and transactions.

start_datestring date

The start date in UTC (in the format YYYY-MM-DD) you want to query transactions for.

If not provided, we will default to 6 months before now.

estimated_monthly_incomenumber

Monthly income for the user that you have gathered from another source (e.g.: reported by the user).

income_type'SALARY' | 'NON_SALARY' | 'ALL'

Response

OK

type'income' | 'employment' | 'cashflow' | 'credits-obligations' | 'non-credits-obligations' | 'expenses' | 'cash-balances' | 'freelancer-cashflow' | 'behaviors' | 'cashflow-patterns' | 'credit-assessments' | 'account-controls' | 'credit-obligations'

type of insight

Example response

{
  "insights": {
    "salary": {
      "income_factors": {
        "periods": [
          {
            "average_income": {
              "currency": "AED"
            }
          }
        ]
      }
    },
    "non_salary": {
      "income_factors": {
        "periods": [
          {
            "average_income": {
              "currency": "AED"
            }
          }
        ]
      }
    }
  }
}