Process a Document

POST 
/api/v8/partner/documents

Veryfi's Process Documents endpoint allows you to submit and extract data from unstructured documents into valuable business insights. The Process Documents endpoint enables you to submit supported file formats and retrieve extracted data in JSON format. Veryfi supports the following file formats: .txt,.jpg,.jpeg,.avif,.pdf,.heif,.ofd,.webp,.html,.zip,.gif,.htm,.png,.heic. The maximum file size is 20mb, and the maximum number of pages that can be processed at once is 15.

Request

application/json

Body

file_data string

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

file_url string

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

file_urls string[]

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

package_path string

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

bucket string

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

file_name string

An optional filename. Useful to determine file type.

file binary

A binary file. Submitting zipped documents through this parameter is the fastest way to process any document.

detailed booleandeprecated

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

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.

categories string[]

Possible values: non-empty

Default value: ``

A comma separated list of custom categories. Veryfi will attempt to match line items with the specified categories. Does not work with the parameter boost_mode set to true.

tags string[]

Possible values: non-empty

Default value: ``

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.

max_pages_to_process integer

The number of pages to process for the document. The default limit is 15 pages per document.

boost_mode boolean

Default value: false

A field indicating whether or not boost mode should be enabled. Boost mode skips data enrichment steps allowing for faster processing time. The default value for boost_mode is false.

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.

async boolean

Default value: false

A field used to process files asynchronously using webhooks. Set async to true to use async mode. The default value is false.

detect_blur booleandeprecated

Default value: false

A field used to determine whether or not the uploaded document is blurry or not. This field is deprecated, use is_blurry.

parse_address boolean

Default value: false

A field used to determine whether or not to break an address into its individual components. This adds parsed_address to the response object.

compute boolean

Default value: true

A field used to determine whether or not to include enrichments on several fields to provide high extraction coverage when the data is not present or extracted from the document. The default value is true.

country string

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

A field used to provide an additional hint to help the model recognize the currency of the document.

multipart/form-data

Body

file_data string

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

file_url string

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

file_urls string[]

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

package_path string

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

bucket string

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

file_name string

An optional filename. Useful to determine file type.

file binary

A binary file. Submitting zipped documents through this parameter is the fastest way to process any document.

detailed booleandeprecated

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

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.

categories string[]

Possible values: non-empty

Default value: ``

A comma separated list of custom categories. Veryfi will attempt to match line items with the specified categories. Does not work with the parameter boost_mode set to true.

tags string[]

Possible values: non-empty

Default value: ``

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.

max_pages_to_process integer

The number of pages to process for the document. The default limit is 15 pages per document.

boost_mode boolean

Default value: false

A field indicating whether or not boost mode should be enabled. Boost mode skips data enrichment steps allowing for faster processing time. The default value for boost_mode is false.

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.

async boolean

Default value: false

A field used to process files asynchronously using webhooks. Set async to true to use async mode. The default value is false.

detect_blur booleandeprecated

Default value: false

A field used to determine whether or not the uploaded document is blurry or not. This field is deprecated, use is_blurry.

parse_address boolean

Default value: false

A field used to determine whether or not to break an address into its individual components. This adds parsed_address to the response object.

compute boolean

Default value: true

A field used to determine whether or not to include enrichments on several fields to provide high extraction coverage when the data is not present or extracted from the document. The default value is true.

country string

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

A field used to provide an additional hint to help the model recognize the currency of the document.

dictation string

Possible values: non-empty

A string to create a document from.

emailed_receipt_id integer
receipt_id integer
document_type string

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

auto_delete boolean

Default value: false

Delete this document from Veryfi after data has been extracted

device_data object

uuid uuid4

Device unique identifier

browser_fingerprint object

Browser identifying characteristics

source string

Possible values: [lens.web]

Manually defined source

Responses

201

The processed document response. Fields with an asterisk will be returned. Contact support to enable any additional fields on your account.

application/json

Schema

Schema

anyOf

DetailedDocument

pdf_url urirequired

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.

accounting_entry_type string

Possible values: [debit, credit]

created_date date-timerequired

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

custom_fields object

duplicate_of integer

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

exch_rate number

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.

external_id string

Possible values: non-empty

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

img_blur boolean

The value indicating whether or not the image taken with the Lens SDK is blurry.

img_file_name stringrequired

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 urirequired

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.

img_thumbnail_url urirequired

Possible values: non-empty and <= 2083 characters

A signed URL to a thumbnail of the initially submitted image. 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[]

