User Account Management
Plaid makes an API available for partners who want to give their users the ability to view and control the apps to which their accounts are connected. These APIs permit Partners to list connected apps and accounts, receive notifications when new applications are linked, and to unlink applications. With this API, a partner can implement an experience on their own user-facing property which offers users fine-grained control of their Plaid connection.
- Authorization API
- List Applications for an Item
- Item Import (POST /item/import) API Method
- Unlink Item (POST /item/unlink) API Method
List user application links
Plaid Exchange partners will want to implement a dashboard to provide users the ability to manage the Plaid apps connected to their accounts. Plaid provides a means to populate that dashboard, by providing a way to enumerate connected applications for a given user, and accounts connected to those applications. Plaid provides app names, developer information, and logos to display.
New application linked webhook
When a returning user, i.e. one who has already connected an account at the Partner’s institution to a Plaid app, connects additional applications to their account, the subsequent account linking may not trigger an additional partner authorization. In order for the partner to know when their user accounts are connected to Plaid apps, e.g. to send an email to the user or push notifications to their mobile device, Plaid will send notifications to the partner.
NewApplicationLinkNotificationto the partner, enabling them to update their view of the user’s connected apps. This way, the Partner’s first-party account link management experience can be kept in sync with activity in other Plaid apps.
Unlink application notification
When a user is inside the partner’s app or online dashboard, they may choose to disconnect Plaid apps connected to their account. After processing this action and updating its view of the user’s permissioned account links, the partner should send a notification to Plaid.
Unlink application from within Partner’s app or website
ApplicationUnlinkNotificationto Plaid, which has the
application_idas request parameters.
Unlink application from within Plaid
ApplicationUnlinkNotificationto the partner, which has the