Skip to main content
GET
Get User Income Endpoint

Authorizations

Authorization
string
header
required

Bearer authentication with a personal access token (prefix pat_). Generate tokens in the Truv web app under Settings → API keys.

Query Parameters

days
integer
default:90

Number of days of income history to include (1-365). Defaults to 90.

Required range: 1 <= x <= 365

Response

Aggregated income report from payroll and bank sources.

Aggregated income report combining payroll and bank account sources.

Employment records from payroll providers and bank transaction-based income are merged and deduplicated. Each employment includes a data_source field ('payroll' or 'financial_accounts') to identify its origin.

employments
Employments · object[]

Combined employment / income records from all connected sources. Each item contains data_source ('payroll' or 'financial_accounts'), provider name, company info, statements, income details, and more.