Refresh a digital payroll income verification

POST /credit/payroll_income/refresh

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

Request Body

Required

CreditPayrollIncomeRefreshRequest defines the request schema for /credit/payroll_income/refresh

Parameters

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.
user_token
required, string
The user token associated with the User data is being requested for.
options
object
An optional object for /credit/payroll_income/refresh request options.
item_ids
array[string]
An array of item_ids to be refreshed. Each item_id should uniquely identify a payroll income item. If this field is not provided, all item_ids associated with the user_token will be refreshed.
webhook
string
The URL where Plaid will send the payroll income refresh webhook.

Response

CreditPayrollIncomeRefreshResponse defines the response schema for /credit/payroll_income/refresh

Response Properties

request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
verification_refresh_status
required, string
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.