Image analysis

API reference

Returns an analysis of the check's image quality assurance (IQA) status based on the Fed's metrics.

Endpoint: /checks/v1/payments/{id}/analysis

GET

https://sandbox.crbcos.com/checks/v1/payments/{id}/analysis

Path Parameters

idstringrequired
Description
Check payment ID, in GUID format

Response

analysisobject
Description
Specific data analysis results
- acceptedboolean
  Description
  If true, the check was accepted . Otherwise, false.
- processingStatusstring
  Description
  The status of the image quality analysis. This correlates with the iqaMessage field.
- requestStatusstring
  Description
  The status of the request to the image processing service (submission of check data). Either Succeeded or Failed.
- processingIdstring
  Description
  Unique identifier for the processing record
- iqaMessagestring
  Description
  If the deposit failed because of the image quality analysis, provides the reason. For example, "image too small" or "MICR confidence." If the the IQA passes, shows the value IQAGOOD.
- transactionStatusCodeinteger
  Description
  Image processor code referring to the IQA status. If IQA is successful the value will be 0.
- transactionIdinteger
  Description
  Image processor mobile deposit transaction ID
- groupNamestring
  Description
  Image processor group name the user/transaction is part of
- organizationNamestring
  Description
  Image processor organization name the user/transaction is part of
- submissionDatestring
  Description
  Image processor transaction submission date (yyyy-mm-ddThh:mm:ss[.mmm])
- flexibleFieldsstring
  Description
  Internal field relating to image quality analysis
- readFieldsobject
  Description
  The fields on the check read by the analysis and their values. There can be multiple fields.
  - namestring
    Description
    Name of the field being read, for example, CheckNumber
  - valuestring
    Description
    he characters and/or numbers that appear in that field
  - confidencestring
    Description
    The percentage of confidence that the value was read correctly (does not always appear)
- testResultsobject
  Description
  Results of analysis of various fields and parameters on each side of the check. The response displays multiple results.
  - checkSidestring
    Description
    Side of the check being analyzed
  - namestring
    Description
    Name of the field or parameter being analyzed, for example, Cut Corners
  - valuestring
    Description
    Result of the analysis, for example, Passed or ManualReview
  - thresholdinteger
    Description
    The actual score of the tested field
  - confidencestring
    Description
    The percentage of confidence that the value was read correctly
