Allows retrieval of up to 2 years' of historical statements for your consumer's consented accounts
The Statements product allows retrieval of statements for your consumer's consented accounts. You may request a date range of up to two years of historical statements (maximum date ranges vary by provider).
Paginated Statement list results include an array of statement information with the consumer's account identifier and details such as statement id, date, description, and status. The results also include links to GET
the statement, returned in PDF format. Future file formats could include GIF, JPG, TIFF, and PNG.
Endpoints:
/statements/{version}/{providerId}/{accountId}
/statements/{version}/{providerId}/{accountId}/{statementId}
Supported data elements
Name | Type | Description |
---|---|---|
accountId | string | Corresponds to accountId in Account entity |
statementId | string | Long-term persistent identity of the statement |
statementDate | dateTime | Date of the statement (ISO 8601 format) |
description | string | Description of statement |
status | string | Defines the status of a document |
link | hateoasLink object array | The statement download link hosted by Akoya |
Need help?
Check out our Developer Community, or visit the Support Center in the Data Recipient Hub.
Looking for provider nuance documentation?
All provider nuance documentation is available in the Data providers section in the Data Recipient Hub.
Still stuck?
For all production issues, submit a support ticket through the Data Recipient Hub. Our support team is standing by 24/7. Questions and non-production issues will be answered during business hours.