account.unlinked.voluntarily

3min

This event is triggered when a User successfully removes their card from the Publisher's platform and is no longer linked through Plaid.
Payload example
Below is a general example of a payload format for receiving account.unlinked.voluntarily event type webhooks. 
JS
{
 "publisher_uid": "samplePublisherUid",
  "publisher_user_id": "samplePublisherUserId",
  "event_type": "account.unlinked.voluntarily",
  "data": {
    "institution_id": "ins_56",
    "institution_name": "Chase",
    "item_id": "",
    "account_id": "3pkrJnDra3HRerGMLmeLtEqQ7JL91BTZNQZkX"
  },
  "event_timestamp": "2023-10-05T14:48:00"
}
{
 "publisher_uid": "samplePublisherUid",
  "publisher_user_id": "samplePublisherUserId",
  "event_type": "account.unlinked.voluntarily",
  "data": {
    "institution_id": "ins_56",
    "institution_name": "Chase",
    "item_id": "",
    "account_id": "3pkrJnDra3HRerGMLmeLtEqQ7JL91BTZNQZkX"
  },
  "event_timestamp": "2023-10-05T14:48:00"
}
﻿
All time values are in the Coordinated Universal Time (UTC) time zone.
Data object
The table below describes the fields in the data object for the account.unlinked.voluntarily webhook.
Field
Data type
Description
institution_id
string
Plaid's institution ID.
institution_name
string
The financial institution name.
item_id
string
A unique identifier in the Plaid API that represents an item. When a user connects their financial institution to the Publisher's platform using Plaid, an item is created. Each item linked within the Publisher's platform has a corresponding access_token and a unique item_id. This identifier is case-sensitive.
account_id
string
The unique ID of the account type of the institution, for example, savings or checking.
﻿

Field	Data type	Description
institution_id	string	Plaid's institution ID.
institution_name	string	The financial institution name.
item_id	string	A unique identifier in the Plaid API that represents an item. When a user connects their financial institution to the Publisher's platform using Plaid, an item is created. Each item linked within the Publisher's platform has a corresponding access_token and a unique item_id. This identifier is case-sensitive.
account_id	string	The unique ID of the account type of the institution, for example, savings or checking.

account.linked.successfully

account.linked.error