Search documentation
Fuzzy search across every docs page and section
API referenceIncome
Fuzzy search across every docs page and section
API referenceIncome
API reference
POST /v1/income/get — detected income streams with employer, cadence, and confidence.
All endpoints are POST with a JSON body, authenticated with your secret key (Authentication). Errors use the standard envelope; money is in major units with an iso_currency_code; dates are YYYY-MM-DD strings.
/v1/income/getReturns income streams detected from deposit activity: employer, pay cadence, average gross amount, and a confidence score. Requires the income product scope.
access_tokenstringrequiredcurl https://api.feelconnect.dev/v1/income/get \-H "Authorization: Bearer $FEELCONNECT_SECRET_KEY" \-H "Content-Type: application/json" \-d '{"access_token":"fc_at_…"}'
{"income_streams": [{"income_id": "inc_2mV8xQkT4nB7wZ1cRj6f","employer_name": "Northwind Software","cadence": "biweekly","average_gross": 3184.62,"last_date": "2026-07-17","confidence": 0.97}]}
income_idstringinc_….employer_namestringcadencestringweekly | biweekly | monthly | irregularaverage_grossnumberlast_datestringYYYY-MM-DD of the most recent deposit.confidencenumber