An array of boolean values indicating whether each page of the processed document is blurry or not.

is_document boolean

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

is_duplicate boolean

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

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]

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

date daterequired

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

description stringrequired

Possible values: non-empty

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

full_description string

Possible values: non-empty

The item text including dates, weight, etc.

normalized_description string

Possible values: non-empty

The line item description with expanded words

discount_price number

The lower price after discount.

discount_rate numberrequired

The discount percentage that was applied to the line item.

discount numberrequired

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

price numberrequired

The unit price for the line item.

quantity numberrequired

The amount or number of units for the line item. This value is computable.

reference stringrequired

Possible values: non-empty

section stringrequired

Possible values: non-empty

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

sku stringrequired

Possible values: non-empty

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

tax_rate numberrequired

The percent at which the individual or corporation is taxed.

tax numberrequired

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

total numberrequired

The total price for this line item. This value is computable.

subtotal number

New, added 2023-07-10. The total of a set of numbers that will later be added to another set of numbers, such as tip and tax. This value is computable.

unit_of_measure stringrequired

Possible values: non-empty

The unit of measurement for this line item.

category string

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

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

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

custom_fields object

product_details object[]

Product lookup details

Array [

]

end_date date

A service end date identified for the line item. An end date could be a flight arrival date or hotel departure date in ISO 8601 format.

gross_total number

The line item total before deductions.

hsn string

Possible values: non-empty

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

lot string

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. A start date could be a flight departure date or hotel arrival date in ISO 8601 format.

tax_code string

Possible values: non-empty

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

manufacturer string

Possible values: non-empty

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

net_total number

The line item total after deductions.

upc string

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

Possible values: non-empty

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

]

model string

Possible values: non-empty

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

notes string

Possible values: non-empty

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

ocr_text stringrequired

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

reference_number stringdeprecated

Possible values: non-empty

Deprecated. Use id.

status string

Possible values: [in_progress, processed, reviewed, reimbursed, archived]

The value indicating the document's status.

tags string[]

Possible values: non-empty

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.

total_pages integerdeprecated

Deprecated. Use meta.total_pages.

updated_date date-timerequired

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

warnings string[]

Possible values: non-empty

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

meta objectrequired

owner stringrequired

Possible values: non-empty

The API username for the account that processed the document.

total_pages integerrequired

The total number of pages found in the submitted document.

processed_pages integerrequired

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 integerrequired

width integerrequired

language object[]required

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

Array [

score number

Possible values: <= 1

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

value stringrequired

Possible values: non-empty

The extracted value.

]

screenshot object

score number

Possible values: <= 1

type stringrequired

Possible values: [mobile_screenshot, desktop_screenshot]

The predicted value.

]

source_documents object[]required

An array containing meta info about originally submitted documents

Array [

size_kb integerrequired

height integerrequired

width integerrequired

]

fraud object

attribution string

Possible values: non-empty

Attribution of Fraud Detector's decision

decision string

Possible values: non-empty

Fraud Detector's decision

color string

Possible values: [green, yellow, red]

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

pages object[]

An array containing fraud info about each extracted page

Array [

is_lcd object

score number

Possible values: <= 1

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

value booleanrequired

The extracted value.

]

images object[]deprecated

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

Array [

is_lcd boolean

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

score number

The value indicating how confident the model is about is_lcd prediction.

]

score number

Possible values: <= 1

Confidence of Fraud Detector in it's prediction

version string

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

amount of submissions from specific device id

property name* integer

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 ^(total|subtotal|date|line_items\.\d{1,4}\.total)$

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

device_id string

Fingerprint of the device used to process the document.

duplicates object[]

A list of 10 closest matches

Array [

id integerrequired

url urirequired

Possible values: non-empty and <= 2083 characters

score numberrequired

Possible values: <= 1

How close is the match

]

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

language object[]required

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

Array [

score number

Possible values: <= 1

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

value stringrequired

Possible values: non-empty

The extracted value.

]

account_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

balance object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

bill_to object

name object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

address object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

phone_number object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

reg_number object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

email object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

parsed_address object

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

city string

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

country string

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

country_alpha_2 string

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

postcode string

The postal code used for mail sorting

state string

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

street_address string

A sum of house_number road, building, unit.

house string

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

house_number string

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

Street name(s)

unit string

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

level string

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

staircase string

Numbered/lettered staircase

entrance string

Numbered/lettered entrance

po_box string

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

suburb string

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

city_district string

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

island string

Named islands e.g. "Maui"

state_district string

Usually a second-level administrative division or county.

