v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB

plaid

Refresh a digital payroll income verification

/credit/payroll_income/refresh refreshes a given digital payroll income verification.

post/credit/payroll_income/refresh

Request body

client_idstring

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.

secretstring

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.

user_tokenstring required

The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the user_token field. All other customers should use the user_id instead. For more details, see New User APIs.

user_idstring

A unique user identifier, created by /user/create. Integrations that began using /user/create after December 10, 2025 use this field to identify a user instead of the user_token. For more details, see New User APIs.

Response

success

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

verification_refresh_statusstring required

The verification refresh status. One of the following:

"USER_PRESENCE_REQUIRED" User presence is required to refresh an income verification. "SUCCESSFUL" The income verification refresh was successful. "NOT_FOUND" No new data was found after the income verification refresh.