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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false
deprecated

When true the API will only 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.

Body Params
uuid
required

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

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.

number

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

string
enum

If you want to get salary or non-salary income or both. If you do not provide any value, it will default to ALL.

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json