TransferCheck

Capture front of check

Preprocess an image of the front of a check. The response includes the parsed MICR Line data, deposit amount, and a processed TIFF image that conforms to the ICL file standard. The response fields are in the same format as the input of the check deposit API. We recommend placing the check on a darker background, such as a darker shade if the check paper is white. The check itself should occupy the majority of the image. Additionally, we suggest using a higher DPI to ensure that the characters are easily recognizable. It is also advisable to correctly orient the check. Note that the MICR and amount parsing is still in Beta. We recommend you validate parsed data with the user before submitting a check deposit.

post/transfers/checks/image/front

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/checks/image/front
  • Auth: HTTP basic

Response

Successful response

deposit_amountinteger nullable required

Extracted deposit amount from the check image, in cents.

deposit_amount_confidencenumber double required

Confidence score (0-1) of the deposit amount extraction.

image_frontstring required

Base64-encoded TIFF image of the front of the check.

micr_lineobject nullable required

Extracted MICR line data from the check image.

micr_line_confidencenumber double required

Confidence score (0-1) of the MICR line extraction.

payer_addressstring required

Extracted payer address from the check image.

payer_address_confidencenumber double required

Confidence score (0-1) of the payer address extraction.

payer_namestring required

Extracted payer name from the check image.

payer_name_confidencenumber double required

Confidence score (0-1) of the payer name extraction.

receiver_addressstring required

Extracted receiver address from the check image.

receiver_address_confidencenumber double required

Confidence score (0-1) of the receiver address extraction.

receiver_namestring required

Extracted receiver name from the check image.

receiver_name_confidencenumber double required

Confidence score (0-1) of the receiver name extraction.

Changes

No recorded changes to this operation across all 1 revision of this API.