Retrieve a list of all statements associated with an item.

POST /statements/list

The /statements/list endpoint retrieves a list of all statements associated with an item.

Request Body

Required

StatementsListRequest defines the request schema for /statements/list

Parameters

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

Response

StatementsListResponse defines the response schema for /statements/list

Response Properties

accounts
required, array[object]
account_id
required, string
Plaid’s unique identifier for the account.
account_mask
required, string
The last 2-4 alphanumeric characters of an account’s official account number. Note that the mask may be non-unique between an Item’s accounts, and it may also not match the mask that the bank displays to the user.
account_name
required, string
The name of the account, either assigned by the user or by the financial institution itself.
account_official_name
required, string
The official name of the account as given by the financial institution.
account_subtype
required, string
The subtype of the account. For a full list of valid types and subtypes, see the Account schema.
account_type
required, string
The type of account. For a full list of valid types and subtypes, see the Account schema.
statements
required, array[object]
The list of statements’ metadata associated with this account.
statement_id
required, string
Plaid’s unique identifier for the statement.
date_posted
string
Date when the statement was posted by the FI, if known
month
required, integer
Month of the year. Possible values: 1 through 12 (January through December).
year
required, integer
The year of statement.
institution_id
required, string
The Plaid Institution ID associated with the Item.
institution_name
required, string
The name of the institution associated with the Item.
item_id
required, 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.
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.