Simulate ITEM_LOGIN_REQUIRED [Sandbox only]

POST https://{{env_url}}/sandbox/item/reset_login

An Item may transition into an error state in response to changes made by the user or financial institution. The most common scenarios are when a user changes their password or when the financial institution changes their multi-factor authentication flow. Plaid Link makes it easy to restore a user's Item to a good state by having them provide updated credentials and MFA information, if needed.

In the Sandbox, Items transition to an ITEM_LOGIN_REQUIRED error state automatically after 30 days. You can also simulate this event via an API request.

The /sandbox/item/reset_login endpoint allows you put an Item in an ITEM_LOGIN_REQUIRED error state. You can then use Plaid Link update mode to restore the Item to a good state.

An ITEM_LOGIN_REQUIRED webhook will be fired after a call to this endpoint, if one is associated with the Item.

Request Body

{"client_id"=>"{{client_id}}", "secret"=>"{{secret_key}}", "access_token"=>"{{access_token}}"}

HEADERS

RESPONSES

status: OK

{"request_id":"vv5qz","reset_login":true}