Skip to main content

Process a Check

POST 
/api/v8/partner/checks

Veryfi's Process a Check endpoint allows you to submit and extract data from unstructured documents such as Checks and turn them into valuable business insights. The Process a Check endpoint enables you to submit the following image formats: .jpeg,.heic,.jpg,.pdf,.webp,.png,.zip,.heif and retrieve extracted data in JSON format. The max file size is 20mb, min file size is 0.25kb. Rate limit is 20 requests per second.

Request​

Body

    bounding_boxes (boolean | null)

    A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.

    confidence_details (boolean | null)

    A field used to determine whether or not to return the score and ocr_score fields in the Document response.

    external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    meta.tags string[]

    Possible values: non-empty

    Default value: ``

    Tags you want to associate with the document.

    package_path (string | null)

    Possible values: non-empty

    A path to a file in an S3 bucket, e.g. 'some/receipt.jpg

    bucket (string | null)

    Possible values: non-empty

    An S3 bucket for 'package_path', e.g. 'documents'.

    file_data (string | null)

    Possible values: non-empty

    Used to upload a document via base64 encoded string, could be raw or data URI scheme. This is the least effective way to upload a document for processing. See file_urls or uploading zip files.

    file_url (string | null)

    Possible values: non-empty

    A URL to a publicly accessible document to be sent to Veryfi for processing.

    file_urls string[]

    Possible values: non-empty

    An array of URLs to publicly accessible documents to be sent to Veryfi for processing.

    file_name (string | null)

    Possible values: non-empty

    An optional filename. Useful to determine file type.

Responses​

Returns a processed Check.

