Banking Images-overview

Banking Images

API - V 2.5

Download Swagger Spec

The Banking Images service API makes it possible to retrieve both a specific scanned document image and a list of available scanned document images.
As part of Digital Banking, the image of a paper document is an asset. Despite the growing trend of “going paperless”, the use of checks is still very prominent, especially in the B2B realm. Deposit slips are also still widely used, as merchants and consumers alike often make physical deposits. Monthly statements are available in physical or digital format. For the purposes of security, record-keeping, and funds verification, having the ability to access digitalized versions of documents is paramount.

Value

The Banking Images API enables endusers to:

Confirm a physical check, deposit slip or statement in just a few clicks.

It enables a financial institution (FI) to:

Build trust and enhance customer satisfaction and loyalty by maintaining accurate and easily referenced digital copies of important documents

It enables developers to:

Provide the customer with a quick review of any physical document related to their finances

What is Supported

While the technical documentation in the API Specs section describes the endpoints (or ways to call the API with different parameters to execute different actions), the following provides a simplified list of use cases for Banking Image Service:

‍GET (Retrieve) Image List: Data is returned for a set of available images based on query parameters:

Account: Checking, savings, etc.

Type: Check, deposit slip, statement

Date range:
Transaction date: Check, deposit slip
Statement date: Statement

Statement preview (if supported by image vendor)

Get (retrieve) individual image: This will call and retrieve display of a specific image (CHECK/ DEPOSIT SLIP/STATEMENT).
‍
Note: The returned list contains individual image IDs and other information to allow for the retrieval, viewing, and printing of individual images. The data could be used to build a UI component for the customer, listing available images and providing hyperlinks to select and view images.

Additional Product Details

GET Image List - Query parameters

Name	Type	Required	Valid Values	Description
imageType	string	Yes	CHECK/DEPOSIT_SLIP/STATEMENT	The type of the images to fetch
accountId	string	Yes	Chl6s5W5J4-RnGmJfTg7EL2VUy-_awzdHmUKVmbsZag	Identifier of the account for which the image(s) need to be fetched. This is a mandatory request parameter.
imageIdentifier	string	No	hJpyV4fzXJ67pnZBalBukaC-3oZNAT544OWR8ME-J9E	Identifier used to filter the transactions
transactionDate	string	No	{yyyy-MM-dd} 2010-04-01	Date of the transaction. This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
transactionImageNumber	string	No	{checkNumber/depositSlipNumber}	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.
statementStartDate	string	No	{yyyy-MM-dd} 2010-04-01	Start date of the statements. This is a required parameter when the imageType is STATEMENT.
statementEndDate	string	No	{yyyy-MM-dd} 2010-04-01	End date of the statements. This is a required parameter when the imageType is STATEMENT.
statementPreview	boolean	No	true/false	Parameter to support one online statement vendor. The vendor’s host request requires a PREVIEW parameter. This 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.
institutionCustomerId	string	no	d8d02a12236e47fc85cb8de35f24a6f0	LocationId for the business banking user for which online statements are being retrieved. This is a required parameter for BB User.

GET Individual Image - Query parameters

Name	Type	Required	Valid Values	Description
imageType	string	Yes	CHECK/DEPOSIT_SLIP/STATEMENT	The type of the images to fetch
accountId	string	Yes	Chl6s5W5J4-RnGmJfTg7EL2VUy-_awzdHmUKVmbsZag	Identifier of the account for which the image(s) need to be fetched. This is a mandatory request parameter.
statementDate	string	No	{yyyy-MM-dd} 2010-04-01	Date for a single statement. statementDate is not used for filtering multiple statements.
institutionCustomerId	string	no	d8d02a12236e47fc85cb8de35f24a6f0	LocationId for the business banking user for which online statements are being retrieved. This is a required parameter for BB User.

NOTE: The Banking Services API abstracts access to image vendors, and some of those vendors do not support all features supported by the API. Contact Technical Support for more information.