Refresh identity data
POST /identity/refresh
/identity/refresh is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur for any Identity-enabled Item. If changes to Identity are discovered after calling /identity/refresh, Plaid will fire a webhook DEFAULT_UPDATE.
As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
/identity/refresh is offered as an add-on to Identity and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
Request Body
Required
IdentityRefreshRequest defines the request schema for /identity/refresh
Parameters
client_id
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.
access_token
secret
secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
Response
IdentityRefreshResponse defines the response schema for /identity/refresh
Response Properties
request_id