country_region string

Informal subdivision of a country without any political status.

world_region string

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 object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

category object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

confidence_details booleanrequired

currency_code object

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.

anyOf

MOD1

string

DetailedCurrencyChoice

score number

Possible values: <= 1

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

value stringrequired

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

date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value date-timerequired

default_category object

The category chosen from a predefined list of categories found on the account. Learn how Veryfi's intelligent categorization, custom categorization, and model training work.

anyOf

MOD1

string

DetailedDefaultCategoryFieldType

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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

delivery_date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value date-timerequired

delivery_note_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

discount object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

document_reference_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

document_title object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

document_type object

anyOf

MOD1

string

DetailedDocumentTypeFieldType

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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

due_date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value daterequired

final_balance number

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 object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

incoterms object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

insurance object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

invoice_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

is_money_in object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value booleanrequired

license_plate_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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

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]

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

date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value daterequired

description object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

full_description object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

normalized_description object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

discount_price object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

discount_rate object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

discount object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

price object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

quantity object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

reference objectrequired

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

section object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

sku object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

tax_rate object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

tax object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

total object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

subtotal object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

unit_of_measure object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

category object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

country_of_origin object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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

custom_fields object

end_date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value daterequired

gross_total object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

hsn object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

lot object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

start_date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value daterequired

tax_code object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

manufacturer object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

net_total object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

upc object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

weight object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

]

order_date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value daterequired

payment object

card_number objectrequired

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

display_name stringrequired

Possible values: non-empty

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

terms object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

type objectrequired

The payment type found on the document.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

previous_balance object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

purchase_order_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

rounding object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

server_name object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

service_start_date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value daterequired

service_end_date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value daterequired

ship_date object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value daterequired

ship_to object

address object

The delivery address found on the document.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

name object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

parsed_address object

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

city string

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

country string

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

country_alpha_2 string

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

postcode string

The postal code used for mail sorting

state string

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

street_address string

A sum of house_number road, building, unit.

house string

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

house_number string

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

Street name(s)

unit string

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

level string

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

staircase string

Numbered/lettered staircase

entrance string

Numbered/lettered entrance

po_box string

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

suburb string

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

city_district string

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

island string

Named islands e.g. "Maui"

state_district string

Usually a second-level administrative division or county.

country_region string

Informal subdivision of a country without any political status.

world_region string

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 object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

store_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

subtotal object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

tax object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

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 object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

rate object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

total object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

base object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

code object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

total_inclusive object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

]

tip object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

total object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

total_quantity object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value numberrequired

total_weight object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

tracking_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

tracking_numbers object[]

An array of unique identification numbers assigned to the package for shipping.

Array [

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

]

vending_person object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

vending_person_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

vendor object

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.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

account_currency object

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.

anyOf

MOD1

string

DetailedCurrencyPrediction

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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

account_number objectrequired

The vendor's bank account number.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

address objectrequired

The address of the vendor. This value is computable.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

biller_code object

The vendor identification code in a payment system.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

bank_breakdown object[]

A detailed list of banking information.

Array [

vendor_account_currency object

anyOf

MOD1

string

DetailedCurrencyPrediction

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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

vendor_account_number objectrequired

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

vendor_bank_address objectrequired

The address of the vendor bank.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

vendor_bank_name objectrequired

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

vendor_bank_number objectrequired

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

vendor_bank_numbers object[]required

An array of bank routing numbers.

Array [

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

]

bank_name object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

bank_number object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

category objectdeprecated

Same as vendor.type

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

country_code object

The country code belonging to a vendor

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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

email object

The vendor's email address.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

external_id string

Possible values: non-empty

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

external_ids object[]

A list of external ids.

Array [

id stringrequired

Possible values: non-empty

The unique identifier of the external id.

source stringrequired

Possible values: non-empty

The source of the external id.

]

fax_number objectrequired

The fax number of the vendor.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

lat number

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

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 urirequired

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.

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 objectrequired

The normalized name of the vendor.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

parsed_address object

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

city string

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

country string

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

country_alpha_2 string

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

postcode string

The postal code used for mail sorting

state string

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

street_address string

A sum of house_number road, building, unit.

house string

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

house_number string

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

Street name(s)

unit string

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

level string

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

staircase string

Numbered/lettered staircase

entrance string

Numbered/lettered entrance

po_box string

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

suburb string

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

city_district string

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

island string

Named islands e.g. "Maui"

state_district string

Usually a second-level administrative division or county.

country_region string

Informal subdivision of a country without any political status.

world_region string

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 objectrequired

The phone number of the vendor.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

raw_address objectrequired

The raw vendor address exactly as found on the document.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

raw_name object

The raw vendor name exactly as found on the document.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

type object

The classification of the product. The vendor type predicted by Veryfi, e.g. Tax.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value object

The extracted value.

anyOf

MOD1

string

MOD2

string

order_number object

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

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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.

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

web object

The vendor's website address (URL).

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

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 [

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

]

vin_number object

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

weights object[]

An array of the weights found on the document.

Array [

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

MOD1

number

MOD2

integer

]

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.

ocr_score number

Possible values: <= 1

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

score number

Possible values: <= 1

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

rotation integer

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

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

]

