---
title: "List a historical log of item consent events"
method: POST
path: "/consent/events/get"
tags: ["plaid"]
---

# 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. Extremely recent events (occurring within the past 12 hours) may not be available via this endpoint. Up to three years of consent logs will be available via the endpoint.

## Request body

- ConsentEventsGetRequest — Request to list a historical log of item consent events.
  - `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` string, required — The access token associated with the Item for which data is being requested.

## Response `200`

OK

- ConsentEventsGetResponse — Describes a historical log of item consent events.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
  - `consent_events` ConsentEvent[], required — 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, date-time — The date and time when the consent event occurred, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    - `event_type` 'CONSENT_GRANTED' | 'CONSENT_REVOKED' | 'CONSENT_UPDATED' — A broad categorization of the consent event.
    - `event_code` 'USER_AGREEMENT' | 'USE_CASES' | 'DATA_SCOPES' | 'ACCOUNT_SCOPES' | 'REVOCATION' — Codes describing the object of a consent event.
    - `institution_id` string, nullable — Unique identifier for the institution associated with the Item. Field is `null` for Items created via Same-Day Micro-deposits.
    - `institution_name` string, nullable — The full name of the institution associated with the Item. Field is `null` for Items created via Same-Day Micro-deposits.
    - `initiator` 'PLAID' | 'DATA_PROVIDER' | 'CUSTOMER' | 'END_USER' — The entity that initiated collection of consent.
    - `consented_use_cases` 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](https://plaid.com/docs/link/data-transparency-messaging-migration-guide/#updating-link-customizations) of use cases.
    - `consented_data_scopes` 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](https://plaid.com/docs/link/data-transparency-messaging-migration-guide/#data-scopes-by-product) of data scopes and products.
    - `consented_accounts` ConsentedAccount[] — 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` 'investment' | 'credit' | 'depository' | 'loan' | 'brokerage' | 'other' — `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](https://plaid.com/docs/api/accounts#account-type-schema) for a full listing of account types and corresponding subtypes.
      - `subtype` '401a' | '401k' | '403B' | '457b' | '529' | 'auto' | 'brokerage' | 'business' | 'cash isa' | 'cash management' | 'cd' | 'checking' | 'commercial' | 'construction' | 'consumer' | 'credit card' | 'crypto exchange' | 'ebt' | 'education savings account' | 'fhsa' | 'fixed annuity' | 'gic' | 'health reimbursement arrangement' | 'home equity' | 'hsa' | 'isa' | 'ira' | 'keogh' | 'lif' | 'life insurance' | 'limited purpose checking' | 'line of credit' | 'lira' | 'loan' | 'lrif' | 'lrsp' | 'money market' | 'mortgage' | 'mutual fund' | 'non-custodial wallet' | 'non-taxable brokerage account' | 'other' | 'other insurance' | 'other annuity' | 'overdraft' | 'paypal' | 'payroll' | 'pension' | 'prepaid' | 'prif' | 'profit sharing plan' | 'qshr' | 'rdsp' | 'resp' | 'retirement' | 'rlif' | 'roth' | 'roth 401k' | 'roth 403B' | 'roth 457b' | 'roth pension' | 'roth profit sharing plan' | 'roth thrift savings plan' | 'rrif' | 'rrsp' | 'sarsep' | 'savings' | 'sep ira' | 'simple ira' | 'sipp' | 'stock plan' | 'student' | 'thrift savings plan' | 'tfsa' | 'trust' | 'ugma' | 'utma' | 'variable annuity', nullable — See the [Account type schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.

## Other responses

- `default` — Error response.

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)