List Banking Images
Loading...
API endpoint path: /db-banking-images/v1/banking-images
Returns a list of available scanned document images based on query parameters including account, image type, and date range. The response contains individual image IDs and metadata that can be used to retrieve, view, and print specific images.
Image Types:
CHECK- Check images (requires transactionDate and transactionImageNumber)DEPOSIT_SLIP- Deposit slip images (requires transactionDate and transactionImageNumber)STATEMENT- Statement images (requires statementStartDate and statementEndDate)
Use this endpoint to:
- Build a UI component displaying available images for customers
- Retrieve image metadata for transaction history displays
- Get image IDs for subsequent individual image retrieval
Request
Responses
- 200
- 204
- 400
- 401
- 403
- 500
Success
No Content Possible causes:
- No statement images are available for a single user associated with account.
- No statement images are available for all the users associated with accounts.
Bad request Possible causes:
- The dates provided were either unparseable or invalid
Unauthorized Possible causes:
- Full authentication was not provided in the request.
- The authentication token that was sent in the request is invalid.
Forbidden Possible causes:
- The authentication provided does not authorize this request.
Not found Possible causes:
- Images retrieval is not enabled for this account.
- This user is not entitled to see images for this account.
- Images for this account are available on an external site.
- Various server errors