Income

incomeVerificationDocumentsDownload

POST
/income/verification/documents/download

/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.

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

IncomeVerificationDocumentsDownloadRequest defines the request schema for /income/verification/documents/download.

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.

access_token?|

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

Response Body

application/zip

curl -X POST "https://example.com/income/verification/documents/download" \  -H "Content-Type: application/json" \  -d '{}'
{}