Document

pdf_url urirequired

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.

accounting_entry_type string

Possible values: [debit, credit]

created_date date-timerequired

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

custom_fields object

duplicate_of integer

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

exch_rate number

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.

external_id string

Possible values: non-empty

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

img_blur boolean

The value indicating whether or not the image taken with the Lens SDK is blurry.

img_file_name stringrequired

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 urirequired

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.

img_thumbnail_url urirequired

Possible values: non-empty and <= 2083 characters

A signed URL to a thumbnail of the initially submitted image. 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[]

An array of boolean values indicating whether each page of the processed document is blurry or not.

is_document boolean

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

is_duplicate boolean

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

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]

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

date daterequired

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

description stringrequired

Possible values: non-empty

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

full_description string

Possible values: non-empty

The item text including dates, weight, etc.

normalized_description string

Possible values: non-empty

The line item description with expanded words

discount_price number

The lower price after discount.

discount_rate numberrequired

The discount percentage that was applied to the line item.

discount numberrequired

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

price numberrequired

The unit price for the line item.

quantity numberrequired

The amount or number of units for the line item. This value is computable.

reference stringrequired

Possible values: non-empty

section stringrequired

Possible values: non-empty

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

sku stringrequired

Possible values: non-empty

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

tax_rate numberrequired

The percent at which the individual or corporation is taxed.

tax numberrequired

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

total numberrequired

The total price for this line item. This value is computable.

subtotal number

New, added 2023-07-10. The total of a set of numbers that will later be added to another set of numbers, such as tip and tax. This value is computable.

unit_of_measure stringrequired

Possible values: non-empty

The unit of measurement for this line item.

category string

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

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

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

custom_fields object

product_details object[]

Product lookup details

Array [

]

end_date date

A service end date identified for the line item. An end date could be a flight arrival date or hotel departure date in ISO 8601 format.

gross_total number

The line item total before deductions.

hsn string

Possible values: non-empty

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

lot string

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. A start date could be a flight departure date or hotel arrival date in ISO 8601 format.

tax_code string

Possible values: non-empty

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

manufacturer string

Possible values: non-empty

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

net_total number

The line item total after deductions.

upc string

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

Possible values: non-empty

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

]

model string

Possible values: non-empty

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

notes string

Possible values: non-empty

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

ocr_text stringrequired

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

reference_number stringdeprecated

Possible values: non-empty

Deprecated. Use id.

status string

Possible values: [in_progress, processed, reviewed, reimbursed, archived]

The value indicating the document's status.

tags string[]

Possible values: non-empty

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.

total_pages integerdeprecated

Deprecated. Use meta.total_pages.

updated_date date-timerequired

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

warnings string[]

Possible values: non-empty

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

meta object

owner stringrequired

Possible values: non-empty

The API username for the account that processed the document.

total_pages integerrequired

The total number of pages found in the submitted document.

processed_pages integerrequired

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

An array containing meta info about each extracted page

Array [

height integerrequired

width integerrequired

language string[]required

Possible values: non-empty

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

screenshot object

score number

Possible values: <= 1

type stringrequired

Possible values: [mobile_screenshot, desktop_screenshot]

The predicted value.

]

source_documents object[]required

An array containing meta info about originally submitted documents

Array [

size_kb integerrequired

height integerrequired

width integerrequired

]

fraud object

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

attribution string

Possible values: non-empty

Attribution of Fraud Detector's decision

decision string

Possible values: non-empty

Fraud Detector's decision

color string

Possible values: [green, yellow, red]

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

pages object[]

An array containing fraud info about each extracted page

Array [

is_lcd object

score number

Possible values: <= 1

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

value booleanrequired

The extracted value.

]

images object[]deprecated

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

Array [

is_lcd boolean

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

score number

The value indicating how confident the model is about is_lcd prediction.

]

