Skip to main content
Checks

Parameters

This page provides information about the required and optional parameters for check image requests. To help achieve a successful request, all required fields must be included. Optional fields offer additional functionality but are not required to initiate a request.

Required

The following table includes the required parameters to initiate a successful request:

Required

Field                                                                      

Description

Minimum

Maximum

Notes

accountNumber

The account number associated with the check.

2

17

financialInstitution.id

The identifier for the bank or financial institution.

1

11

Example:

  • ABA
  • BIC

financialInstitution.idType

Specifies the type of financial institution identifier. 

Allowed values are: 

  • USABA  
  • BIC  
  • SORT_CODE  
  • CLEARING_SYSTEM_ID

checkRange.start

The starting check number for a range search. This value is inclusive.

1

10
  • Supports range filtering.

checkRange.end

The ending check number for a range search. This value is inclusive.

1

10
  • Supports range filtering.

checkNumbers

 One or more specific check numbers to search for. Multiple check numbers can be provided. 

1

10
  • 1 to 5 items allowed.

Optional fields

The following table includes optional parameters that can be used to customize the request:

Optional

Field                            

Description

Minimum

Maximum

Notes

branchNumber

The branch of the bank or financial institution associated with the check. 

checkSeqNumber

A unique identifier for a specific check. 
  • Only numeric values are allowed.

issueDateGte

Filters for checks with an issue date greater than or equal to the specified date. 

10

10
  • Defaults to searching the past 90 days if not specified.
  • The date must be within one year of the issueDateLte value.
  • Format: ISO-8601 date.

issueDateLte

 Filters for checks with an issue date less than or equal to the specified date. 

10

10
  • The date must be within one year of the issueDateGte value.
  • Format: ISO-8601

postedDateGte

Represents a greater-or-equal match to support range style filtering on posted date. 

10

10
  • The date must be within one year of the postedDateLte value.
  • Format: ISO-8601.

postedDateLte

 Filters for checks with a posted date less than or equal to the specified date. 

10

10
  • The date must be within one year of the postedDateLte value.
  • Format: ISO-8601.

amountLte

 Filters for checks with an amount less than or equal to the specified value. 

1

18

amountGte

 Filters for checks with an amount greater than or equal to the specified value. 

1

18

imageFormat

Specifies the format of the returned check image.
  • Default: PNG
  • Allowed values:
    • TIFF
    • PNG
    • JPEG

limit

 Sets the maximum number of results to return. Used for pagination. Default is 5, for a range search.

1

10
  • Default: 5

offset

Indicates the page number for pagination. This is a zero-based value. Use 0 for the first page, then increment by 1 for subsequent pages. Do not alter other parameters during pagination. 

    
  • Default: 0

Next steps

Review available resources for check imaging.