Skip to main content

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​

ScopeDescription
images:readRead images

Required headers​

HeaderDescription
AuthorizationBearer {token} (OAuth V2)
transactionIdUUID used to trace and correlate requests across services for debugging and logging.

Error codes (BIS_*)​

CodeMessageHTTP Status Code
BIS_00001Could not retrieve check image. Date out of range or expired.400
BIS_00002Could not retrieve requested image(s). Date out of range or expired.400
BIS_00003The date provided could not be parsed or represented an invalid date.400
BIS_00004Image type cannot be null or empty.400
BIS_00005Image type is not supported.400
BIS_00006Account type is not supported for check image.400
BIS_00007Account types configured for requested image(s) at FI level are invalid.400
BIS_00008Transaction types configured for requested image(s) at FI level are invalid.400
BIS_00009Transaction image number is invalid or contains non-numeric characters.400
BIS_00010Transaction date cannot be null for requested image(s).400
BIS_00011Account id cannot be null or empty.400
BIS_00012Card Number cannot be null or empty.400
BIS_00012Image identifier cannot be null for requested image(s).400
BIS_00013Request is missing a transactionId header400
BIS_00014Request should only contain printable ASCII characters.400
BIS_00015One of the query parameter length is greater than max length.400
BIS_00016Request transactionId header is too long.400
BIS_00017Invalid query param.400
BIS_00018Start date or end date cannot be null for statement images.400
BIS_00019The start date cannot be after the end date.400
BIS_00020A location is required for BB users.400
BIS_00021BB user is missing user id in the request.400
BIS_00022The date cannot be null or empty.400
BIS_00023Request header is too long.400
BIS_00024Request callingAppId header is too long.400
BIS_00025One or more query params are invalid or blank400
BIS_00026The authorization for this request does not allow for one or more attributes to be passed as parameters400
BIS_10000Client error. Banking images request could not be completed.400
BIS_10001Full authentication was not provided in the request.401
BIS_10002The authentication token that was sent in the request is invalid.401
BIS_10003The authentication provided does not authorize this request.403
BIS_10004InstitutionCustomers not available in JWT.403
BIS_10005Unauthorized access.401 or 403
BIS_20001Check image retrieval was not successful.500
BIS_20002No statements available for users200 (warning)
BIS_20007Error interacting with FICDS Statement Image service.200 (warning)
BIS_20008No transaction found for the requested image.404
BIS_20009Account in the request not available404
BIS_20022User not found.404
BIS_20023HTTP Response from BB Service is not successful500
BIS_30000Check image feature is not enabled for this FI.400
BIS_30001Image retrieval is turned off for this account.400
BIS_30002Image(s) retrieval is turned off for this FI.400
BIS_30004Data not found.404
BIS_30005User is not entitled to view online statements.400 or 401
BIS_30006Entitlements or account response is blank.400
BIS_88888Internal validation error.500
BIS_90000Server cannot handle this request.500
BIS_99988Server can only handle JSON request. Other media types are not supported415
BIS_99999Server 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