Statements
API reference for Statements endpoints and webhooks
Statements is currently in beta. To request access, contact Support or your Plaid Account Manager.
Endpoints | |
---|---|
/statements/list | Get download URLs for available bank statement PDFs |
/statements/download | Download a single bank statement |
/statements/list
Retrieve a list of all statements associated with the provided item.
The /statements/list
endpoint retrieves a list of all statements associated with the provided item.
Request fields and example
access_token
requiredstring
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.1Sample code coming soon!
statements/list
Response fields and example
accounts
[object]
account_id
string
Plaid's unique identifier for the account.
account_name
string
The name of the account, either assigned by the user or by the financial institution itself.
account_type
string
The type of account. Possible values are investment, credit, depository, loan, brokerage, other.
statements
[object]
The list of statements' metadata associated with this account.
statement_id
string
Plaid's unique identifier for the statement.
month
integer
Month of the year. Possible values: 1 through 12 (January through December).
year
integer
The year of statement.
Minimum:
2010
institution_id
string
The Plaid Institution ID associated with the Item.
institution_name
string
The name of the institution associated with the Item.
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.request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",3 "institution_id": "ins_3",4 "institution_name": "Chase",5 "accounts": [6 {7 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",8 "account_name": "Plaid Saving",9 "account_type": "depository",10 "statements": [11 {12 "statement_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",13 "month": 5,14 "year": 202315 }16 ]17 }18 ],19 "request_id": "eYupqX1mZkEuQRx"20}
Was this helpful?
/statements/download
Retrieve a single statement.
The /statements/download
endpoint retrieves a single statement PDF in binary format. The response will contain a Plaid-Content-Hash
header containing a SHA 256 checksum of the statement. This can be used to verify that the file being sent by Plaid is the same file that was downloaded to your system.
Request fields and example
access_token
requiredstring
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.statement_id
requiredstring
Plaid's unique identifier for the statements.
1Sample code coming soon!
Response
This endpoint returns a single statement, exactly as provided by the financial institution, in the form of binary PDF data.