Switch Language

Image Retrieval

The Image Retrieval API lets you retrieve the latest images of paid and deposited cheques as well as other deposit items for the U.S. and Canada. It involves calling a summary of your accounts, which will return account IDs you can then use to search for and retrieve available images.

Endpoints Summary

get
/accounts/transaction-images-accounts
Search for Accounts
post
/accounts/{accountId}/transaction-images/get
Search for Images
get
/accounts/{accountId}/transaction-images/{imageId}
Retrieve Images

Search for Images

Get a list of available images that match your search. You can search by account number, date range, amount and item type. You can get up to 1000 results at once. Then pick the images you want to download in TIFF format.

Post
/accounts/{accountId}/transaction-images/get

Request

Code Samples

Headers

x-fapi-customer-last-logged-time
string
x-fapi-customer-ip-address
string
x-api-key
string
x-fapi-interaction-id
string
x-client-id
string
x-fapi-customer-user-agent
string
Authorization
string

Path Parameters

accountId required
string
a pseudonymized representation of the account number

Body

SearchTransactionImagesRequest required

Response

FAQs