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 the specific image for an account
images:read in the body. ENDPOINTS
get
/v1/banking-images/{bankingImageId}
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.
statementDate
string
no
The date for which statement image will be generated.
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.
Path parameters
Collapse
bankingImageId
string
required
The ID of the image to be retrieved.
Responses
Collapse
200
Success
Response Body
{"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"}
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/{bankingImageId}' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'callingappid: SOME_STRING_VALUE' \
-H 'accept: application/json' \ RESPONSE
