Skip to main content
The Income response aggregates income data from all connected payroll providers and bank accounts. Employment records are merged and deduplicated, with a data_source field to identify the origin.

​
Response attributes

AttributeTypeDescription
employmentsarray of objectsCombined employment and income records from all connected sources
Each employment record includes a data_source field with value payroll or financial_accounts to identify its origin.

​
Endpoints

​
Example response

{
  "employments": [
    {
      "data_source": "payroll",
      "employer": "Acme Corp",
      "title": "Software Engineer",
      "status": "active",
      "annual_income": "120000.00",
      "pay_frequency": "BIWEEKLY",
      "start_date": "2022-01-15"
    }
  ]
}