score number

Possible values: <= 1

Confidence of Fraud Detector in it's prediction

version string

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

amount of submissions from specific device id

property name* integer

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 ^(total|subtotal|date|line_items\.\d{1,4}\.total)$

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

device_id string

Fingerprint of the device used to process the document.

duplicates object[]

A list of 10 closest matches

Array [

id integerrequired

url urirequired

Possible values: non-empty and <= 2083 characters

score numberrequired

Possible values: <= 1

How close is the match

]

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

language string[]required

Possible values: non-empty

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

account_number stringrequired

Possible values: non-empty

The unique identifier of the customer assigned by the vendor.

balance number

The invoice or bill balance.

barcodes object[]

An array of barcodes extracted from the document if found.

Array [

data stringrequired

Possible values: non-empty

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

type stringrequired

Possible values: non-empty

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

bounding_region number[]

Possible values: >= 8, <= 8

An array of normalized (x, y) coordinates used to represent the boundary of the barcode found on the document.

]

bill_to object

name string

Possible values: non-empty

The name of the individual or business

address string

Possible values: non-empty

The address of the individual or business

email string

Possible values: non-empty

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

parsed_address object

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

city string

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

country string

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

country_alpha_2 string

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

postcode string

The postal code used for mail sorting

state string

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

street_address string

A sum of house_number road, building, unit.

house string

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

house_number string

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

Street name(s)

unit string

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

level string

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

staircase string

Numbered/lettered staircase

entrance string

Numbered/lettered entrance

po_box string

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

suburb string

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

city_district string

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

island string

Named islands e.g. "Maui"

state_district string

Usually a second-level administrative division or county.

country_region string

Informal subdivision of a country without any political status.

world_region string

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 string

Possible values: non-empty

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

reg_number string

Possible values: non-empty

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

vat_number string

Possible values: non-empty

The value-added tax identification number (VAT) for this vendor and found on the document. VAT numbers can be found on European invoices.

cashback string

Possible values: non-empty

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.

category stringrequired

Possible values: non-empty

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

currency_code stringrequired

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

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.

date date-timerequired

The date and time found on the document in ISO 8601 format. This value is computable.

default_category string

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

The category chosen from a predefined list of categories found on the account. Learn how Veryfi's intelligent categorization, custom categorization, and model training work.

delivery_date date-time

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

delivery_note_number string

Possible values: non-empty

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

discount numberrequired

The amount deducted from the gross price.

document_type string

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

document_reference_number string

Possible values: non-empty

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

document_title string

Possible values: non-empty

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.

due_date daterequired

The due date and time in ISO 8601 format. Typically found on invoices. This value is computable.

final_balance number

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 string

Possible values: non-empty

The number of guests or seats extracted from the document.

incoterms string

Possible values: non-empty

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

insurance number

The insurance terms for the document. Typically found on invoices.

invoice_number stringrequired

Possible values: non-empty

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

is_money_in booleanrequired

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

license_plate_number string

Possible values: non-empty

The vehicle license plate number.

order_date date

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

payment object

card_number stringrequired

Possible values: non-empty

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

display_name stringrequired

Possible values: non-empty

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

terms string

Possible values: non-empty

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

type stringrequired

Possible values: non-empty

The payment type found on the document.

previous_balance number

The previous invoice balance.

purchase_order_number string

Possible values: non-empty

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.

rounding number

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.

server_name string

Possible values: non-empty

The restaurant's server name.

service_start_date daterequired

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.

service_end_date daterequired

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.

ship_date date

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

ship_to object

address string

Possible values: non-empty

The delivery address found on the document.

name string

Possible values: non-empty

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

parsed_address object

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

city string

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

country string

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

country_alpha_2 string

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

postcode string

The postal code used for mail sorting

state string

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

street_address string

A sum of house_number road, building, unit.

house string

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

house_number string

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

Street name(s)

unit string

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

level string

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

staircase string

Numbered/lettered staircase

entrance string

Numbered/lettered entrance

po_box string

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

suburb string

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

city_district string

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

island string

Named islands e.g. "Maui"

state_district string

Usually a second-level administrative division or county.

country_region string

Informal subdivision of a country without any political status.

world_region string

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 numberrequired

The cost of shipping or delivery of a package.

store_number string

Possible values: non-empty

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

subtotal numberrequired

New, added 2023-07-10. The total of a set of numbers that will later be added to another set of numbers, such as tip and tax. This value is computable.

tax numberrequired

