incomeVerificationRefresh
/income/verification/refresh refreshes a given income verification.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
IncomeVerificationRefreshRequest defines the request schema for /income/verification/refresh
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.
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.
The ID of the verification.
The access token associated with the Item data is being requested for.
Response Body
application/json
application/json
curl -X POST "https://example.com/income/verification/refresh" \ -H "Content-Type: application/json" \ -d '{}'{ "request_id": "string", "verification_refresh_status": "VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED"}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.
incomeVerificationPaystubsGet POST
`/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. 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.