Skip to main content

Search Documents

GET 
/api/v8/partner/documents

Veryfi's Search Documents endpoint retrieves previously processed documents, allowing users to search and filter specific content from a collection of documents. The Search Documents endpoint allows you to perform various tasks, including searching documents to find detailed information, organizing documents by date or relevance, and filtering documents based on different parameters. These tools can be helpful to locate and assess specific documents within an organization quickly.

Request​

Query Parameters

    page integer

    Default value: 1

    The page number. The response is capped to maximum of 50 results per page.

    page_size integer

    Default value: 50

    The number of Documents per page.

    Example: 10
    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.

    detailed boolean

    This field was deprecated on 2023-08-20. Use bounding_boxes and confidence_details.

    q string

    Case sensitive. Return documents with this text or any extracted fields matching the value exactly. Also matches external_id, notes. Use asterisk for partial matches, e.g. q=Walmart* will return documents with either Walmart in ocr text, any extracted field containing Walmart, or external_id or notes containing Walmart.

    Example: Walmart
    order_by string

    Default value: -created

    A field used to determine how to order the Documents in the response. For example, the value -created orders by created date with the most recent processed document at the top of the response.

    external_id string

    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.

    Example: 8675309
    device_id string
    device_user_uuid string
    status string

    The value indicating the document's status.

    Example: in_progress
    tag string

    An identifier used to help categorize or flag particular types of documents. Use this field to only return Documents with a specific tag. The Document object can have multiple tags. You can create tags by API or in Hub.

    Example: food
    owner string

    The API username for the account that processed the document.

    Example: garydouglas
    created__gt string

    Return documents created after this date and time in UTC ISO 8601 format.

    Example: 2022-05-03 00:00:00
    created__lt string

    Return documents created before this date and time in UTC ISO 8601 format.

    Example: 2023-03-23 00:00:00
    created__gte string

    Return documents created beginning at this date and time in UTC ISO 8601 format.

    Example: 2022-04-24 00:00:00
    created__lte string

    Return documents created on and before this date and time in UTC ISO 8601 format.

    Example: 2020-10-15 00:00:00
    updated__gt string

    Return documents updated after this date and time in UTC ISO 8601 format.

    Example: 2023-07-25 00:00:00
    updated__lt string

    Return documents updated before this date and time in UTC ISO 8601 format.

    Example: 2019-03-18 00:00:00
    updated__gte string

    Return documents updated beginning at this date and time in UTC ISO 8601 format.

    Example: 2020-02-03 00:00:00
    updated__lte string

    Return documents updated on and before this date and time in UTC ISO 8601 format.

    Example: 2023-01-03 00:00:00
    date__gt string

    Return documents with the date field greater than this date and time in UTC ISO 8601 format.

    Example: 2021-05-03 00:00:00
    date__lt string

    Return documents with the date field less than this date and time in UTC ISO 8601 format.

    Example: 2022-06-17 00:00:00
    date__gte string

    Return documents with the date field greater than or equal to this date and time in UTC ISO 8601 format.

    Example: 2022-02-14 00:00:00
    date__lte string

    Return documents with the date field less than or equal to this date and time in UTC ISO 8601 format.

    Example: 2023-05-03 00:00:00
    track_total_results boolean

    Whether to always return accurate total_results and total_pages, true makes it slower. For increased performance, total results are not counted by default for search requests (with q parameter), and counted for list requests.

Responses​

List of previously processed documents

