The check object contains the data extracted from check images that have been deposited to a Helix account.

check Object

PropertyData Type (length)Description
checkAmountdecimalThe amount for which the check was written.
checkImagesarrayAn array of checkImage objects.
checkNumberlong integer (64-bit integer)The number of the check written. It is the last group of numbers in the MICR line and will match the numbers in the top right corner of the check.
holdCodestringHold Code representing a hold placed on check deposit funds.
holdCodeDescription stringHold Code description of a holdCode.
payerAccountNumberMaskedstringPayer Account Number Masked with a first character as x followed by the last 4 digits of the account number (i.e., x1234)
payerInstitutionDescriptionstringThe name of the payer’s financial institution from where the check was drawn.
payerRoutingNumberstringThe routing number of the payer’s financial institution from where the check was drawn.
returnReasonstringReturn reason description of a returnReasonCode. This field is present only on a returned check.
returnReasonCodestringReturn reason code representing a return or a reversal of a check.
This field is present only on a returned check.

checkImage Object

PropertyData type (length)Description
downloadUrlstringGET url with a file content response object (similar to /bankdocument/download).
imageTypeenumImage representing an original check or a replacement check image. Possible values:
- CheckFront: Image representing front of the original check
- CheckBack: Image representing back of the original check
- ReturnCheckFront: Image representing front of the replacement check image
- ReturnCheckBack: Image representing back of the replacement check image