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 into valuable business insights. Supports .heic,.jpeg,.png,.pdf,.zip,.jpg,.heif,.webp. Min file size is 0kb. Max file size is 20mb.

Request​

Body

    meta.tags string[]

    Possible values: non-empty

    Default value: ``

    Tags you want to associate with the document.

    package_path string

    Possible values: non-empty

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

    bucket string

    Possible values: non-empty

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

    file_data string

    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

    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

    Possible values: non-empty

    An optional filename. Useful to determine file type.

    external_id string

    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.

    bounding_boxes boolean

    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

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

Responses​

A processed Check response.

Schema
    anyOf
    external_id string

    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
    external_id string

    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

    Possible values: <= 1

    The average OCR score of the page.

    width integer

    The width of the page.

    height integer

    The height of the page.

    is_front boolean

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

    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

    Possible values: <= 1

    The average OCR score of the whole document.

    model string

    Possible values: non-empty

    The version of the model used to process the document.

    fraud object

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

    pages object[]

    An array containing fraud info about each extracted page

  • Array [
    • anyOf
    is_lcd object
    score number

    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.

    four_corners_detected boolean

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

    flags object[]
  • Array [
    • score number

    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

  • ]
  • ]
    • score number

    Possible values: <= 1

    Confidence of Fraud Detector in it's prediction

    types string[]

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

    List of attributions which marked the document as fraud

    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.

  • ]
    • amount_text_value number

    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

    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

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

    custom_fields object

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

    property name* any

    Default value: [object Object]

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

    amount numberrequired

    Possible values: > 0

    The numeric value representing the amount found on the document.

    amount_text stringrequired

    Possible values: non-empty

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

    bank_address stringrequired

    Possible values: non-empty

    The address of the bank.

    bank_name stringrequired

    Possible values: non-empty

    The name of the bank.

    fractional_routing_number string

    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 stringrequired

    Possible values: non-empty

    The routing number from the found in the fractional_routing_number.

    check_number stringrequired

    Possible values: non-empty

    The check number.

    date stringrequired

    Possible values: non-empty

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

    memo stringrequired

    Possible values: non-empty

    The description found in the memo line of the check.

    payer_address stringrequired

    Possible values: non-empty

    The address of the payer.

    payer_name stringrequired

    Possible values: non-empty

    The name of the payer.

    receiver_address stringrequired

    Possible values: non-empty

    The address of the receiver.

    receiver_name stringrequired

    Possible values: non-empty

    The name of the receiver.

    is_signed boolean

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

    is_endorsed booleandeprecated

    deprecated and will be removed at 2024-11-10. Use endorsement.is_signed instead

    currency_code stringrequired

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

    endorsement object

    An object containing the endorsement details

    is_signed boolean

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

    is_mobile_or_remote_deposit_only boolean

    Presence of restricted endorsement text such as mobile or remote deposit only

    micr object

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

    routing_number string

    Possible values: non-empty

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

    account_number stringrequired

    Possible values: non-empty

    The bank account number.

    serial_number string

    Possible values: non-empty

    The serial number on checks.

    raw string

    Possible values: non-empty

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

Loading...