List Banking Images
Loading...
API endpoint path: /db-banking-images/v1/banking-images
Returns a list of available scanned banking document images based on the provided query parameters, such as account, image type, and date criteria. The response includes image identifiers and associated metadata that can be used to view, download, or print individual images using the image retrieval endpoint.
Use this endpoint to:
- Display a list of available banking images for a customer or account
- Retrieve image metadata for transaction history or statement views
- Obtain image IDs needed to retrieve individual images
Behavior and capabilities:
- Results are returned only for images the authenticated user is entitled to access.
- The response includes metadata and identifiers, not image data.
- Image availability and returned fields may vary based on entitlements and account configuration.
- Images are filtered based on document type and applicable date criteria.
Supported Image Types:
- CHECK, DEPOSIT_CHECK, and DEPOSIT_SLIP images require the
transactionDatequery parameter. - CC_STATEMENT, DOCUMENT, and STATEMENT images require both
statementStartDateandstatementEndDate(inclusive range,YYYY-MM-DD).
Request
Responses
- 200
- 204
- 400
- 401
- 403
- 404
- 415
- 500
Success
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Unsupported Media Type
Internal Server Error