idstring
Description
Check payment ID. This ID is in GUID format.
accountNumberstring
Description
Number of the account receiving the check
referenceIdstring
Description
The reference ID of the check payment, indicating the rail type in the first element of the string. In this case it is C. This is an internal Cross River attribute.
paymentTypestring
Description
The check paymentType indicates whether the check has been presented for payment or has been returned for some reason: - Forward (a check presented for payment, to be sent to the payer bank) - Return (A previous forward item that the payer bank returned)
checkTypestring
Description
Type of check being dealt with. There are several check types: - Standard - OnUs - Treasury - MoneyOrder - FedReserveBank - FedHomeLoan - StateLocalGovt - Certified - Unknown
direction string
Description
Check direction: - Inbound (A check drawn from a COS account, deposited at another bank. See Deposit.) - Outbound (A check deposited into a COS account, drawn from an account at another bank. See Withdrawal.)
statusstring
Description
Status of the check payment. There are several possible payment statuses: - Created - Pending - Hold - Batched - Processing - Completed - Rejected - Canceled
sourcestring
Description
Source of the payment request: - Api - PartnerPortal - OpsPortal - File - System - Lockbox
postingstring
Description
Posting status: - Pending - Posted - Failed - Canceled - Authorized - Authorizing
rejectionReasonstring
Description
- ImageAnalysisFailure - PostingException - AmountMismatch - MaxItemAmountExceeded - MaxDepositAmountExceeded - MaxItemsPerDayExceeded - Duplicate - PayerRoutingNumberInvalid - PayerAccountNumberInvalid - CheckNumberInvalid - AccountNotFound - DepositsNotEnabled - InvalidAccountType - NotSpecified
positivePayResultstring
Description
If Positive Pay is enabled, the positive pay status of the check: - Pending - Authorized - Unauthorized - Disabled
positivePayMatchIdstring
Description
If Positive Pay is enabled, ID of the positive pay record associated with the payment
postingCodestring
Description
Code related to the Cross River system transaction tied to the payment. Any value other than “OK” indicates a rejection.
clientBatchIdstring
Description
ID for the batch received from the Cross River lockbox vendor
clientBatchSequenceinteger
Description
Sequence number of the payment inside the batch received from the Cross River lockbox vendor
fedBatchIdstring
Description
ID of the distribution that the check was included in
fedBatchSequenceinteger
Description
Sequence number of the payment inside the distribution
coreTransactionIdstring
Description
Internal Cross River unique ID for the transaction
memoPostIdstring
Description
Unique identifier for the memo post. This ID is in GUID format.
originalPaymentIdstring
Description
The original payment ID, when a check has been returned or redeposited
customerIdstring
Description
The unique ID assigned to a customer when the customer record is created. You need this ID to take action for a specific customer. For example, when opening an account or adding an address to a customer record. The ID is in GUID format.
payerRoutingNumberstring
Description
The payer’s routing number (printed on the check)
payerAccountNumberstring
Description
The payer’s account number (printed on the check)
payeeNamestring
Description
Name written on the pay to the order of line of the check
checkNumberstring
Description
The serial number that appears on the check
bofdRoutingNumberstring
Description
The routing number of the bank where the check was first deposited
sequenceNumberstring
Description
The check sequence number
amountinteger
Description
Money amount that appears on the check
currencystring
Description
Currency of the check. For example, USD (US dollars)
micrstring
Description
The magnetic ink character recognition line, consisting of the routing number, account number and check number
recognizedAmountinteger
Description
The check amount recognized from the check image via OCR
iqaPassedboolean
Description
True if the check has passed the Fed’s image quality assurance standards, otherwise false
returnCodestring
Description
The return code indicates why the check was returned. There are several return codes.
hasFrontImageboolean
Description
True if the check image file includes the front of the check. Otherwise false.
hasBackImageboolean
Description
True if the check image file includes the back of the check. Otherwise false.
isRedepositboolean
Description
True if the check was deposited before. Otherwise false.
policy string
Description
The current availability policy type assigned to the deposit, defining the schedule for making funds available: - Standard - NewAccount - LargeDeposits - RedepositedCheck - RepeatedOverdrafts - OnUs - RCNoticeOfUnpaidReturn - RCSuspectFraud - RCFundingAccountOverdrafts - RCUnverifiedEndorsement - RCInconsistentInformation - RCErasuresOrAlterations - RCOutOfDateRoutingNumber - RCPostDatedOrStaleDate - RCPayingBankNotPaidIndication - RCLostOrDamaged - FiveDay - EmergencyConditions
schedulearray
Description
Funds availability schedule, determined by the policy, and based on whenever the check was released to the Fed in a distribution. Consists of a day-by-day breakdown based on calendar day, with each day’s availability amount displayed.
createdAtstring
Description
Date and time the check payment was created. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
canceledAtstring
Description
Date and time the check payment was canceled. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
rejectedAtstring
Description
Date and time the check payment was rejected. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
processedAtstring
Description
Date and time the check payment was processed. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
completedAtstring
Description
Date and time the check payment was completed. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
postedAtstring
Description
Date and time the check payment was posted In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
wasReturnedboolean
Description
True if the check was returned. Otherwise false.
purposestring
Description
Purpose of the deposited check
clientIdentifierstring
Description
Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.
depositBusinessDatestring
Description
The business date of the deposit in the format of yymmdd. This date is usually Day 1 of the schedule for making the funds available. If the check is deposited after the day's deposit cut-off time, Day 1 might be a different date. In that case, the processedAt date is Day 1.
lockboxVendorIdstring
Description
ID of the lockbox service receiving the paper checks and sending them via ICL to Cross River
productIdstring
Description
ID in GUID format of your specific product type on which the Cross River account is based. Provided by Cross River.
partnerIdstring
Description
Your ID in the Cross River system. This ID is in GUID format.
lastModifiedAtstring
Description
Internal Cross River value. Date and time the database entry was last modified. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

curl

curl --location 'https://sandbox.crbcos.com/checks/v1/payments/18619219-ccbb-45a6-a068-b30c008f7b47/analysis' \
--header 'Authorization: Bearer <token>'

