List a historical log of item consent events

POST /consent/events/get

List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Up to three years of consent logs will be available via the endpoint.

Request Body

Required

Request to list a historical log of item consent events.

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.
access_token
required, string
The access token associated with the Item data is being requested for.

Response

Describes a historical log of item consent events.

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.
consent_events
required, array[object]
A list of consent events.
item_id
string
The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.
created_at
string
The date and time when the consent event occurred, in ISO 8601 format.
event_type
string
A broad categorization of the consent event.
event_code
string
Codes describing the object of a consent event.
institution_id
string
Unique identifier for the institution associated with the Item. Field is null for Items created via Same Day Micro-deposits.
institution_name
string
The full name of the institution associated with the Item. Field is null for Items created via Same Day Micro-deposits.
initiator
string
The entity that initiated collection of consent.
consented_use_cases
array[string]
A list of strings containing the full list of use cases the end user has consented to for the Item. See the full list of use cases.
consented_data_scopes
array[string]
A list of strings containing the full list of data scopes the end user has consented to for the Item. These correspond to consented products; see the full mapping of data scopes and products.
consented_accounts
array[object]
An array containing the accounts associated with the Item for which authorizations are granted.
account_id
string
Plaid’s unique identifier for the account. Like all Plaid identifiers, the account_id is case sensitive.
mask
string
The last 2-4 alphanumeric characters of an account’s official account number
name
string
The name of the account, either assigned by the user or by the financial institution itself
official_name
string
The official name of the account as given by the financial institution
type
string
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead. credit: Credit card depository: Depository account loan: Loan account other: Non-specified account type See the Account type schema for a full listing of account types and corresponding subtypes.
subtype
string
See the Account type schema for a full listing of account types and corresponding subtypes.