We're sorry but

Your browser is not supported.

To enjoy our website, try using
a newer browser like Google Chrome,
Mozilla Firefox, or Microsoft Edge.

Make an Income request

Use the Income endpoint to submit a POST request.

income_streams

Includes monthly income, confidence, days, and name

last_year_income

The sum of the income streams over the past 365 days

projected_yearly_income

Income extrapolated over a year based on current, active income streams

number_of_income_streams

Total number of distinct income streams received in the past 365 days

Retrieve Income request

 
curl -X POST https://sandbox.plaid.com/income/get \
-H 'Content-Type: application/json' \
-d '{
  "client_id": String,
  "secret": String,
  "access_token": String
}'

Run

Make an Income request

Use the Income endpoint to submit a POST request.

Retrieve Income request


curl -X POST https://sandbox.plaid.com/income/get \
-H 'Content-Type: application/json' \
-d '{
  "client_id": String,
  "secret": String,
  "access_token": String
}'

Income data

The /income/get endpoint allows you to retrieve information pertaining to a Item’s income. In addition to the annual income, detailed information will be provided for each contributing income stream (or job)

Retrieve Income response

http code 200
{
  "item": {object},
  "income": {
    "income_streams": [
      {
        "confidence": 1,
        "days": 518,
        "monthly_income": 1601,
        "name": "PLAID"
      },
      {
        "confidence": 0.95,
        "days": 415,
        "monthly_income": 1530,
        "name": "BAGUETTES INC"
      }
    ],
    "last_year_income": 28072,
    "last_year_income_before_tax": 38681,
    "projected_yearly_income": 19444,
    "projected_yearly_income_before_tax": 26291,
    "max_number_of_overlapping_income_streams": 2,
    "number_of_income_streams": 2
  },
  "request_id": "m8MDnv9okwxFNBV"
}

income_streams

Includes monthly income, confidence, days, and name

last_year_income

The sum of the income streams over the past 365 days

projected_yearly_income

Income extrapolated over a year based on current, active income streams

number_of_income_streams

Total number of distinct income streams received in the past 365 days