nodejs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': 'sandbox.crbcos.com',
  'path': '/checks/v1/payments/18619219-ccbb-45a6-a068-b30c008f7b47/analysis',
  'headers': {
    'Authorization': 'Bearer <token>'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

req.end();

python

import http.client

conn = http.client.HTTPSConnection("sandbox.crbcos.com")
payload = ''
headers = {
  'Authorization': 'Bearer <token>'
}
conn.request("GET", "/checks/v1/payments/18619219-ccbb-45a6-a068-b30c008f7b47/analysis", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

ruby

require "uri"
require "net/http"

url = URI("https://sandbox.crbcos.com/checks/v1/payments/18619219-ccbb-45a6-a068-b30c008f7b47/analysis")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer <token>"

response = https.request(request)
puts response.read_body

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://sandbox.crbcos.com/checks/v1/payments/18619219-ccbb-45a6-a068-b30c008f7b47/analysis"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer <token>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

200

{
    "analysis": {
        "data": {
            "accepted": true,
            "processingStatus": "Passed",
            "requestStatus": "Succeeded",
            "processingId": "7014d18e-dce3-478d-9078-c35e3800815e",
            "iqaMessage": "IQAGOOD",
            "transactionStatusCode": 0,
            "transactionId": 1667429,
            "groupName": "Cross River Group",
            "organizationName": "Cross River",
            "submissionDate": "2025-06-30T04:42:26.942507-04:00",
            "flexibleFields": {},
            "readFields": [
                {
                    "name": "MICR",
                    "value": "d314074269dc28293886c1237",
                    "confidence": 1000
                },
                {
                    "name": "CheckRoutingNumber",
                    "value": "314074269"
                },
                {
                    "name": "CheckAccountNumber",
                    "value": "28293886"
                },
                {
                    "name": "CheckNumber",
                    "value": "1237"
                },
                {
                    "name": "RecognizedAmount",
                    "value": "1.00",
                    "confidence": 199
                }
            ],
            "testResults": [
                {
                    "checkSide": "Front",
                    "name": "MICR Confidence",
                    "value": "Passed",
                    "threshold": 500,
                    "confidence": 1000
                },
                {
                    "checkSide": "Front",
                    "name": "Amounts Match",
                    "value": "ManualReview",
                    "threshold": 500,
                    "confidence": 199
                },
                {
                    "checkSide": "Front",
                    "name": "Front Focus",
                    "value": "Passed",
                    "threshold": 350,
                    "confidence": 1000
                },
                {
                    "checkSide": "Back",
                    "name": "Back Focus",
                    "value": "Passed",
                    "threshold": 100,
                    "confidence": 595
                },
                {
                    "checkSide": "Front",
                    "name": "Shadow on Image",
                    "value": "Passed",
                    "threshold": 851,
                    "confidence": 1000
                },
                {
                    "checkSide": "Back",
                    "name": "Shadow on Image",
                    "value": "Passed",
                    "threshold": 851,
                    "confidence": 1000
                },
                {
                    "checkSide": "Front",
                    "name": "Contrast of Image",
                    "value": "Passed",
                    "threshold": 401,
                    "confidence": 1000
                },
                {
                    "checkSide": "Back",
                    "name": "Contrast of Image",
                    "value": "ManualReview",
                    "threshold": 401,
                    "confidence": 340
                },
                {
                    "checkSide": "Front",
                    "name": "Cut Corners",
                    "value": "Passed",
                    "threshold": 751,
                    "confidence": 1000
                },
                {
                    "checkSide": "Back",
                    "name": "Cut Corners",
                    "value": "Passed",
                    "threshold": 751,
                    "confidence": 1000
                },
                {
                    "checkSide": "Front",
                    "name": "Image Too Small",
                    "value": "Passed",
                    "threshold": 501,
                    "confidence": 1000
                },
                {
                    "checkSide": "Back",
                    "name": "Image Too Small",
                    "value": "Passed",
                    "threshold": 501,
                    "confidence": 1000
                },
                {
                    "checkSide": "Front",
                    "name": "Darkness",
                    "value": "Passed",
                    "threshold": 401,
                    "confidence": 863
                },
                {
                    "checkSide": "Back",
                    "name": "Darkness",
                    "value": "Passed",
                    "threshold": 401,
                    "confidence": 839
                },
                {
                    "checkSide": "Front",
                    "name": "View Angle",
                    "value": "Passed",
                    "threshold": 701,
                    "confidence": 970
                },
                {
                    "checkSide": "Back",
                    "name": "View Angle",
                    "value": "Passed",
                    "threshold": 701,
                    "confidence": 967
                },
                {
                    "checkSide": "Front",
                    "name": "Rotation Angle",
                    "value": "Passed",
                    "threshold": 701,
                    "confidence": 991
                },
                {
                    "checkSide": "Back",
                    "name": "Rotation Angle",
                    "value": "Passed",
                    "threshold": 701,
                    "confidence": 998
                },
                {
                    "checkSide": "Front",
                    "name": "Folded Or Torn Corner",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Folded Or Torn Corner",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Folded Or Torn Edge",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Folded Or Torn Edge",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Excessive Skew",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Excessive Skew",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Piggyback Document",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Piggyback Document",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Too Light",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Too Light",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Too Dark",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Too Dark",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Undersize Image",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Undersize Image",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Oversize Image",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Oversize Image",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Excessive Spot Noise",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Excessive Spot Noise",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Back",
                    "name": "Endorsement Presence",
                    "value": "ManualReview",
                    "threshold": 750,
                    "confidence": 2
                },
                {
                    "checkSide": "Front",
                    "name": "Aspect Ratio Validation",
                    "value": "Passed",
                    "threshold": 900,
                    "confidence": 998
                },
                {
                    "checkSide": "Front",
                    "name": "MICR Intrusion Detection",
                    "value": "Passed",
                    "threshold": 100,
                    "confidence": 1000
                },
                {
                    "checkSide": "Front",
                    "name": "Check Length",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Check Height",
                    "value": "Unknown",
                    "threshold": 0,
                    "confidence": 0
                },
                {
                    "checkSide": "Front",
                    "name": "Bitonal Image Size",
                    "value": "Passed",
                    "threshold": 500,
                    "confidence": 1000
                },
                {
                    "checkSide": "Back",
                    "name": "Bitonal Image Size",
                    "value": "Passed",
                    "threshold": 500,
                    "confidence": 1000
                }
            ]
        }
    },
    "id": "18619219-ccbb-45a6-a068-b30c008f7b47",
    "accountNumber": "2640511503",
    "referenceId": "C181DC3259D7",
    "paymentType": "Forward",
    "checkType": "Standard",
    "direction": "Outbound",
    "status": "Canceled",
    "source": "Api",
    "posting": "Canceled",
    "postingCode": "OK",
    "coreTransactionId": "31746634-977b-461f-9899-b30c008f7b47",
    "memoPostId": "51b24aa9-1cdc-4d82-9ddb-b30c008f7b47",
    "originalPaymentId": "18619219-ccbb-45a6-a068-b30c008f7b47",
    "customerId": "53c34cf0-4cd2-4768-937b-b30000dffdca",
    "payerRoutingNumber": "314074269",
    "payerAccountNumber": "28293886",
    "payeeName": "",
    "checkNumber": "1237",
    "bofdRoutingNumber": "021214891",
    "sequenceNumber": "2203615981",
    "amount": 10000,
    "currency": "usd",
    "micr": "d314074269dc28293886c1237",
    "recognizedAmount": 100,
    "iqaPassed": true,
    "hasFrontImage": true,
    "hasBackImage": true,
    "isRedeposit": false,
    "policy": "Standard",
    "schedule": [
        0,
        10000
    ],
    "createdAt": "2025-06-30T04:42:24.02-04:00",
    "canceledAt": "2025-06-30T05:02:14.083-04:00",
    "wasReturned": false,
    "purpose": "SKIP_IQA",
    "depositBusinessDate": "250701",
    "productId": "83bed086-8182-4151-a1e3-af5b01362783",
    "partnerId": "cd9c12f4-7691-424a-b38b-af5b0134c611",
    "lastModifiedAt": "2025-06-30T05:02:14.1158174-04:00"
}

Image analysis

API reference

﻿