Plaid Developer Portal
Plaid
HomeSDKsAPI ReferenceContext Plugin
Income

incomeVerificationPaystubGet

POST
/income/verification/paystub/get

(Deprecated) Retrieve information from a single paystub used for income verification

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

IncomeVerificationPaystubGetRequest defines the request schema for /income/verification/paystub/get.

client_id?string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secret?string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

income_verification_id?|

The ID of the verification for which to get paystub information.

access_token?|

The access token associated with the Item data is being requested for.

Response Body

application/json

curl -X POST "https://example.com/income/verification/paystub/get" \  -H "Content-Type: application/json" \  -d '{}'
{  "request_id": "2pxQ59buGdsHRef",  "document_metadata": {    "name": "paystub.pdf",    "status": "DOCUMENT_STATUS_PROCESSING_COMPLETE",    "doc_id": "2jkflanbd"  },  "paystub": {    "deductions": {      "subtotals": [],      "totals": []    },    "doc_id": "2jkflanbd",    "earnings": {      "subtotals": [],      "totals": []    },    "employee": {      "address": {        "city": "SAN FRANCISCO",        "country": "US",        "postal_code": "94133",        "region": "CA",        "street": "2140 TAYLOR ST"      },      "name": "ANNA CHARLESTON"    },    "employer": {      "name": "PLAID INC",      "address": {        "city": "SAN FRANCISCO",        "country": "US",        "postal_code": "94111",        "region": "CA",        "street": "1098 HARRISON ST"      }    },    "employment_details": {      "annual_salary": {        "amount": 60000,        "currency": "USD"      },      "hire_date": "2020-09-15"    },    "net_pay": {      "distribution_details": [],      "total": {        "canonical_description": "NET PAY",        "description": "TOTAL NET PAY",        "ytd_pay": {          "amount": 39456,          "currency": "USD"        },        "current_pay": {          "amount": 1490.21,          "currency": "USD"        }      }    },    "income_breakdown": [],    "pay_period_details": {      "check_amount": 1490.21,      "end_date": "2020-12-15",      "gross_earnings": 4500,      "pay_day": "2020-12-15",      "start_date": "2020-12-01"    },    "paystub_details": {      "pay_frequency": "BI-WEEKLY",      "paystub_provider": "ADP",      "pay_period_start_date": "2020-12-01",      "pay_period_end_date": "2020-12-15",      "pay_date": "2020-12-15"    },    "ytd_earnings": {      "gross_earnings": 59375,      "net_earnings": 39456    }  }}

incomeVerificationTaxformsGet POST

`/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.

incomeVerificationDocumentsDownload POST

`/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import. The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id` is returned in the `Plaid-Request-ID` header. For Payroll Income, the most recent file available for download with the payroll provider will also be available from this endpoint.