Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
.png)
Gets various types of images for the given account.
images:read in the body. ENDPOINTS
get
/v1/banking-images
Header parameters
Collapse
callingAppId
string
no
The id of the app or service calling the banking images service.
Authorization
string
required
An OAuth2 access token (in JWT format) that authorizes this request. The transactions:read and accounts:read scopes are required to access this API. Must be in the format Bearer {JWT}
transactionId
string
required
An ID that identifies this request. A unique identifier should be generated for each request made.
Body parameters
Collapse
Query parameters
Collapse
institutionCustomerId
string
no
LocationId for the business banking user for which onlinestatements are being retrieved. This is a required parameter for BB User.
statementPreview
string
no
The param is only applicable for statement images. This supports one OLS vendor. The vendor’s host request requires a statementPreview parameter.The options are PREVIEW or CURRENT which allows an administrator to view a preview of the Statement List. From AP, an administrator can view a preview of the Statement List. Only the request originating from AP will send the preview=true parameter.
statementEndDate
string
no
The end of the date for which statement images will be retrieved (inclusive). If included, this date must be after or the same as the start date, otherwise the request will fail.
statementStartDate
string
no
The start of the date for which statement images will be retrieved (inclusive). If included, this date must be before or the same as the end date, otherwise the request will fail.
transactionImageNumber
string
no
This param is only applicable for check or deposit slip images. This is a reference number on the check (eg. check number) or the deposit slip (eg. deposit slip number). This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
transactionDate
string
no
This param is only applcable for check or deposit slip images. This is the date of the transaction. This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
imageType
string
required
The type of the image(s) to fetch. The possible options are CHECK, DEPOSIT_SLIP, and STATEMENT.
accountId
string
required
The ID of the account for which images are being requested.
Responses
Collapse
200
Success
Response Body
{"bankingImages":[{"id":"string","institutionId":"string","institutionCustomerId":"string","accountId":"string","imageType":"CHECK","imageInfoItems":[{"data":"string","type":"PNG","view":"FRONT","pageNumber":"string"}],"transactionImageNumber":"string","transactionDate":"string","transactionDescription":"string","transactionStatus":"ACCEPTED","amount":0,"statementType":"ACC","statementDate":"string","statementFrom":"string","statementTo":"string"}]}
204
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.
Response Body
null
400
Bad request Possible causes: - The dates provided were either unparseable or invalid
Response Body
{"code":"string","message":"string"}
401
Unauthorized Possible causes: - Full authentication was not provided in the request. - The authentication token that was sent in the request is invalid.
Response Body
{"code":"string","message":"string"}
403
Forbidden Possible causes: - The authentication provided does not authorize this request.
Response Body
{"code":"string","message":"string"}
500
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
Response Body
{"code":"string","message":"string"}
CURL REQUEST
curl -X 'GET' \
'https://api.candescent.com/digitalbanking/db-banking-images/v1/banking-images' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'callingappid: SOME_STRING_VALUE' \
-H 'accept: application/json' \ RESPONSE
