Consent

API reference for managing consent

Endpoints
/consent/events/getRetrieve consent events
See also
/item/getRetrieve an Item (includes Item consent details)

/consent/events/get

List a historical log of item consent events

List a historical log of item consent events

consent/events/get
Request fields
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
requiredstring
The access token associated with the Item data is being requested for.
1const request: ConsentEventsGetRequest = {
2  access_token: accessToken,
3};
4try {
5  const response = await plaidClient.consentEventsGet(request);
6  const consentEvents = response.data.consent_events;
7  const status = response.data.status;
8} catch (error) {
9  // handle error
10}
consent/events/get

Response fields and example

request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
consent_events
[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.

Format: date-time
event_type
string
A broad categorization of the consent event.

Possible values: CONSENT_GRANTED, CONSENT_REVOKED, CONSENT_UPDATED
event_code
string
Codes describing the object of a consent event.

Possible values: USER_AGREEMENT, USE_CASES, DATA_SCOPES, ACCOUNT_SCOPES
institution_id
nullablestring
Unique identifier for the institution associated with the Item. Field is null for Items created via Same Day Micro-deposits.
institution_name
nullablestring
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.

Possible values: PLAID, DATA_PROVIDER, CUSTOMER, END_USER
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 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 of data scopes and products.
consented_accounts
[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.

Possible values: investment, credit, depository, loan, brokerage, other
subtype
nullablestring
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 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, fixed annuity, gic, health reimbursement arrangement, home equity, hsa, isa, ira, keogh, lif, life insurance, 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, rdsp, resp, retirement, rlif, roth, roth 401k, rrif, rrsp, sarsep, savings, sep ira, simple ira, sipp, stock plan, student, thrift savings plan, tfsa, trust, ugma, utma, variable annuity
1{
2  "request_id": "m8MDnv9okwxFNBV",
3  "consent_events": [
4    {
5      "item_id": "Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr",
6      "event_type": "CONSENT_GRANTED",
7      "event_code": "USER_AGREEMENT",
8      "institution_id": "ins_123456",
9      "institution_name": "Platypus bank",
10      "initiator": "END_USER",
11      "created_at": "2019-02-15T15:52:39Z",
12      "consented_use_cases": [],
13      "consented_data_scopes": [],
14      "consented_accounts": []
15    },
16    {
17      "item_id": "Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr",
18      "event_type": "CONSENT_GRANTED",
19      "event_code": "USE_CASES",
20      "institution_id": "ins_123456",
21      "institution_name": "Platypus bank",
22      "initiator": "END_USER",
23      "created_at": "2019-02-15T15:52:39Z",
24      "consented_use_cases": [
25        "Send and receive money",
26        "Track and manage your finances"
27      ],
28      "consented_data_scopes": [],
29      "consented_accounts": []
30    },
31    {
32      "item_id": "Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr",
33      "event_type": "CONSENT_GRANTED",
34      "event_code": "DATA_SCOPES",
35      "institution_id": "ins_123456",
36      "institution_name": "Platypus bank",
37      "initiator": "END_USER",
38      "created_at": "2019-02-15T15:52:39Z",
39      "consented_use_cases": [],
40      "consented_data_scopes": [
41        "Account and balance info",
42        "Contact info",
43        "Account and routing number"
44      ],
45      "consented_accounts": []
46    },
47    {
48      "item_id": "Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr",
49      "event_type": "CONSENT_GRANTED",
50      "event_code": "ACCOUNT_SCOPES",
51      "institution_id": "ins_123456",
52      "institution_name": "Platypus bank",
53      "initiator": "END_USER",
54      "created_at": "2019-02-15T15:52:39Z",
55      "consented_use_cases": [],
56      "consented_data_scopes": [],
57      "consented_accounts": [
58        {
59          "account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
60          "mask": "0000",
61          "name": "Plaid Checking",
62          "official_name": "Plaid Gold Standard 0% Interest Checking",
63          "type": "depository",
64          "subtype": "checking"
65        }
66      ]
67    }
68  ]
69}