Remove user

POST /user/remove

/user/remove deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist. If a user is created for a given client_user_id using /user/create and that user is then deleted with /user/remove, the client_user_id cannot be reused for another /user/create request.

Request Body

Required

UserRemoveRequest defines the request schema for /user/remove

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
string
The user token associated with the User data is being requested for.
user_id
string
A unique user_id generated by Plaid for the client-provided client_user_id. This field is currently in beta.

Response

UserRemoveResponse defines the response schema for /user/remove

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.