Schema
    anyOf
    external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    meta object
    duplicates object[]

    An array of duplicate documents found in the system.

  • Array [
    • id integerrequired

    The id of the duplicate document.

    url urirequired

    Possible values: non-empty and <= 2083 characters

    The url of the duplicate document.

  • ]
    • external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    pages object[]

    Pages meta details

  • Array [
    • ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the page.

    width (integer | null)

    The width of the page.

    height (integer | null)

    The height of the page.

    is_front (boolean | null)

    Specifies whether the image represents the front side of the check.

    is_blurry ClassNullableBoolField

    The processed page is blurry or not

    score (number | null)

    Possible values: <= 1

    The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

    value (boolean | null)required

    The extracted value.

    tiff_url uri

    Possible values: non-empty and <= 2083 characters

    The urls of the tiff file.

  • ]
    • tags string[]

    Possible values: non-empty

    Default value: ``

    Tags associated with the document.

    ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the whole document.

    model (string | null)

    Possible values: non-empty

    The version of the model used to process the document.

    fraud ChecksFraud

    An object that contains additional information to help check for fraud.

    score (number | null)

    Possible values: <= 1

    Confidence of Fraud Detector in it's prediction

    color (string | null)

    Possible values: [green, yellow, red]

    Color from Fraud Detector: green means legitimate, yellow means review needed and red means fraud

    types string[]

    Possible values: [LCD photo, not a document, duplicate, screenshot, generated document, aspect ratio mismatch]

    List of attributions which marked the document as fraud

    pages object[]

    An array containing fraud info about each extracted page

  • Array [
    • anyOf
    is_lcd ClassBoolField
    score (number | null)

    Possible values: <= 1

    The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

    value booleanrequired

    The extracted value.

    flags object[]

    List of flags which marked the document as fraud

  • Array [
    • score (number | null)

    Possible values: <= 1

    The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

    value stringrequired

    Possible values: non-empty

  • ]
    • four_corners_detected (boolean | null)

    Indicates that all four corners of the check are visible and within the boundaries of the image.

  • ]
    • amount_text_value (number | null)

    The original amount_text found in the check converted to a float.

    handwritten_fields string[]

    Possible values: [amount, amount_text, bank_address, bank_name, fractional_routing_number, micr.raw, check_number, date, memo, payer_address, payer_name, receiver_address, receiver_name]

    Default value: ``

    Handwritten fields on check

    digital_tampering_fields string[]

    Possible values: [amount, amount_text, bank_address, bank_name, fractional_routing_number, micr.raw, check_number, date, memo, payer_address, payer_name, receiver_address, receiver_name]

    Default value: ``

    Digital tampering fields on check

    pdf_url uri

    Possible values: non-empty and <= 2083 characters

    A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

    id integerrequired

    The unique number created to identify the document.

    created_date date-timerequired
    updated_date date-timerequired
    img_thumbnail_url uri

    Possible values: non-empty and <= 2083 characters

    A signed URL to access the auto-generated thumbnail created for the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

    text (string | null)

    The text returned from converting the document into a machine-readable text format.

    custom_fields CustomFields

    A user-defined dictionary that contains all the custom fields generated by applying specific rules and regular expressions to the extracted data.

    amount (number | null)required

    The numeric value representing the amount found on the document.

    amount_text (string | null)required

    Possible values: non-empty

    The value as a string representing the amount found on the document.

    bank_address (string | null)required

    Possible values: non-empty

    The address of the bank.

    bank_name (string | null)required

    Possible values: non-empty

    The name of the bank.

    fractional_routing_number (string | null)

    Possible values: non-empty

    The numbers appearing as the denominator of a fraction that is printed in the upper portion of a check.

    routing_from_fractional (string | null)required

    Possible values: non-empty

    The routing number from the found in the fractional_routing_number.

    check_number (string | null)required

    Possible values: non-empty

    The check number.

    date (string | null)required

    Possible values: non-empty

    The date in ISO 8601 format. Typically found on invoices.

    memo (string | null)required

    Possible values: non-empty

    The description found in the memo line of the check.

    payer_address (string | null)required

    Possible values: non-empty

    The address of the payer.

    payer_name (string | null)required

    Possible values: non-empty

    The name of the payer.

    receiver_address (string | null)required

    Possible values: non-empty

    The address of the receiver.

    receiver_name (string | null)required

    Possible values: non-empty

    The name of the receiver.

    is_signed (boolean | null)

    Presence of a signature on the check (front of check image)

    currency_code (string | null)required

    Possible values: [BMD, RSD, AFN, LTL, XCD, ILS, BGN, JEP, QAR, GGP, NOK, HTG, CRC, NAD, EGP, SBD, YER, ARS, BHD, CAD, SOS, DKK, IMP, MKD, EEK, TWD, GNF, NZD, FKP, RON, LKR, SVC, BYR, MVR, TRY, USD, INR, LVL, GBP, AZN, GIP, SZL, UAH, KRW, UYU, BRL, KWD, SHP, JPY, KZT, ZAR, SGD, UGX, GTQ, HRK, NGN, LBP, ISK, BND, PAB, BSD, HUF, AUD, JMD, HNL, EUR, AED, IDR, LSL, ALL, TTD, MOP, TVD, RUB, TRL, BBD, GHC, SAR, PHP, BZD, VND, CZK, SEK, IQD, SRD, PYG, CUP, SCR, HKD, AMD, CNY, NIO, PKR, KGS, MXN, PLN, ZWD, MNT, NPR, DOP, LRD, COP, UZS, MUR, IRR, LAK, CLP, BWP, CHF, PEN, SYP, FJD, GEL, BOB, BAM, OMR, THB, VEF, KYD, KHR, AWG, GYD, MYR, MZN, ANG, KPW]

    endorsement object

    An object containing the endorsement details

    is_endorsed (boolean | null)

    Presence of an endorsement (back of check image). True if there is a signature, or a name that matches the payee name

    is_signed (boolean | null)

    Presence of an endorsement signature (back of check image).

    receiver_name (string | null)

    Possible values: non-empty

    Raw receiver name on endorsement.

    instructions (string | null)

    Possible values: non-empty

    Raw instructions on endorsement.

    mobile_or_remote_deposit MobileOrRemoteDeposit

    Mobile or remote desposit endorsement.

    checkbox (boolean | null)

    Presence of checked box indicating that the deposit is for mobile or remote deposit only.

    instructions (boolean | null)

    Presence of instructions stating that the deposit is for mobile or remote deposit only.

    is_mobile_or_remote_deposit_only (boolean | null)

    deprecated and will be removed at 2025-07-10. Use endorsement.mobile_or_remote_deposit instead

    micr object

    An object containing the details for the Magnetic ink character recognition.

    routing_number (string | null)

    Possible values: non-empty

    The Transit Field. It is always 8-9 digits, preceded by a ⑆, and followed by a ⑆.

    account_number (string | null)required

    Possible values: non-empty

    The bank account number.

    serial_number (string | null)

    Possible values: non-empty

    The serial number on checks.

    raw (string | null)

    Possible values: non-empty

    The text returned from converting the document into a machine-readable text format.

Loading...