Schema
    anyOf
    documents object[]required
  • Array [
    • 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.

    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-time

    The date and time the invoice or receipt was first submitted and processed in ISO 8601 format.

    updated_date date-time

    The date and time when the last update was made to the Document object in ISO 8601 format.

    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.

    accounting_entry_type (string | null)

    Possible values: [debit, credit]

    Classifies the document as credit or debit for accounting purposes.

    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.

    duplicate_of (integer | null)

    The ID of the first unique Document. This Document has been identified as a duplicate of another Document.

    exch_rate (number | null)

    The exchange rate is calculated by dividing the amount of the currency found on the document by your account's default currency. The exchange rate will be 1 if the document's currency matches your account's default currency or Veryfi cannot find a currency on the document.

    img_blur (boolean | null)deprecated

    The value indicating whether or not the image taken with the Lens SDK is blurry. Please use meta.pages.is_blurry instead

    img_file_name (string | null)

    Possible values: non-empty

    The filename and extension for the document submitted to Veryfi for processing. This is the filename and extension for the document hosted on Veryfi.

    img_url uri

    Possible values: non-empty and <= 2083 characters

    A signed URL to the original submitted image or the PDF generated from multiple images. The URL expires 15 minutes after the Document Response is returned and is re-assigned on every GET request.

    is_approved boolean

    A user-defined flag that can be assigned to the Document object. This parameter is helpful in expense management use cases.

    is_blurry boolean[]deprecated

    Deprecated. Please use meta.pages.is_blurry instead

    is_document (boolean | null)

    The value indicating whether or not the image submitted for processing is a receipt, invoice, or another supported document type.

    is_duplicate (boolean | null)

    The value indicating whether or not this Document has been identified as a duplicate of another Document on your account.

    line_items object[]

    A list of the products or services purchased or ordered on the submitted document.

  • Array [
    • id integerrequired

    The unique number created to identify the Line Item object.

    order integerrequired

    The value indicating the position of where the line item appears on the document.

    tags string[]

    Possible values: non-empty

    A user-defined list of identifiers that help to categorize or flag particular types of line items.

    text stringrequired

    Possible values: non-empty and <= 1000 characters

    The complete text returned for the line item, including prices, dates, etc.

    type stringrequired

    Possible values: [room, tax, parking, service, fee, delivery, product, food, alcohol, tobacco, transportation, fuel, refund, discount, payment, giftcard, donation, toll, lottery]

    The classification of the product. The line type predicted by Veryfi, e.g. food.

    product_info object

    Line item extra product info

    anyOf
    expanded_description stringrequired

    Possible values: non-empty

    brand (string | null)required

    Possible values: non-empty

    category string[]required

    Possible values: non-empty

    date date

    The date found on the document and associated with the line item in ISO 8601 format.

    description stringrequired

    Possible values: non-empty and <= 1000 characters

    The product or service's extracted name or description excluding date and price.

    full_description (string | null)

    Possible values: non-empty and <= 1000 characters

    The item text including dates, weight, etc.

    normalized_description (string | null)

    Possible values: non-empty

    The line item description with expanded words

    discount_price (number | null)

    The lower price after discount.

    discount_rate (number | null)

    The discount percentage that was applied to the line item.

    discount (number | null)

    The amount deducted from the total price for the line item.

    price (number | null)

    The unit price for the line item.

    quantity (number | null)

    The amount or number of units for the line item.

    reference (string | null)

    Possible values: non-empty

    section (string | null)

    Possible values: non-empty

    A grouping indicated by formatted text on the receipt or invoice.

    sku (string | null)

    Possible values: non-empty

    The Stock Keeping Unit (SKU) is the unique code associated with the product for the line item.

    tax_rate (number | null)

    The percent at which the individual or corporation is taxed for the line item.

    tax (number | null)

    The amount at which the individual or corporation is taxed for the product on this line item.

    total (number | null)

    The total price for this line item.

    subtotal (number | null)

    Total charges and credits before tip and tax, if applicable.

    unit_of_measure (string | null)

    Possible values: non-empty

    The unit of measurement for this line item.

    category (string | null)

    Possible values: non-empty

    The category is taken from the line item with the same SKU and/or description. Otherwise from the root category field.

    country_of_origin (string | null)

    Possible values: [IO, NA, PK, ZW, QA, RO, MT, ID, NF, MC, MW, PS, EC, SD, NG, AS, GF, GI, AE, HR, AU, SZ, CO, MO, VI, NE, RU, KR, YT, CL, ER, PA, DE, IS, TC, PG, AF, SE, VU, EE, CG, GR, CX, OM, MN, BH, DJ, GB, AN, KW, PW, CM, BF, PM, US, SO, TF, BZ, SL, LR, LT, SA, PY, GS, SY, GP, GG, CF, MG, PN, AZ, GD, JP, BL, CA, NO, CV, UY, BS, BN, GW, MX, MZ, KZ, HU, AO, LC, CU, GT, DM, PH, WS, KP, SR, AM, VC, LU, BY, VE, AI, VA, LY, PF, BD, BT, CR, FR, FM, TH, MF, CK, MY, PL, BM, ES, FO, IL, ST, TD, KN, NZ, BB, PR, SK, VN, ML, CD, NP, AX, PE, GL, IE, JE, AL, LV, LS, TT, BO, TZ, UA, AG, ET, NU, RW, AW, SM, NC, UM, AD, FI, EG, KE, MS, YE, GY, PT, VG, BG, GE, MR, NR, TR, AT, LI, RE, AQ, MH, MV, TN, SV, GH, HT, JO, MM, SI, SH, UZ, MP, KM, BE, HM, SG, SB, TL, FJ, MU, ME, BJ, CH, AR, TJ, KI, BW, CN, GQ, SJ, LB, TO, TV, GA, TG, HK, IM, BA, CI, MK, TM, KH, CY, ZA, LK, WF, MQ, SN, BI, DK, GN, NL, NI, FK, SC, IT, UG, CC, GM, BR, TW, CZ, KY, TK, RS, DZ, EH, DO, JM, MD, LA, KG, MA, IQ, ZM, IR, HN, BV, IN, GU]

    The country of manufacture, production, design, or brand origin where the product comes from.

    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.

    product_details object[]

    Product lookup details

  • Array [
    • avg_price (number | null)required

    The average price of the product

    brand (string | null)required

    Possible values: non-empty

    The brand name of the product

    ean (string | null)required

    Possible values: non-empty

    European Article Number (EAN) of the product

    extra_fields (object | null)required

    Additional fields for the product details

    gtin_14 (string | null)required

    Possible values: non-empty

    Global Trade Item Number (GTIN-14) of the product

    match_score (number | null)required

    Possible values: <= 1

    The match score of the product

    image (string | null)required

    Possible values: non-empty

    The image URL of the product

    image_url (string | null)required

    Possible values: non-empty

    Alternative field for the image URL of the product

    product_name stringrequired

    Possible values: non-empty

    The name of the product

    segment (string | null)required

    Possible values: non-empty

    The market segment of the product

    veryn stringrequired

    Possible values: non-empty

    The veryn identifier of the product

  • ]
    • end_date date

    A service end date identified for the line item in ISO 8601 format.

    gross_total (number | null)

    The line item total before deductions.

    hsn (string | null)

    Possible values: non-empty

    The Harmonized System Nomenclature (HSN) found for the line item.

    lot (string | null)

    Possible values: non-empty

    The batch or lot number for the line item.

    start_date date

    A service start date identified for the line item in ISO 8601 format.

    tax_code (string | null)

    Possible values: non-empty

    The classification of goods and services for tax purposes for the line item.

    manufacturer (string | null)

    Possible values: non-empty

    The name of the manufacturer of the product for the line item.

    net_total (number | null)

    The line item total after deductions.

    upc (string | null)

    Possible values: non-empty

    The Universal Product Code (UPC), European Article Number (EAN), or Global Trade Item Number (GTIN) found for the line item on this document will be placed in this field.

    weight (string | null)

    Possible values: non-empty

    The weight of the item for the line item. Usually found on logistic invoices.

  • ]
    • tax_lines object[]

    A detailed breakdown of tax elements usually found in a tax table.

  • Array [
    • order integerrequired

    The arrangement of tax lines in relation to each other.

    name stringrequired

    Possible values: non-empty

    The name of the sales tax type.

    rate numberrequired

    The tax rate (percentage) applied to the base amount.

    total (number | null)required

    The total amount of tax charged for this particular tax line item. If the document has multiple taxes on it those taxes will be returned in the list inside the taxes field. Note there are a couple of countries in the world that have 3 decimal places after the dot.

    base numberrequired

    The base amount of the tax applied.

    code (string | null)

    Possible values: non-empty

    The tax identification code.

    total_inclusive (number | null)

    The base rate + tax amount.

  • ]
    • model (string | null)

    Possible values: non-empty

    The data extraction model version number that was used to process the document.

    notes (string | null)

    Possible values: non-empty

    A user-defined text field that can be used to add any additional document-level information.

    ocr_text (string | null)

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

    payment_links string[]

    Possible values: non-empty

    Document payments links, included pdf hidden links

    reference_number (string | null)deprecated

    Possible values: non-empty

    Deprecated. Use id.

    status (string | null)

    Possible values: [processed, reviewed, archived]

    The value indicating the document's status.

    tags object[]

    A user-defined list of identifiers that help to categorize or flag particular types of documents. The Document object can have multiple tags. You can create tags by API or in Hub.

  • Array [
    • id integerrequired

    The ID of the tag.

    name stringrequired

    Possible values: non-empty

    The name of the tag.

  • ]
    • total_pages (integer | null)deprecated

    Deprecated. Use meta.total_pages.

    warnings string[]

    Possible values: non-empty

    An array of insights that highlight unusual behavior found on a document.

    meta objectrequired

    An object that describes document-related metadata information such as total pages.

    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.

    score numberrequired

    Possible values: <= 1

    How close is the match

  • ]
    • owner stringrequired

    Possible values: non-empty

    The API username for the account that processed the document.

    total_pages (integer | null)required

    The total number of pages found in the submitted document.

    processed_pages (integer | null)required

    The number of processed pages for the document. The default limit is 15 pages per document. Use max_processed_pages on the POST request to update the limit.

    pages object[]required
  • Array [
    • height (integer | null)required

    Possible values: > 0

    width (integer | null)required

    Possible values: > 0

    language object[]required

    Page languages in BCP-47 language tag, starting with the most confident prediction.

  • 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 (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • screenshot ScreenshotField
    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.

    type (string | null)required

    Possible values: [mobile_screenshot, other_screenshot, ai_generated]

    The predicted value of the screenshot type if the document is a screenshot.

    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.

  • ]
    • source_documents object[]required

    An array containing meta info about originally submitted documents

  • Array [
    • size_kb (integer | null)required
    height (integer | null)required
    width (integer | null)required
    exif (object | null)

    EXIF data from the source document

  • ]
    • fraud Fraud

    An object that contains additional information to help check for fraud. Does not work with the parameter boost_mode set to true.

    attribution (string | null)

    Possible values: non-empty

    Attribution of Fraud Detector's decision

    decision (string | null)

    Possible values: non-empty

    Fraud Detector's decision

    color (string | null)

    Possible values: [green, yellow, red]

    Color from Fraud Detector: green means legitimate, yellow means review needed and red means 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.

  • ]
    • images object[]deprecated

    deprecated and will be removed at 2023-11-10. Use meta.fraud.pages instead

  • Array [
    • anyOf
    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.

    is_lcd (boolean | null)

    The value indicating whether or not the image is a picture of an LCD screen.

  • ]
    • score (number | null)

    Possible values: <= 1

    Confidence of Fraud Detector in it's prediction

    version (string | null)

    Possible values: non-empty

    The Fraud Detector version. The latest version in action while the document was processed. Different versions may have their own ways of calculating the score and deducing the color string value.

    submissions object

    The amount of submissions from specific device id.

    property name* integer
    fraudulent_pdf object

    Results of the pdf analysis.

    property name* number
    types string[]

    Possible values: [other, handwritten characters, digital tampering, generated document, LCD photo, screenshot, not a document, duplicate, high velocity, fraudulent pdf, invalid qr data, critical velocity, similar documents, multiple profiles or devices, fraud history, emulated device, blocked device]

    Default value: ``

    List of attributions which marked the document as fraud

    digital_tampering_fields string[]

    Possible values: Value must match regular expression ^(tax_name|ship_to_address|delivery|summary_total|tax_code|total|subtotal|vin_number|delivery_note_number|tax_rate|vendor_account_currency|vending_person_number|balance|card_number|raw_vendor_name|previous_balance|bill_to_address|phone_number|bill_to_name|vendor_bank_address|end_date|vat_number|final_balance|vendor_account_number|tip|delivery_date|hsn|bill_to_phone_number|charge_total|vendor_bank_swift|cashback|vendor_email|vendor_iban|terms|biller_code|total_currency_code|start_time|order_date|end_time|vendor_web|tax_base|start_date|vendor_reg_number|total_quantity|insurance|account_number|vending_person|reference|invoice_number|vendor_bank_number|vendor_logo_name|rounding|due_date|abn_number|guest_count|bill_to_vat_number|store_number|charge_name|vendor_address|total_weight|so_number|bill_to_email|discount|total_in_words|ship_date|incoterms|po_number|time|date|license_plate_number|summary_name|vendor_bank_name|ship_to_name|document_title|tax|fax_number|tracking_number|bill_to_reg_number|line_items\.\d{1,4}\.(?:discount_rate|discount|section|end_date|start_date|full_description|tax_code|total|weight|subtotal|sku|coo|hsn|discount_price|tax_rate|date|mnf|balance|description|lot|price|tax|taxes|unit_of_measure|quantity|upc)|tax_breakdown\.\d{1,4}\.(?:tax_inclusive|tax_name|tax_rate|tax_base|tax_code|tax)|summary\.\d{1,4}\.(?:summary_name|summary_total)|bank_breakdown\.\d{1,4}\.(?:vendor_bank_address|vendor_bank_numbers|vendor_bank_swift|vendor_account_currency|vendor_bank_name|vendor_iban|vendor_bank_names|vendor_account_number|vendor_bank_addresses|vendor_bank_number))$

    List of fields which were digitally tampered. Does not work with the parameter boost_mode set to true.

    fraud_review FraudReview

    An object that contains information about the fraud review.

    decision (string | null)

    Possible values: [fraud, not fraud, unknown]

    The review decision for the document

    types string[]

    Possible values: [other, handwritten characters, digital tampering, generated document, LCD photo, screenshot, not a document, duplicate, high velocity, fraudulent pdf, invalid qr data]

    Default value: ``

    What kind of fraud type

    warnings object[]

    An array of warnings to help catch errors or fraud on the processed document. This is also related to the integrity checks on a document such as subtotal not matching the sum of line item totals. Does not work with the parameter boost_mode set to true.

  • Array [
    • type stringrequired

    Possible values: [tax_rate_missmatch, item_counts_missmatch, totals_missmatch, line_item_amount_missmatch, line_item_repeats, barcode_decoding_issue, barcode_code_missing_in_ocr, logo_vendor_missmatch, malware]

    Type of the warning, e.g. barcode_code_missing_in_ocr. Type is an enumerated field and comes from a defined number of enumerated values.

    message stringrequired

    Possible values: non-empty

    The detailed message about the warning.

  • ]
    • handwritten_fields string[]

    Possible values: Value must match regular expression ^(tax_name|ship_to_address|delivery|summary_total|tax_code|total|subtotal|vin_number|delivery_note_number|tax_rate|vendor_account_currency|vending_person_number|balance|card_number|raw_vendor_name|previous_balance|bill_to_address|phone_number|bill_to_name|vendor_bank_address|end_date|vat_number|final_balance|vendor_account_number|tip|delivery_date|hsn|bill_to_phone_number|charge_total|vendor_bank_swift|cashback|vendor_email|vendor_iban|terms|biller_code|total_currency_code|start_time|order_date|end_time|vendor_web|tax_base|start_date|vendor_reg_number|total_quantity|insurance|account_number|vending_person|reference|invoice_number|vendor_bank_number|vendor_logo_name|rounding|due_date|abn_number|guest_count|bill_to_vat_number|store_number|charge_name|vendor_address|total_weight|so_number|bill_to_email|discount|total_in_words|ship_date|incoterms|po_number|time|date|license_plate_number|summary_name|vendor_bank_name|ship_to_name|document_title|tax|fax_number|tracking_number|bill_to_reg_number|line_items\.\d{1,4}\.(?:discount_rate|discount|section|end_date|start_date|full_description|tax_code|total|weight|subtotal|sku|coo|hsn|discount_price|tax_rate|date|mnf|balance|description|lot|price|tax|taxes|unit_of_measure|quantity|upc)|tax_breakdown\.\d{1,4}\.(?:tax_inclusive|tax_name|tax_rate|tax_base|tax_code|tax)|summary\.\d{1,4}\.(?:summary_name|summary_total)|bank_breakdown\.\d{1,4}\.(?:vendor_bank_address|vendor_bank_numbers|vendor_bank_swift|vendor_account_currency|vendor_bank_name|vendor_iban|vendor_bank_names|vendor_account_number|vendor_bank_addresses|vendor_bank_number))$

    List of fields which were handwritten. Does not work with the parameter boost_mode set to true.

    device_id (string | null)

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    Fingerprint of the device used to process the document.

    device_user_uuid (string | null)

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    Fingerprint of the user who processed the document on a particular device.

    device_data ResponseDeviceData
    lat (number | null)

    Latitude where the document was uploaded from the current device's location

    lng (number | null)

    Longitude where the document was uploaded from the current device's location

    source string

    Possible values: [api.email, api.web, api, lens.bill, lens.invoice, lens.long_receipt, lens.other, lens.receipt, lens.web, lens]

    Default value: api

    The source of the document's submission for processing.

    language object[]required

    Document languages in BCP-47 language tag, starting with the most confident prediction.

  • 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 (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • ocr_score (number | null)required

    Possible values: <= 1

    The average OCR score of the whole document.

    account_number DetailedField

    The unique identifier of the customer assigned by the vendor.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    balance DetailedField

    The invoice or bill balance.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    barcodes object[]

    An array of barcodes extracted from the document if found.

  • Array [
    • bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    data (string | null)

    Possible values: non-empty

    The machine-readable representation of the barcode found on the document.

    type (string | null)

    Possible values: non-empty

    The name of the encoding for the barcode. Supported types include: QR Code, PDF417, EAN, UPC, Code128, Code39, I25

  • ]
    • bill_to DetailedBillTo

    An object that describes a person or business that is billed for the amount found on the document.

    name DetailedField

    The payer's name found in the billing section of the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    address DetailedField

    The payer's address found in the billing section of the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vat_number DetailedField

    The value-added tax identification number (VAT) for the payer and found on the document. VAT numbers can be found on European invoices. For United States invoices, the Employer Identification Number (EIN) of the payer.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    phone_number DetailedField

    The payer's phone number found in the billing section of the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    reg_number DetailedField

    The payer's registration number found in the billing section of the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    email DetailedField

    The payer's email address found in the billing section of the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    parsed_address ParsedAddress

    An object representing detailed address-related information on the document, such as the city, state, street address, unit number, etc. Filled in the original POST request had the parameter parse_address set to true and the corresponding address is found on the document.

    building (string | null)

    Possible values: non-empty

    The building name e.g. 'Project 8' or 'Empire State Building'

    city (string | null)

    Possible values: non-empty

    The settlement including cities, towns, villages, hamlets, localities, etc.

    country (string | null)

    Possible values: non-empty

    The sovereign nations and their dependent territories, anything with an ISO-3166 code.

    country_alpha_2 (string | null)

    Possible values: non-empty

    The detected ISO 3166-1 alpha-2 code for a given country.

    postcode (string | null)

    Possible values: non-empty

    The postal code used for mail sorting

    state (string | null)

    Possible values: non-empty

    A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well

    street_address (string | null)

    Possible values: non-empty

    A sum of house_number road, building, unit.

    house (string | null)

    Possible values: non-empty

    The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".

    house_number (string | null)

    Possible values: non-empty

    Usually refers to the external (street-facing) building number. In some countries this may be a compound, hyphenated number, which also includes an apartment number, or a block number (a la Japan).

    road (string | null)

    Possible values: non-empty

    Street name(s)

    unit (string | null)

    Possible values: non-empty

    An apartment, unit, office, lot, or other secondary unit designator.

    level (string | null)

    Possible values: non-empty

    The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.

    staircase (string | null)

    Possible values: non-empty

    Numbered/lettered staircase

    entrance (string | null)

    Possible values: non-empty

    Numbered/lettered entrance

    po_box (string | null)

    Possible values: non-empty

    The post office box, typically found in non-physical (mail-only) addresses.

    suburb (string | null)

    Possible values: non-empty

    An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".

    city_district (string | null)

    Possible values: non-empty

    The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".

    island (string | null)

    Possible values: non-empty

    Named islands e.g. "Maui"

    state_district (string | null)

    Possible values: non-empty

    Usually a second-level administrative division or county.

    country_region (string | null)

    Possible values: non-empty

    Informal subdivision of a country without any political status.

    world_region (string | null)

    Possible values: non-empty

    Only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".

    cashback DetailedField

    The amount of cash the customer has withdrawn when making a purchase. Cashback can be found on a receipt but does not appear on invoices.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    category object

    A category predicted from sent categories, user categories or default ones.

    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 (string | null)required

    Possible values: non-empty

    The extracted value.

    confidence_details (boolean | null)deprecated

    Deprecated on 2024-12-27.

    country_code DetailedCountryField

    The country code of a document, e.g. where it was issued or where the vendor provides services

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: [IO, NA, PK, ZW, QA, RO, MT, ID, NF, MC, MW, PS, EC, SD, NG, AS, GF, GI, AE, HR, AU, SZ, CO, MO, VI, NE, RU, KR, YT, CL, ER, PA, DE, IS, TC, PG, AF, SE, VU, EE, CG, GR, CX, OM, MN, BH, DJ, GB, AN, KW, PW, CM, BF, PM, US, SO, TF, BZ, SL, LR, LT, SA, PY, GS, SY, GP, GG, CF, MG, PN, AZ, GD, JP, BL, CA, NO, CV, UY, BS, BN, GW, MX, MZ, KZ, HU, AO, LC, CU, GT, DM, PH, WS, KP, SR, AM, VC, LU, BY, VE, AI, VA, LY, PF, BD, BT, CR, FR, FM, TH, MF, CK, MY, PL, BM, ES, FO, IL, ST, TD, KN, NZ, BB, PR, SK, VN, ML, CD, NP, AX, PE, GL, IE, JE, AL, LV, LS, TT, BO, TZ, UA, AG, ET, NU, RW, AW, SM, NC, UM, AD, FI, EG, KE, MS, YE, GY, PT, VG, BG, GE, MR, NR, TR, AT, LI, RE, AQ, MH, MV, TN, SV, GH, HT, JO, MM, SI, SH, UZ, MP, KM, BE, HM, SG, SB, TL, FJ, MU, ME, BJ, CH, AR, TJ, KI, BW, CN, GQ, SJ, LB, TO, TV, GA, TG, HK, IM, BA, CI, MK, TM, KH, CY, ZA, LK, WF, MQ, SN, BI, DK, GN, NL, NI, FK, SC, IT, UG, CC, GM, BR, TW, CZ, KY, TK, RS, DZ, EH, DO, JM, MD, LA, KG, MA, IQ, ZM, IR, HN, BV, IN, GU]

    currency_code DetailedCurrencyChoice

    The currency code in ISO 4217 format. The exchange_rate field will be enriched if the currency found on the document is different from the account's default currency.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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 (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]

    date EnrichedDetailedDatetimeField

    The date and time found on the document in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value date-timerequired
    default_category DetailedDefaultCategoryFieldType
    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 (string | null)required

    Possible values: [other, Job Supplies, Meals & Entertainment, Travel, Automotive, Office Supplies & Software, Food and Groceries, Gifts & Donations, Transportation, Repairs & Maintenance, Utilities, Legal & Professional Services, Advertising & Marketing, Payroll Expenses, Contractors, Rent & Lease, Insurance, Taxes & Licenses, Bank Charges & Fees, Healthcare, Postage & Delivery, Clothing & Shoes, Household, Interest Paid, Training & Education, Dues and Subscriptions]

    delivery_date EnrichedDetailedDatetimeField

    The date of an order's delivery in ISO 8601 format. Typically found on invoices.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value date-timerequired
    delivery_note_number DetailedField

    The unique identification number found on the delivery note. Delivery notes have a similar format to invoices but usually titled 'Delivery Note'.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    discount DetailedFloatField

    The amount deducted from the gross price.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    document_reference_number DetailedField

    The identification number for the document. Commonly used to identify items for a particular customer.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    document_title DetailedField

    The title found on the document. The title is usually located at the top of the document. Common examples of document titles include Invoice, Vendor Credit, and Purchase Order.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    document_type DetailedDocumentTypeFieldType

    A classification of the document, such as invoice, purchase_order, receipt, remittance_advice, or other.

    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 (string | null)required

    Possible values: [other, receipt, invoice, statement, purchase_order, check, w9, packing_slip, contract, w8, remittance_advice]

    due_date EnrichedDetailedDateField

    The date and time the payment is due for an invoice in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    final_balance (number | null)

    The invoice balance. If the invoice is paid, the final balance is 0, but if the invoice is not paid, the value is equal to the total.

    guest_count DetailedField

    The number of guests or seats extracted from the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    incoterms DetailedField

    The incoterms to specify who pays and manages the shipment, insurance, documentation, customs clearance, and other logistics.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    insurance DetailedFloatField

    The insurance cost. Typically found on invoices.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    invoice_number EnrichedDetailedField

    The identification number for the document. Typically found on invoices.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    is_money_in DetailedBoolField

    This parameter is used in the Expense Management application. The value is true if the document has a refund or credit note.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value booleanrequired
    is_transaction DetailedBoolField

    This flag marks card slips as true.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value booleanrequired
    license_plate_number DetailedField

    The vehicle license plate number.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    line_items_with_scores object[]

    A list of the products or services purchased or ordered on the submitted document with confidence details.

  • Array [
    • id integerrequired

    The unique number created to identify the Line Item object.

    order integerrequired

    The value indicating the position of where the line item appears on the document.

    tags string[]

    Possible values: non-empty

    A user-defined list of identifiers that help to categorize or flag particular types of line items.

    text stringrequired

    Possible values: non-empty and <= 1000 characters

    The complete text returned for the line item, including prices, dates, etc.

    type stringrequired

    Possible values: [room, tax, parking, service, fee, delivery, product, food, alcohol, tobacco, transportation, fuel, refund, discount, payment, giftcard, donation, toll, lottery]

    The classification of the product. The line type predicted by Veryfi, e.g. food.

    product_info object

    Line item extra product info

    anyOf
    expanded_description stringrequired

    Possible values: non-empty

    brand (string | null)required

    Possible values: non-empty

    category string[]required

    Possible values: non-empty

    date EnrichedDetailedDateField

    The date found on the document and associated with the line item in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    description DetailedField

    The product or service's extracted name or description excluding date and price.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    full_description DetailedField

    The item text including dates, weight, etc.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    normalized_description DetailedField

    The line item description with expanded words

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    discount_price DetailedFloatField

    The lower price after discount.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    discount_rate DetailedFloatField

    The discount percentage that was applied to the line item.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    discount DetailedFloatField

    The amount deducted from the total price for the line item.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    price EnrichedDetailedFloatField

    The unit price for the line item.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    quantity EnrichedDetailedFloatField

    The amount or number of units for the line item.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    reference DetailedField

    A reference number for the line item found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    section DetailedField

    A grouping indicated by formatted text on the receipt or invoice.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    sku DetailedField

    The Stock Keeping Unit (SKU) is the unique code associated with the product for the line item.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    tax_rate EnrichedDetailedFloatField

    The percent at which the individual or corporation is taxed for the line item.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    tax EnrichedDetailedFloatField

    The amount at which the individual or corporation is taxed for the product on this line item.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    total EnrichedDetailedDateField

    The total price for this line item.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    subtotal DetailedFloatField

    Total charges and credits before tip and tax, if applicable.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    unit_of_measure DetailedField

    The unit of measurement for this line item.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    category object

    The category is taken from the line item with the same SKU and/or description. Otherwise from the root category field.

    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 (string | null)required

    Possible values: non-empty

    The extracted value.

    country_of_origin DetailedCountryField

    The country of manufacture, production, design, or brand origin where the product comes from.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: [IO, NA, PK, ZW, QA, RO, MT, ID, NF, MC, MW, PS, EC, SD, NG, AS, GF, GI, AE, HR, AU, SZ, CO, MO, VI, NE, RU, KR, YT, CL, ER, PA, DE, IS, TC, PG, AF, SE, VU, EE, CG, GR, CX, OM, MN, BH, DJ, GB, AN, KW, PW, CM, BF, PM, US, SO, TF, BZ, SL, LR, LT, SA, PY, GS, SY, GP, GG, CF, MG, PN, AZ, GD, JP, BL, CA, NO, CV, UY, BS, BN, GW, MX, MZ, KZ, HU, AO, LC, CU, GT, DM, PH, WS, KP, SR, AM, VC, LU, BY, VE, AI, VA, LY, PF, BD, BT, CR, FR, FM, TH, MF, CK, MY, PL, BM, ES, FO, IL, ST, TD, KN, NZ, BB, PR, SK, VN, ML, CD, NP, AX, PE, GL, IE, JE, AL, LV, LS, TT, BO, TZ, UA, AG, ET, NU, RW, AW, SM, NC, UM, AD, FI, EG, KE, MS, YE, GY, PT, VG, BG, GE, MR, NR, TR, AT, LI, RE, AQ, MH, MV, TN, SV, GH, HT, JO, MM, SI, SH, UZ, MP, KM, BE, HM, SG, SB, TL, FJ, MU, ME, BJ, CH, AR, TJ, KI, BW, CN, GQ, SJ, LB, TO, TV, GA, TG, HK, IM, BA, CI, MK, TM, KH, CY, ZA, LK, WF, MQ, SN, BI, DK, GN, NL, NI, FK, SC, IT, UG, CC, GM, BR, TW, CZ, KY, TK, RS, DZ, EH, DO, JM, MD, LA, KG, MA, IQ, ZM, IR, HN, BV, IN, GU]

    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.

    end_date EnrichedDetailedDateField

    A service end date identified for the line item in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    gross_total EnrichedDetailedFloatField

    The line item total before deductions.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    hsn DetailedField

    The Harmonized System Nomenclature (HSN) found for the line item.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    lot DetailedField

    The batch or lot number for the line item.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    start_date EnrichedDetailedDateField

    A service start date identified for the line item in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    tax_code DetailedField

    The classification of goods and services for tax purposes for the line item.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    manufacturer DetailedField

    The name of the manufacturer of the product for the line item.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    net_total EnrichedDetailedFloatField

    The line item total after deductions.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    upc DetailedField

    The Universal Product Code (UPC), European Article Number (EAN), or Global Trade Item Number (GTIN) found for the line item on this document will be placed in this field.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    weight DetailedField

    The weight of the item for the line item. Usually found on logistic invoices.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • order_date EnrichedDetailedDateField

    The date when the goods or services were ordered in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    payment DetailedPayment

    An object that represents detailed information about the payment method related to this document.

    card_number DetailedField

    The last found digits of a credit or debit card number found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    display_name (string | null)

    Possible values: non-empty

    The card type plus the last four digits of the card number found on the document.

    terms DetailedField

    The terms on when and how to pay found on the document. Typically found on invoices.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    type DetailedPaymentTypePrediction

    The payment type found on the document.

    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 (string | null)required

    Possible values: [none, master_card, visa, cash, american_express, interac, other, maestro, discover, bancontact, girocard, paypal, applepay, bancomat, octopus, check, bankaxept, card, waon, mada, jcb, bank-to-bank_transfer_bacs, wechat, alipay, pix, unionpay, rupay, bpay, shopeepay, googlepay, giftcard, paypay]

    previous_balance DetailedFloatField

    The previous invoice balance.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    purchase_order_number DetailedField

    The unique identification number assigned to a purchase order document. A purchase order is a document given from a buyer to a seller that details the quantity, prices, and total cost of requested goods and services.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    rounding DetailedFloatField

    An extracted 'discount' (rounding) that vendors give to customers so they do not have to pay with small coins. For example, if a customer paid with cash and a vendor did not have a change of 4 cents, they would round the number and return 5 cents.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    server_name DetailedField

    The restaurant's server name.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    service_start_date EnrichedDetailedDateField

    The date indicating the beginning of a service. The start date could be a flight departure date or hotel arrival date in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    service_end_date EnrichedDetailedDateField

    The date indicating the end of a service. The end date could be a flight arrival date or hotel departure date in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    ship_date EnrichedDetailedDateField

    The date when the order was or will be shipped in ISO 8601 format.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value daterequired
    ship_to DetailedShipTo

    An object that represents the information about a person or business receiving an order.

    address DetailedField

    The delivery address found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    name DetailedField

    The name of the person or business who will receive the delivery and found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    parsed_address ParsedAddress

    An object representing detailed address-related information on the document, such as the city, state, street address, unit number, etc. Filled in the original POST request had the parameter parse_address set to true and the corresponding address is found on the document.

    building (string | null)

    Possible values: non-empty

    The building name e.g. 'Project 8' or 'Empire State Building'

    city (string | null)

    Possible values: non-empty

    The settlement including cities, towns, villages, hamlets, localities, etc.

    country (string | null)

    Possible values: non-empty

    The sovereign nations and their dependent territories, anything with an ISO-3166 code.

    country_alpha_2 (string | null)

    Possible values: non-empty

    The detected ISO 3166-1 alpha-2 code for a given country.

    postcode (string | null)

    Possible values: non-empty

    The postal code used for mail sorting

    state (string | null)

    Possible values: non-empty

    A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well

    street_address (string | null)

    Possible values: non-empty

    A sum of house_number road, building, unit.

    house (string | null)

    Possible values: non-empty

    The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".

    house_number (string | null)

    Possible values: non-empty

    Usually refers to the external (street-facing) building number. In some countries this may be a compound, hyphenated number, which also includes an apartment number, or a block number (a la Japan).

    road (string | null)

    Possible values: non-empty

    Street name(s)

    unit (string | null)

    Possible values: non-empty

    An apartment, unit, office, lot, or other secondary unit designator.

    level (string | null)

    Possible values: non-empty

    The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.

    staircase (string | null)

    Possible values: non-empty

    Numbered/lettered staircase

    entrance (string | null)

    Possible values: non-empty

    Numbered/lettered entrance

    po_box (string | null)

    Possible values: non-empty

    The post office box, typically found in non-physical (mail-only) addresses.

    suburb (string | null)

    Possible values: non-empty

    An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".

    city_district (string | null)

    Possible values: non-empty

    The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".

    island (string | null)

    Possible values: non-empty

    Named islands e.g. "Maui"

    state_district (string | null)

    Possible values: non-empty

    Usually a second-level administrative division or county.

    country_region (string | null)

    Possible values: non-empty

    Informal subdivision of a country without any political status.

    world_region (string | null)

    Possible values: non-empty

    Only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".

    shipping DetailedFloatField

    The cost of shipping or delivery of a package.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    store_number DetailedField

    The subsidiaries, vendor, corporation, or organization identification number used for unique referencing.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    subtotal EnrichedDetailedFloatField

    Total charges and credits before tip and tax, if applicable.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    tax EnrichedDetailedFloatField

    The tax amount applied to the purchase(s).

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    tax_lines_with_scores object[]

    A detailed breakdown of tax elements usually found in a tax table.

  • Array [
    • order integerrequired

    The arrangement of tax lines in relation to each other.

    name DetailedFieldrequired

    The name of the sales tax type.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    rate EnrichedDetailedFloatFieldrequired

    The tax rate (percentage) applied to the base amount.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    total DetailedFloatFieldrequired

    The total amount of tax charged for this particular tax line item. If the document has multiple taxes on it those taxes will be returned in the list inside the taxes field. Note there are a couple of countries in the world that have 3 decimal places after the dot.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    base DetailedFloatFieldrequired

    The base amount of the tax applied.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    code DetailedField

    The tax identification code.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    total_inclusive DetailedFloatField

    The base rate + tax amount.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
  • ]
    • tip EnrichedDetailedFloatField

    The amount of money that is given to someone for a service, also called gratuity. Usually present on receipts, not invoices.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    total EnrichedDetailedFloatField

    The gross amount, including subtotal, tax, fees, etc.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    total_quantity DetailedFloatField

    The total quantity of items found on the document. In most cases, this number equals the sum of line item quantities.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (number | null)required
    total_weight DetailedField

    The total weight of all items listed on the document. Typically found on invoices.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    tracking_number DetailedField

    The unique identifier assigned to a package for referencing its shipping information.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    tracking_numbers object[]

    An array of unique identification numbers assigned to packages for referencing shipping information.

  • Array [
    • anyOf
    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • vending_person object

    The person or business who has provided services found on the document. This is the same as server_name.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vending_person_number object

    Identifier for the person or business who has provided services. Typically 'Cashier Number' on receipts or 'Sales Manager Number' on invoices.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vendor DetailedVendor

    An object containing a detailed breakdown of vendor elements.

    abn_number object

    An Australian Business Number (ABN) is a unique 11-digit number that identifies a business to the government and community and found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    account_currency DetailedCurrencyPrediction

    The currency of the vendor bank account if indicated. Provides the ability to support multiple bank accounts for bill pay use cases, e.g., a separate bank account for you to pay in Euros and a separate to pay in US Dollars.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (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]

    account_number objectrequired

    The vendor's bank account number.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    address objectrequired

    The address of the vendor.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    biller_code object

    The vendor identification code in a payment system.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    bank_breakdown object[]required

    A detailed list of banking information.

  • Array [
    • vendor_account_currency DetailedCurrencyPredictionrequired
    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (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]

    vendor_account_number objectrequired
    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vendor_bank_address objectrequired

    The address of the vendor bank.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    parsed_address ParsedAddress

    An object representing detailed address-related information on the document, such as the city, state, street address, unit number, etc. Filled in the original POST request had the parameter parse_address set to true and the corresponding address is found on the document.

    building (string | null)

    Possible values: non-empty

    The building name e.g. 'Project 8' or 'Empire State Building'

    city (string | null)

    Possible values: non-empty

    The settlement including cities, towns, villages, hamlets, localities, etc.

    country (string | null)

    Possible values: non-empty

    The sovereign nations and their dependent territories, anything with an ISO-3166 code.

    country_alpha_2 (string | null)

    Possible values: non-empty

    The detected ISO 3166-1 alpha-2 code for a given country.

    postcode (string | null)

    Possible values: non-empty

    The postal code used for mail sorting

    state (string | null)

    Possible values: non-empty

    A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well

    street_address (string | null)

    Possible values: non-empty

    A sum of house_number road, building, unit.

    house (string | null)

    Possible values: non-empty

    The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".

    house_number (string | null)

    Possible values: non-empty

    Usually refers to the external (street-facing) building number. In some countries this may be a compound, hyphenated number, which also includes an apartment number, or a block number (a la Japan).

    road (string | null)

    Possible values: non-empty

    Street name(s)

    unit (string | null)

    Possible values: non-empty

    An apartment, unit, office, lot, or other secondary unit designator.

    level (string | null)

    Possible values: non-empty

    The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.

    staircase (string | null)

    Possible values: non-empty

    Numbered/lettered staircase

    entrance (string | null)

    Possible values: non-empty

    Numbered/lettered entrance

    po_box (string | null)

    Possible values: non-empty

    The post office box, typically found in non-physical (mail-only) addresses.

    suburb (string | null)

    Possible values: non-empty

    An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".

    city_district (string | null)

    Possible values: non-empty

    The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".

    island (string | null)

    Possible values: non-empty

    Named islands e.g. "Maui"

    state_district (string | null)

    Possible values: non-empty

    Usually a second-level administrative division or county.

    country_region (string | null)

    Possible values: non-empty

    Informal subdivision of a country without any political status.

    world_region (string | null)

    Possible values: non-empty

    Only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".

    vendor_bank_addresses object[]
  • Array [
    • enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • vendor_bank_name objectrequired

    The name of the bank. Could be part of invoice remittance information.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vendor_bank_names object[]
  • Array [
    • enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • vendor_bank_number objectrequired

    The bank routing number. Could be part of invoice remittance information.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vendor_bank_numbers object[]required

    An array of bank routing numbers.

  • Array [
    • enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • vendor_bank_swift objectrequired

    The Society for Worldwide Interbank Financial Telecommunication (SWIFT) code is part of the ISO 9362 standards for sending money internationally.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vendor_iban objectrequired

    The International Bank Account Number (IBAN) is a standard international numbering system developed to identify an overseas bank account.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • bank_name object

    The name of the bank. Could be part of invoice remittance information.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    bank_number object

    The bank routing number. Could be part of invoice remittance information.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    bank_swift object

    The Society for Worldwide Interbank Financial Telecommunication (SWIFT) code is part of the ISO 9362 standards for sending money internationally.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    category (string | null)deprecated

    Possible values: non-empty

    Similar to vendor.type

    country_code DetailedCountryField

    The country code belonging to a vendor

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: [IO, NA, PK, ZW, QA, RO, MT, ID, NF, MC, MW, PS, EC, SD, NG, AS, GF, GI, AE, HR, AU, SZ, CO, MO, VI, NE, RU, KR, YT, CL, ER, PA, DE, IS, TC, PG, AF, SE, VU, EE, CG, GR, CX, OM, MN, BH, DJ, GB, AN, KW, PW, CM, BF, PM, US, SO, TF, BZ, SL, LR, LT, SA, PY, GS, SY, GP, GG, CF, MG, PN, AZ, GD, JP, BL, CA, NO, CV, UY, BS, BN, GW, MX, MZ, KZ, HU, AO, LC, CU, GT, DM, PH, WS, KP, SR, AM, VC, LU, BY, VE, AI, VA, LY, PF, BD, BT, CR, FR, FM, TH, MF, CK, MY, PL, BM, ES, FO, IL, ST, TD, KN, NZ, BB, PR, SK, VN, ML, CD, NP, AX, PE, GL, IE, JE, AL, LV, LS, TT, BO, TZ, UA, AG, ET, NU, RW, AW, SM, NC, UM, AD, FI, EG, KE, MS, YE, GY, PT, VG, BG, GE, MR, NR, TR, AT, LI, RE, AQ, MH, MV, TN, SV, GH, HT, JO, MM, SI, SH, UZ, MP, KM, BE, HM, SG, SB, TL, FJ, MU, ME, BJ, CH, AR, TJ, KI, BW, CN, GQ, SJ, LB, TO, TV, GA, TG, HK, IM, BA, CI, MK, TM, KH, CY, ZA, LK, WF, MQ, SN, BI, DK, GN, NL, NI, FK, SC, IT, UG, CC, GM, BR, TW, CZ, KY, TK, RS, DZ, EH, DO, JM, MD, LA, KG, MA, IQ, ZM, IR, HN, BV, IN, GU]

    email object

    The vendor's email address.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    external_id (string | null)

    Possible values: non-empty

    A custom identification field. Set by matching to a client-provided list of vendors.

    fax_number object

    The fax number of the vendor.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    iban object

    The International Bank Account Number (IBAN) is a standard international numbering system developed to identify an overseas bank account.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    lat (number | null)

    The latitude coordinates for the location of this vendor. This is an enriched parameter from a third-party resource not found in the document.

    lng (number | null)

    The longitude coordinates for the location of this vendor. This is an enriched parameter from a third-party resource not found in the document.

    logo uri

    Possible values: non-empty and <= 2083 characters

    A URL to the vendor's logo. This is an enriched convenience parameter and is not found on the document.

    logo_name object

    A vendor logo found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    map_url uri

    Possible values: non-empty and <= 2083 characters

    A URL to the vendor's location on Google Maps. This is an enriched convenience parameter and is not found on the document.

    name object

    The normalized name of the vendor.

    enriched_value (boolean | null)

    Whether the value is enriched.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    parsed_address ParsedAddress

    An object representing detailed address-related information on the document, such as the city, state, street address, unit number, etc. Filled in the original POST request had the parameter parse_address set to true and the corresponding address is found on the document.

    building (string | null)

    Possible values: non-empty

    The building name e.g. 'Project 8' or 'Empire State Building'

    city (string | null)

    Possible values: non-empty

    The settlement including cities, towns, villages, hamlets, localities, etc.

    country (string | null)

    Possible values: non-empty

    The sovereign nations and their dependent territories, anything with an ISO-3166 code.

    country_alpha_2 (string | null)

    Possible values: non-empty

    The detected ISO 3166-1 alpha-2 code for a given country.

    postcode (string | null)

    Possible values: non-empty

    The postal code used for mail sorting

    state (string | null)

    Possible values: non-empty

    A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well

    street_address (string | null)

    Possible values: non-empty

    A sum of house_number road, building, unit.

    house (string | null)

    Possible values: non-empty

    The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".

    house_number (string | null)

    Possible values: non-empty

    Usually refers to the external (street-facing) building number. In some countries this may be a compound, hyphenated number, which also includes an apartment number, or a block number (a la Japan).

    road (string | null)

    Possible values: non-empty

    Street name(s)

    unit (string | null)

    Possible values: non-empty

    An apartment, unit, office, lot, or other secondary unit designator.

    level (string | null)

    Possible values: non-empty

    The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.

    staircase (string | null)

    Possible values: non-empty

    Numbered/lettered staircase

    entrance (string | null)

    Possible values: non-empty

    Numbered/lettered entrance

    po_box (string | null)

    Possible values: non-empty

    The post office box, typically found in non-physical (mail-only) addresses.

    suburb (string | null)

    Possible values: non-empty

    An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".

    city_district (string | null)

    Possible values: non-empty

    The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".

    island (string | null)

    Possible values: non-empty

    Named islands e.g. "Maui"

    state_district (string | null)

    Possible values: non-empty

    Usually a second-level administrative division or county.

    country_region (string | null)

    Possible values: non-empty

    Informal subdivision of a country without any political status.

    world_region (string | null)

    Possible values: non-empty

    Only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".

    phone_number object

    The phone number of the vendor.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    raw_address object

    The raw vendor address exactly as found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    raw_name object

    The raw vendor name exactly as found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    reg_number object

    The vendor registration number. In the U.S., this would be the Employer Identification Number (EIN). Does not include VAT (Europe) or EIN (US), which are recorded as vat_number.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    type DetailedVendorType

    A classification of the vendor, such as drugstore or convenience store. The vendor type predicted by Veryfi. Can also be extracted from third party enrichment

    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 object

    The extracted value.

    anyOf

    string

    order_number object

    The unique identification number for the order and set by the vendor. Typically found on invoices.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vat_number object

    The value-added tax identification number (VAT) for this vendor and found on the document. VAT numbers can be found on European invoices. For United States invoices, the Employer Identification Number (EIN) of the vendor.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    web object

    The vendor's website address (URL).

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    vendors object[]

    An array of all found vendors by vendors.raw_name, including those found with vendor.abn_number and found on the document.

  • 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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
    • vin_number object

    A vehicle identification number (VIN) is a unique code assigned to every motor vehicle when it's manufactured and found on the document.

    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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

    weights object[]

    An array of the weights found on the document.

  • 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.

    bounding_region number[]

    Possible values: >= 8, <= 8

    An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

    bounding_box object[]

    Possible values: >= 5, <= 5

    An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

  • Array [
    • anyOf

    number

  • ]
    • ocr_score (number | null)

    Possible values: <= 1

    The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

    rotation (integer | null)

    Possible values: [0, 90, 180, 270]

    The angle of rotation of the document in degrees.

    value (string | null)required

    Possible values: non-empty

    The extracted value.

  • ]
  • ]
    • meta objectrequired

    An object that describes document-related metadata information such as total pages.

    documents_per_page integerrequired

    Possible values: > 0

    The number of Documents to return per page.

    page_number integerrequired

    Possible values: > 0

    The number indicating which page to start retrieving a list of Documents.

    total_pages integerrequired

    See track_total_results parameter to override default behaviour. By default, if using any filtering or search, such as by tag, always 1. Otherwise, the total number of pages for this query.

    total_results integerrequired

    See track_total_results parameter to override default behaviour. By default, if using any filtering or search, returns the number of Documents found on the first page. Otherwise, the total number of Documents found for this query.

Loading...