Images

The Banking Images API provides read-only access to host-stored banking document images, including checks, deposit slips, deposit checks, statements, credit card statements, and other supported documents. Consumers can list available images and retrieve full image content by ID using filters such as account, imageType, and date ranges.

The API supports both transaction-based and statement-based image retrieval and returns content in type-specific formats (TIFF for transaction images; PDF for statements and documents).

End-user benefits

• View check and deposit images associated with posted transactions.
• Access deposit slip and deposit check images for verification and audit workflows.
• Retrieve online statements and documents, with optional preview support.

Integration capabilities

• List image metadata and available images; retrieve by bankingImageId to obtain full image content.
• Transaction-based imageType values (CHECK, DEPOSIT_SLIP, DEPOSIT_CHECK) require transactionDate; DEPOSIT_SLIP and DEPOSIT_CHECK also require imageIdentifier.
• Statement-based imageType values (STATEMENT, CC_STATEMENT, DOCUMENT) require statementStartDate and statementEndDate; statementPreview may be enabled to return preview data in list responses.
• When using client credentials authentication, provide either hostUserId or loginId (mutually exclusive).
• Use institutionCustomerId to scope results to a specific business location (see the Get Customer Profile API for more details). This is specific to Business Banking users.

Scopes

Scope	Description
images:read	List and retrieve check, deposit, statement, and document images

Required headers

Header	Description
Authorization	Bearer {token} (OAuth V2)
transactionId	UUID used to trace and correlate requests across services for debugging and logging.

Error codes (BIS_*)

Code	Message	HTTP Status Code
BIS_00001	Could not retrieve check image. Date out of range or expired.	400
BIS_00002	Could not retrieve requested image(s). Date out of range or expired.	400
BIS_00003	The date provided could not be parsed or represented an invalid date.	400
BIS_00004	Image type cannot be null or empty.	400
BIS_00005	Image type is not supported.	400
BIS_00006	Account type is not supported for check image.	400
BIS_00007	Account types configured for requested image(s) at FI level are invalid.	400
BIS_00008	Transaction types configured for requested image(s) at FI level are invalid.	400
BIS_00009	Transaction image number is invalid or contains non-numeric characters.	400
BIS_00010	Transaction date cannot be null for requested image(s).	400
BIS_00011	Account id cannot be null or empty.	400
BIS_00012	Card Number cannot be null or empty.	400
BIS_00012	Image identifier cannot be null for requested image(s).	400
BIS_00013	Request is missing a transactionId header	400
BIS_00014	Request should only contain printable ASCII characters.	400
BIS_00015	One of the query parameter length is greater than max length.	400
BIS_00016	Request transactionId header is too long.	400
BIS_00017	Invalid query param.	400
BIS_00018	Start date or end date cannot be null for statement images.	400
BIS_00019	The start date cannot be after the end date.	400
BIS_00020	A location is required for BB users.	400
BIS_00021	BB user is missing user id in the request.	400
BIS_00022	The date cannot be null or empty.	400
BIS_00023	Request header is too long.	400
BIS_00024	Request callingAppId header is too long.	400
BIS_00025	One or more query params are invalid or blank	400
BIS_00026	The authorization for this request does not allow for one or more attributes to be passed as parameters	400
BIS_10000	Client error. Banking images request could not be completed.	400
BIS_10001	Full authentication was not provided in the request.	401
BIS_10002	The authentication token that was sent in the request is invalid.	401
BIS_10003	The authentication provided does not authorize this request.	403
BIS_10004	InstitutionCustomers not available in JWT.	403
BIS_10005	Unauthorized access.	401 or 403
BIS_20001	Check image retrieval was not successful.	500
BIS_20002	No statements available for users	200 (warning)
BIS_20007	Error interacting with FICDS Statement Image service.	200 (warning)
BIS_20008	No transaction found for the requested image.	404
BIS_20009	Account in the request not available	404
BIS_20022	User not found.	404
BIS_20023	HTTP Response from BB Service is not successful	500
BIS_30000	Check image feature is not enabled for this FI.	400
BIS_30001	Image retrieval is turned off for this account.	400
BIS_30002	Image(s) retrieval is turned off for this FI.	400
BIS_30004	Data not found.	404
BIS_30005	User is not entitled to view online statements.	400 or 401
BIS_30006	Entitlements or account response is blank.	400
BIS_88888	Internal validation error.	500
BIS_90000	Server cannot handle this request.	500
BIS_99988	Server can only handle JSON request. Other media types are not supported	415
BIS_99999	Server error. Banking images request could not be completed.	500

Endpoints

List Banking Images

Returns a list of available scanned banking document images based on the provided query

Get Banking Image by ID

Retrieves and returns a specific scanned banking document image—such as a check, deposit