The tax amount applied to the purchase(s). This value is computable.

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. This value is computable.

total numberrequired

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

Possible values: non-empty

The tax identification code.

total_inclusive number

The base rate + tax amount.

]

tip numberrequired

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

total numberrequired

The gross amount, including subtotal, tax, fees, etc. This value is computable.

total_quantity number

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

total_weight string

Possible values: non-empty

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

tracking_number string

Possible values: non-empty

The unique number assigned to the package for shipping.

tracking_numbers string[]

Possible values: non-empty

An array of unique identification numbers assigned to the package for shipping.

vending_person string

Possible values: non-empty

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

vending_person_number string

Possible values: non-empty

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

vendor object

abn_number string

Possible values: non-empty

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.

account_currency string

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

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.

account_number string

Possible values: non-empty

The vendor's bank account number.

address stringrequired

Possible values: non-empty

The address of the vendor.

biller_code string

Possible values: non-empty

The vendor identification code in a payment system.

bank_breakdown object[]

A detailed list of banking information.

Array [

vendor_account_currency string

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

vendor_account_number string

Possible values: non-empty

vendor_bank_address string

Possible values: non-empty

The address of the vendor bank.

vendor_bank_name string

Possible values: non-empty

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

vendor_bank_number string

Possible values: non-empty

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

vendor_bank_numbers string[]required

Possible values: non-empty

An array of bank routing numbers.

vendor_bank_swift string

Possible values: non-empty

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

vendor_iban string

Possible values: non-empty

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

]

bank_name string

Possible values: non-empty

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

bank_number string

Possible values: non-empty

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

bank_swift string

Possible values: non-empty

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

category stringdeprecated

Possible values: non-empty

Same as vendor.type

country_code string

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

The country code belonging to a vendor

email string

Possible values: non-empty

The vendor's email address.

external_id string

Possible values: non-empty

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

external_ids object[]

A list of external ids.

Array [

id stringrequired

Possible values: non-empty

The unique identifier of the external id.

source stringrequired

Possible values: non-empty

The source of the external id.

]

fax_number stringrequired

Possible values: non-empty

The fax number of the vendor.

iban string

Possible values: non-empty

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

lat number

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

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 urirequired

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.

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 stringrequired

Possible values: non-empty

The normalized name of the vendor.

parsed_address object

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

city string

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

country string

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

country_alpha_2 string

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

postcode string

The postal code used for mail sorting

state string

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

street_address string

A sum of house_number road, building, unit.

house string

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

house_number string

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

Street name(s)

unit string

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

level string

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

staircase string

Numbered/lettered staircase

entrance string

Numbered/lettered entrance

po_box string

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

suburb string

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

city_district string

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

island string

Named islands e.g. "Maui"

state_district string

Usually a second-level administrative division or county.

country_region string

Informal subdivision of a country without any political status.

world_region string

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 stringrequired

Possible values: non-empty

The phone number of the vendor.

raw_address stringrequired

Possible values: non-empty

The raw vendor address exactly as found on the document.

raw_name string

Possible values: non-empty

The raw vendor name exactly as found on the document.

reg_number string

Possible values: non-empty

The vendor registration number. In the U.S., this would be the Employer Identification Number (EIN).

type object required

The classification of the product. The vendor type predicted by Veryfi, e.g. Tax.

anyOf

MOD1

string

MOD2

string

order_number string

Possible values: non-empty

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

vat_number string

Possible values: non-empty

The value-added tax identification number (VAT) for this vendor and found on the document. VAT numbers can be found on European invoices.

web string

Possible values: non-empty

The vendor's website address (URL).

vendors string[]

Possible values: non-empty

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

vin_number string

Possible values: non-empty

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

weights string[]

Possible values: non-empty

An array of the weights found on the document.

Example (from schema)

{}

400

User error

application/json

Schema

Schema

oneOf

COULDNT_DOWNLOAD_FILE_FROM_PROVIDED_URL

status string

Default value: fail

error string

Default value: Couldn't download file from provided url.

details undefined[]

Default value: [object Object]

RECEIVED_EMPTY_OR_MISSING_DATA

status string

Default value: fail

error string

Default value: Received empty or missing data

Example (from schema)

{}

404

User error

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

429

User error

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

503

User error

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporaly unavailable. Please try again later

Example (from schema)

{}

default

OperationStatus

application/json

Schema

Schema

error stringrequired
details object[]
status string

Default value: fail

Example (from schema)

{
  "error": "string",
  "details": [
    {}
  ],
  "status": "fail"
}

Loading...