Update a Document

PUT 
/api/v8/partner/documents/:document_id

Veryfi's Update a Document by ID endpoint allows you to change a Document that Veryfi's Machine Learning models have already processed. This feature will enable users to update Documents previously processed by Veryfi to ensure data extraction accuracy. Updating a Document is especially useful for correcting mistakes and updating information over time. By changing a processed Document, Veryfi's Machine Learning models can re-learn the updated information, allowing them to stay accurate and up-to-date.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

application/json

Body

is_billable (boolean | null)

The value indicating if the document is billable. This parameter is helpful in expense management use cases.

is_approved (boolean | null)

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

is_duplicate (boolean | null)

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

is_money_in object
This parameter is used in the Expense Management application. The value is true if the document has a refund or credit note.
anyOf
MOD1
boolean
DetailedClassPUTBoolField
value booleanrequired
is_transaction object
This flag marks card slips as true.
anyOf
MOD1
boolean
DetailedClassPUTBoolField
value booleanrequired
account_number object
The unique identifier of the customer assigned by the vendor.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
balance object
The invoice or bill balance.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
final_balance object
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.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
guest_count object
The number of guests or seats extracted from the document.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
license_plate_number object
The vehicle license plate number.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
previous_balance object
The previous invoice balance.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
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
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
cashback object
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.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
country_code object

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

anyOf

MOD1

string

DetailedPUTCountryField

score (number | null)

Possible values: <= 1

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

bounding_region number[]

Possible values: >= 8, <= 8

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

bounding_box object[]

Possible values: >= 5, <= 5

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

Array [

anyOf

MOD1

number

MOD2

integer

]

ocr_score (number | null)

Possible values: <= 1

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

rotation (integer | null)

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

The angle of rotation of the document in degrees.

value (string | null)required

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

currency_code object

The currency code in ISO 4217 format.

anyOf

MOD1

string

PUTClassCurrencyFieldType

value stringrequired

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

delivery_note_number object
New, added 2023-03-23.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
discount object
The amount deducted from the gross price.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
document_reference_number object
The identification number for the document. Commonly used to identify items for a particular customer.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
document_title object
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.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
document_type object

anyOf

MOD1

string

PUTDocumentTypeFieldType

value stringrequired

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

exch_rate (number | null)

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

external_id (string | null)

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.

invoice_number object
The identification number for the document. Typically found on invoices.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
incoterms object
The incoterms to specify who pays and manages the shipment, insurance, documentation, customs clearance, and other logistics.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
insurance object
The insurance cost. Typically found on invoices.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
notes (string | null)

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

purchase_order_number object
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.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
rounding object
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.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
shipping object
The cost of shipping or delivery of a package.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
status (string | null)

Possible values: [processed, reviewed, archived]

The value indicating the document's status.

store_number object
The subsidiaries, vendor, corporation, or organization identification number used for unique referencing.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
subtotal object
Total charges and credits before tip and tax, if applicable.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
tax object
The tax amount applied to the purchase(s).
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
tip object
The amount of money that is given to someone for a service, also called gratuity. Usually present on receipts, not invoices.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
total object
The gross amount, including subtotal, tax, fees, etc.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
total_weight object
The total weight of all items listed on the document. Typically found on invoices.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
total_quantity object
The total quantity of items found on the document. In most cases, this number equals the sum of line item quantities.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
tracking_number object
The unique identifier assigned to a package for referencing its shipping information.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
tracking_numbers object
An array of unique identification numbers assigned to packages for referencing shipping information.
anyOf
MOD1
Array [
string
]
MOD2
Array [
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
]
vending_person object
The person or business who has provided services found on the document. This is the same as server_name.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
vending_person_number object
Identifier for the person or business who has provided services. Typically 'Cashier Number' on receipts or 'Sales Manager Number' on invoices.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
vin_number object
A vehicle identification number (VIN) is a unique code assigned to every motor vehicle when it's manufactured and found on the document.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
date object
Limit to past is 50 years, limit to future is 3 months
anyOf
MOD1
string
DetailedPUTDatetimeField
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.
value date-timerequired
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
]
due_date object
The date in ISO 8601 format. Typically found on invoices.
anyOf
MOD1
string
DetailedPUTDatetimeField
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.
value date-timerequired
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
]
delivery_date object
The date in ISO 8601 format. Typically found on invoices.
anyOf
MOD1
string
DetailedPUTDatetimeField
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.
value date-timerequired
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
]
service_start_date object
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.
anyOf
MOD1
string
DetailedPUTDateField
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.
value daterequired
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
]
service_end_date object
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.
anyOf
MOD1
string
DetailedPUTDateField
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.
value daterequired
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
]
ship_date object
The date when the order was or will be shipped in ISO 8601 format.
anyOf
MOD1
string
DetailedPUTDateField
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.
value daterequired
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
]
order_date object
The date when the goods or services were ordered in ISO 8601 format.
anyOf
MOD1
string
DetailedPUTDateField
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.
value daterequired
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
]
line_items object[]
A list of the products or services purchased or ordered on the submitted document.
Array [
category object
The category is taken from the line item with the same SKU and/or description. Otherwise from the root category field.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
country_of_origin object
The country of manufacture, production, design, or brand origin where the product comes from.
anyOf
MOD1
string
DetailedPUTCountryField
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: [IO, NA, PK, ZW, QA, RO, MT, ID, NF, MC, MW, PS, EC, SD, NG, AS, GF, GI, AE, HR, AU, SZ, CO, MO, VI, NE, RU, KR, YT, CL, ER, PA, DE, IS, TC, PG, AF, SE, VU, EE, CG, GR, CX, OM, MN, BH, DJ, GB, AN, KW, PW, CM, BF, PM, US, SO, TF, BZ, SL, LR, LT, SA, PY, GS, SY, GP, GG, CF, MG, PN, AZ, GD, JP, BL, CA, NO, CV, UY, BS, BN, GW, MX, MZ, KZ, HU, AO, LC, CU, GT, DM, PH, WS, KP, SR, AM, VC, LU, BY, VE, AI, VA, LY, PF, BD, BT, CR, FR, FM, TH, MF, CK, MY, PL, BM, ES, FO, IL, ST, TD, KN, NZ, BB, PR, SK, VN, ML, CD, NP, AX, PE, GL, IE, JE, AL, LV, LS, TT, BO, TZ, UA, AG, ET, NU, RW, AW, SM, NC, UM, AD, FI, EG, KE, MS, YE, GY, PT, VG, BG, GE, MR, NR, TR, AT, LI, RE, AQ, MH, MV, TN, SV, GH, HT, JO, MM, SI, SH, UZ, MP, KM, BE, HM, SG, SB, TL, FJ, MU, ME, BJ, CH, AR, TJ, KI, BW, CN, GQ, SJ, LB, TO, TV, GA, TG, HK, IM, BA, CI, MK, TM, KH, CY, ZA, LK, WF, MQ, SN, BI, DK, GN, NL, NI, FK, SC, IT, UG, CC, GM, BR, TW, CZ, KY, TK, RS, DZ, EH, DO, JM, MD, LA, KG, MA, IQ, ZM, IR, HN, BV, IN, GU]
date object
The date found on the document and associated with the line item in ISO 8601 format.
anyOf
MOD1
string
DetailedPUTDateField
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.
value daterequired
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
]
description object
The product or service's extracted name or description excluding date and price.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
discount_price object
The lower price after discount.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
discount_rate object
The discount percentage that was applied to the line item.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
discount object
The amount deducted from the total price for the line item.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
end_date object
A service end date identified for the line item in ISO 8601 format.
anyOf
MOD1
string
DetailedPUTDateField
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.
value daterequired
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
]
full_description object
The item text including dates, weight, etc.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
gross_total object
The line item total before deductions.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
hsn object
The Harmonized System Nomenclature (HSN) found for the line item.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
order integerrequired
The value indicating the position of where the line item appears on the document.
lot object
The batch or lot number for the line item.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
net_total object
The line item total after deductions.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
normalized_description object
The line item description with expanded words
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
price object
The unit price for the line item.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
quantity object
The amount or number of units for the line item.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
reference object
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
section object
A grouping indicated by formatted text on the receipt or invoice.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
sku object
The Stock Keeping Unit (SKU) is the unique code associated with the product for the line item.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
start_date object
A service start date identified for the line item in ISO 8601 format.
anyOf
MOD1
string
DetailedPUTDateField
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.
value daterequired
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
]
tags string[]
Possible values: non-empty
A user-defined list of identifiers that help to categorize or flag particular types of line items.
tax_code object
The classification of goods and services for tax purposes for the line item.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
manufacturer object
The name of the manufacturer of the product for the line item.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
tax_rate object
The percent at which the individual or corporation is taxed for the line item.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
tax object
The amount at which the individual or corporation is taxed for the product on this line item.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
text (string | null)
Possible values: non-empty and <= 1000 characters
The complete text returned for the line item, including prices, dates, etc.
total object
The total price for this line item.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
subtotal object
Total charges and credits before tip and tax, if applicable.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
type object
The classification of the product. The line type predicted by Veryfi, e.g. food.
anyOf
MOD1
string
PUTLineItemTypesFieldType
value stringrequired
Possible values: [room, tax, parking, service, fee, delivery, product, food, alcohol, tobacco, transportation, fuel, refund, discount, payment, giftcard, donation, toll, lottery]
unit_of_measure object
The unit of measurement for this line item.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
upc object
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.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
weight object
The weight of the item for the line item. Usually found on logistic invoices.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
custom_fields object
A user-defined dictionary that contains all the custom fields generated by applying specific rules and regular expressions to the extracted data.
anyOf
]
tax_lines object[]
A detailed breakdown of tax elements usually found in a tax table.
Array [
base object
The base amount of the tax applied.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
name object
The name of the sales tax type.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
rate object
The tax rate (percentage) applied to the base amount.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
total object
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.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
code object
The tax identification code.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
total_inclusive object
The base rate + tax amount.
anyOf
MOD1
number
DetailedPUTFloatField
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.
value (number | null)required
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
]
order integerrequired
The arrangement of tax lines in relation to each other.
]
vendor VendorPUTParameters
An object containing a detailed breakdown of vendor elements.
abn_number object
An Australian Business Number (ABN) is a unique 11-digit number that identifies a business to the government and community and found on the document.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
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
PUTCurrencyFieldType
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.
value (string | null)required
Possible values: [BMD, RSD, AFN, LTL, XCD, ILS, BGN, JEP, QAR, GGP, NOK, HTG, CRC, NAD, EGP, SBD, YER, ARS, BHD, CAD, SOS, DKK, IMP, MKD, EEK, TWD, GNF, NZD, FKP, RON, LKR, SVC, BYR, MVR, TRY, USD, INR, LVL, GBP, AZN, GIP, SZL, UAH, KRW, UYU, BRL, KWD, SHP, JPY, KZT, ZAR, SGD, UGX, GTQ, HRK, NGN, LBP, ISK, BND, PAB, BSD, HUF, AUD, JMD, HNL, EUR, AED, IDR, LSL, ALL, TTD, MOP, TVD, RUB, TRL, BBD, GHC, SAR, PHP, BZD, VND, CZK, SEK, IQD, SRD, PYG, CUP, SCR, HKD, AMD, CNY, NIO, PKR, KGS, MXN, PLN, ZWD, MNT, NPR, DOP, LRD, COP, UZS, MUR, IRR, LAK, CLP, BWP, CHF, PEN, SYP, FJD, GEL, BOB, BAM, OMR, THB, VEF, KYD, KHR, AWG, GYD, MYR, MZN, ANG, KPW]
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
]
account_number object
The vendor's bank account number.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
address object
The address of the vendor.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
bank_name object
The name of the bank. Could be part of invoice remittance information.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
bank_number object
The bank routing number. Could be part of invoice remittance information.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
bank_swift object
The Society for Worldwide Interbank Financial Telecommunication (SWIFT) code is part of the ISO 9362 standards for sending money internationally.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
biller_code object
The vendor identification code in a payment system.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
country_code object
The country code belonging to a vendor
anyOf
MOD1
string
DetailedPUTCountryField
score (number | null)
Possible values: <= 1
The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.
bounding_region number[]
Possible values: >= 8, <= 8
An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.
bounding_box object[]
Possible values: >= 5, <= 5
An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.
Array [
anyOf
MOD1
number
MOD2
integer
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: [IO, NA, PK, ZW, QA, RO, MT, ID, NF, MC, MW, PS, EC, SD, NG, AS, GF, GI, AE, HR, AU, SZ, CO, MO, VI, NE, RU, KR, YT, CL, ER, PA, DE, IS, TC, PG, AF, SE, VU, EE, CG, GR, CX, OM, MN, BH, DJ, GB, AN, KW, PW, CM, BF, PM, US, SO, TF, BZ, SL, LR, LT, SA, PY, GS, SY, GP, GG, CF, MG, PN, AZ, GD, JP, BL, CA, NO, CV, UY, BS, BN, GW, MX, MZ, KZ, HU, AO, LC, CU, GT, DM, PH, WS, KP, SR, AM, VC, LU, BY, VE, AI, VA, LY, PF, BD, BT, CR, FR, FM, TH, MF, CK, MY, PL, BM, ES, FO, IL, ST, TD, KN, NZ, BB, PR, SK, VN, ML, CD, NP, AX, PE, GL, IE, JE, AL, LV, LS, TT, BO, TZ, UA, AG, ET, NU, RW, AW, SM, NC, UM, AD, FI, EG, KE, MS, YE, GY, PT, VG, BG, GE, MR, NR, TR, AT, LI, RE, AQ, MH, MV, TN, SV, GH, HT, JO, MM, SI, SH, UZ, MP, KM, BE, HM, SG, SB, TL, FJ, MU, ME, BJ, CH, AR, TJ, KI, BW, CN, GQ, SJ, LB, TO, TV, GA, TG, HK, IM, BA, CI, MK, TM, KH, CY, ZA, LK, WF, MQ, SN, BI, DK, GN, NL, NI, FK, SC, IT, UG, CC, GM, BR, TW, CZ, KY, TK, RS, DZ, EH, DO, JM, MD, LA, KG, MA, IQ, ZM, IR, HN, BV, IN, GU]
email object
The vendor's email address.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
fax_number object
The fax number of the vendor.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
iban object
The International Bank Account Number (IBAN) is a standard international numbering system developed to identify an overseas bank account.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
name object
The normalized name of the vendor.
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
phone_number object
The phone number of the vendor.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
raw_address object
The raw vendor address exactly as found on the document.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
raw_name object
The raw vendor name exactly as found on the document.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
reg_number object
The vendor registration number. In the U.S., this would be the Employer Identification Number (EIN). Does not include VAT (Europe) or EIN (US), which are recorded as vat_number.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
type object
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
order_number object
The unique identification number for the order and set by the vendor. Typically found on invoices.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
vat_number object
The value-added tax identification number (VAT) for this vendor and found on the document. VAT numbers can be found on European invoices. For United States invoices, the Employer Identification Number (EIN) of the vendor.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
web object
The vendor's website address (URL).
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
bill_to BillToPUTParameters
An object that describes a person or business that is billed for the amount found on the document.
name object
The name of the individual or business
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
address object
The address of the individual or business
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
vat_number object
The value-added tax identification number (VAT) for the payer and found on the document. VAT numbers can be found on European invoices. For United States invoices, the Employer Identification Number (EIN) of the payer.
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
email object
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
phone_number object
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
reg_number object
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
ship_to ShipToPUTParameters
An object that represents the information about a person or business receiving an order.
name object
The name of the individual or business
anyOf
MOD1
string
DetailedShortPUTField
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.
value (string | null)required
Possible values: non-empty
The value to update
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
]
address object
The address of the individual or business
anyOf
MOD1
string
DetailedPUTField
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.
value (string | null)required
Possible values: >= 4 characters
The value to update
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
]
custom_fields object
A user-defined dictionary that contains all the custom fields generated by applying specific rules and regular expressions to the extracted data.
anyOf
payment PaymentPUTParameters

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

terms object

The terms on when and how to pay for goods or services. Typically found on invoices.

anyOf

MOD1

string

DetailedPUTField

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.

value (string | null)required

Possible values: >= 4 characters

The value to update

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

]

card_number object

anyOf

MOD1

string

DetailedPUTField

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.

value (string | null)required

Possible values: >= 4 characters

The value to update

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

]

type object

The payment type found on the document.

anyOf

MOD1

string

PUTPaymentType

value (string | null)required

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

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.

meta PUTMeta

fraud_review PUTFraudReview

Changes to the fraud decision or types

decision (string | null)

Possible values: [fraud, not fraud, unknown]

The review decision for the document

types string[]

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

What kind of fraud type

fraud PUTFraud

Fraud detection results

color string

Possible values: [green, yellow, red]

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

digital_tampering_fields string[]

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

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

handwritten_fields string[]

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

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

Responses

200

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

external_id (string | null)

Possible values: non-empty

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

pdf_url uri

Possible values: non-empty and <= 2083 characters

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

id integerrequired

The unique number created to identify the document.

created_date date-time

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

updated_date date-time

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

img_thumbnail_url uri

Possible values: non-empty and <= 2083 characters

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

accounting_entry_type (string | null)

Possible values: [debit, credit]

Classifies the document as credit or debit for accounting purposes.

custom_fields CustomFields

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

duplicate_of (integer | null)

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

exch_rate (number | null)

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

img_blur (boolean | null)deprecated

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

img_file_name (string | null)

Possible values: non-empty

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

img_url uri

Possible values: non-empty and <= 2083 characters

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

is_approved boolean

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

is_blurry boolean[]deprecated

Deprecated. Please use meta.pages.is_blurry instead

is_document (boolean | null)

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

is_duplicate (boolean | null)

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

line_items object[]
A list of the products or services purchased or ordered on the submitted document.
Array [
id integerrequired
The unique number created to identify the Line Item object.
order integerrequired
The value indicating the position of where the line item appears on the document.
tags string[]
Possible values: non-empty
A user-defined list of identifiers that help to categorize or flag particular types of line items.
text stringrequired
Possible values: non-empty and <= 1000 characters
The complete text returned for the line item, including prices, dates, etc.
type stringrequired
Possible values: [room, tax, parking, service, fee, delivery, product, food, alcohol, tobacco, transportation, fuel, refund, discount, payment, giftcard, donation, toll, lottery]
The classification of the product. The line type predicted by Veryfi, e.g. food.
product_info object
Line item extra product info
anyOf
LineItemInfo
expanded_description stringrequired
Possible values: non-empty
brand (string | null)required
Possible values: non-empty
category string[]required
Possible values: non-empty
EmptyDict
date date
The date found on the document and associated with the line item in ISO 8601 format.
description stringrequired
Possible values: non-empty and <= 1000 characters
The product or service's extracted name or description excluding date and price.
full_description (string | null)
Possible values: non-empty and <= 1000 characters
The item text including dates, weight, etc.
normalized_description (string | null)
Possible values: non-empty
The line item description with expanded words
discount_price (number | null)
The lower price after discount.
discount_rate (number | null)
The discount percentage that was applied to the line item.
discount (number | null)
The amount deducted from the total price for the line item.
price (number | null)
The unit price for the line item.
quantity (number | null)
The amount or number of units for the line item.
reference (string | null)
Possible values: non-empty
section (string | null)
Possible values: non-empty
A grouping indicated by formatted text on the receipt or invoice.
sku (string | null)
Possible values: non-empty
The Stock Keeping Unit (SKU) is the unique code associated with the product for the line item.
tax_rate (number | null)
The percent at which the individual or corporation is taxed for the line item.
tax (number | null)
The amount at which the individual or corporation is taxed for the product on this line item.
total (number | null)
The total price for this line item.
subtotal (number | null)
Total charges and credits before tip and tax, if applicable.
unit_of_measure (string | null)
Possible values: non-empty
The unit of measurement for this line item.
category (string | null)
Possible values: non-empty
The category is taken from the line item with the same SKU and/or description. Otherwise from the root category field.
country_of_origin (string | null)
Possible values: [IO, NA, PK, ZW, QA, RO, MT, ID, NF, MC, MW, PS, EC, SD, NG, AS, GF, GI, AE, HR, AU, SZ, CO, MO, VI, NE, RU, KR, YT, CL, ER, PA, DE, IS, TC, PG, AF, SE, VU, EE, CG, GR, CX, OM, MN, BH, DJ, GB, AN, KW, PW, CM, BF, PM, US, SO, TF, BZ, SL, LR, LT, SA, PY, GS, SY, GP, GG, CF, MG, PN, AZ, GD, JP, BL, CA, NO, CV, UY, BS, BN, GW, MX, MZ, KZ, HU, AO, LC, CU, GT, DM, PH, WS, KP, SR, AM, VC, LU, BY, VE, AI, VA, LY, PF, BD, BT, CR, FR, FM, TH, MF, CK, MY, PL, BM, ES, FO, IL, ST, TD, KN, NZ, BB, PR, SK, VN, ML, CD, NP, AX, PE, GL, IE, JE, AL, LV, LS, TT, BO, TZ, UA, AG, ET, NU, RW, AW, SM, NC, UM, AD, FI, EG, KE, MS, YE, GY, PT, VG, BG, GE, MR, NR, TR, AT, LI, RE, AQ, MH, MV, TN, SV, GH, HT, JO, MM, SI, SH, UZ, MP, KM, BE, HM, SG, SB, TL, FJ, MU, ME, BJ, CH, AR, TJ, KI, BW, CN, GQ, SJ, LB, TO, TV, GA, TG, HK, IM, BA, CI, MK, TM, KH, CY, ZA, LK, WF, MQ, SN, BI, DK, GN, NL, NI, FK, SC, IT, UG, CC, GM, BR, TW, CZ, KY, TK, RS, DZ, EH, DO, JM, MD, LA, KG, MA, IQ, ZM, IR, HN, BV, IN, GU]
The country of manufacture, production, design, or brand origin where the product comes from.
custom_fields CustomFields
A user-defined dictionary that contains all the custom fields generated by applying specific rules and regular expressions to the extracted data.
product_details object[]
Product lookup details
Array [
avg_price (number | null)required
The average price of the product
brand (string | null)required
Possible values: non-empty
The brand name of the product
ean (string | null)required
Possible values: non-empty
European Article Number (EAN) of the product
extra_fields (object | null)required
Additional fields for the product details
gtin_14 (string | null)required
Possible values: non-empty
Global Trade Item Number (GTIN-14) of the product
match_score (number | null)required
Possible values: <= 1
The match score of the product
image (string | null)required
Possible values: non-empty
The image URL of the product
image_url (string | null)required
Possible values: non-empty
Alternative field for the image URL of the product
product_name stringrequired
Possible values: non-empty
The name of the product
segment (string | null)required
Possible values: non-empty
The market segment of the product
veryn stringrequired
Possible values: non-empty
The veryn identifier of the product
]
end_date date
A service end date identified for the line item in ISO 8601 format.
gross_total (number | null)
The line item total before deductions.
hsn (string | null)
Possible values: non-empty
The Harmonized System Nomenclature (HSN) found for the line item.
lot (string | null)
Possible values: non-empty
The batch or lot number for the line item.
start_date date
A service start date identified for the line item in ISO 8601 format.
tax_code (string | null)
Possible values: non-empty
The classification of goods and services for tax purposes for the line item.
manufacturer (string | null)
Possible values: non-empty
The name of the manufacturer of the product for the line item.
net_total (number | null)
The line item total after deductions.
upc (string | null)
Possible values: non-empty
The Universal Product Code (UPC), European Article Number (EAN), or Global Trade Item Number (GTIN) found for the line item on this document will be placed in this field.
weight (string | null)
Possible values: non-empty
The weight of the item for the line item. Usually found on logistic invoices.
]
tax_lines object[]
A detailed breakdown of tax elements usually found in a tax table.
Array [
order integerrequired
The arrangement of tax lines in relation to each other.
name stringrequired
Possible values: non-empty
The name of the sales tax type.
rate numberrequired
The tax rate (percentage) applied to the base amount.
total (number | null)required
The total amount of tax charged for this particular tax line item. If the document has multiple taxes on it those taxes will be returned in the list inside the taxes field. Note there are a couple of countries in the world that have 3 decimal places after the dot.
base numberrequired
The base amount of the tax applied.
code (string | null)
Possible values: non-empty
The tax identification code.
total_inclusive (number | null)
The base rate + tax amount.
]
model (string | null)

Possible values: non-empty

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

notes (string | null)

Possible values: non-empty

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

ocr_text (string | null)

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

payment_links string[]

Possible values: non-empty

Document payments links, included pdf hidden links

reference_number (string | null)deprecated

Possible values: non-empty

Deprecated. Use id.

status (string | null)

Possible values: [processed, reviewed, archived]

The value indicating the document's status.

tags object[]
A user-defined list of identifiers that help to categorize or flag particular types of documents. The Document object can have multiple tags. You can create tags by API or in Hub.
Array [
id integerrequired
The ID of the tag.
name stringrequired
Possible values: non-empty
The name of the tag.
]
total_pages (integer | null)deprecated

Deprecated. Use meta.total_pages.

warnings string[]

Possible values: non-empty

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

meta DocumentMeta

An object that describes document-related metadata information such as total pages found and the likelihood of fraud found on the document.

duplicates object[]

An array of duplicate documents found in the system.

Array [

id integerrequired

The id of the duplicate document.

url urirequired

Possible values: non-empty and <= 2083 characters

The url of the duplicate document.

score numberrequired

Possible values: <= 1

How close is the match

]

owner stringrequired

Possible values: non-empty

The API username for the account that processed the document.

total_pages (integer | null)required

The total number of pages found in the submitted document.

processed_pages (integer | null)required

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

pages object[]required

An array containing meta info about each extracted page

Array [

height (integer | null)required

Possible values: > 0

width (integer | null)required

Possible values: > 0

language object[]required

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

Array [

anyOf

MOD1

string

]

screenshot ScreenshotField

score (number | null)

Possible values: <= 1

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

type (string | null)required

Possible values: [mobile_screenshot, other_screenshot, ai_generated]

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

is_blurry ClassNullableBoolField

The processed page is blurry or not

score (number | null)

Possible values: <= 1

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

value (boolean | null)required

The extracted value.

]

source_documents object[]required

An array containing meta info about originally submitted documents

Array [

size_kb (integer | null)required

height (integer | null)required

width (integer | null)required

exif (object | null)

EXIF data from the source document

]

fraud Fraud

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

attribution (string | null)

Possible values: non-empty

Attribution of Fraud Detector's decision

decision (string | null)

Possible values: non-empty

Fraud Detector's decision

color (string | null)

Possible values: [green, yellow, red]

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

pages object[]

An array containing fraud info about each extracted page

Array [

anyOf

FraudPage

is_lcd ClassBoolField

score (number | null)

Possible values: <= 1

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

value booleanrequired

The extracted value.

]

images object[]deprecated

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

Array [

anyOf

LCD

score (number | null)

Possible values: <= 1

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

is_lcd (boolean | null)

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

]

score (number | null)

Possible values: <= 1

Confidence of Fraud Detector in it's prediction

version (string | null)

Possible values: non-empty

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

submissions object

The amount of submissions from specific device id.

property name* integer

fraudulent_pdf object

Results of the pdf analysis.

property name* number

types string[]

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

Default value: ``

List of attributions which marked the document as fraud

digital_tampering_fields string[]

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

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

fraud_review FraudReview

An object that contains information about the fraud review.

decision (string | null)

Possible values: [fraud, not fraud, unknown]

The review decision for the document

types string[]

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

Default value: ``

What kind of fraud type

warnings object[]

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

Array [

type stringrequired

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

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

message stringrequired

Possible values: non-empty

The detailed message about the warning.

]

handwritten_fields string[]

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

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

device_id (string | null)

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

Fingerprint of the device used to process the document.

device_user_uuid (string | null)

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

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

device_data ResponseDeviceData

lat (number | null)

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

lng (number | null)

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

source string

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

Default value: api

The source of the document's submission for processing.

language object[]required

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

Array [

anyOf

MOD1

string

]

ocr_score (number | null)required

Possible values: <= 1

The average OCR score of the whole document.

account_number (string | null)

Possible values: non-empty

The unique identifier of the customer assigned by the vendor.

balance (number | null)

The invoice or bill balance.

barcodes object[]
An array of barcodes extracted from the document if found.
Array [
data (string | null)
Possible values: non-empty
The machine-readable representation of the barcode found on the document.
type (string | null)
Possible values: non-empty
The name of the encoding for the barcode. Supported types include: QR Code, PDF417, EAN, UPC, Code128, Code39, I25
]
bill_to BillTo

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

name (string | null)

Possible values: non-empty

The name of the individual or business

address (string | null)

Possible values: non-empty

The address of the individual or business

email (string | null)

Possible values: non-empty

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

parsed_address ParsedAddress

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

building (string | null)

Possible values: non-empty

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

city (string | null)

Possible values: non-empty

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

country (string | null)

Possible values: non-empty

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

country_alpha_2 (string | null)

Possible values: non-empty

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

postcode (string | null)

Possible values: non-empty

The postal code used for mail sorting

state (string | null)

Possible values: non-empty

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

street_address (string | null)

Possible values: non-empty

A sum of house_number road, building, unit.

house (string | null)

Possible values: non-empty

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

house_number (string | null)

Possible values: non-empty

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

road (string | null)

Possible values: non-empty

Street name(s)

unit (string | null)

Possible values: non-empty

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

level (string | null)

Possible values: non-empty

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

staircase (string | null)

Possible values: non-empty

Numbered/lettered staircase

entrance (string | null)

Possible values: non-empty

Numbered/lettered entrance

po_box (string | null)

Possible values: non-empty

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

suburb (string | null)

Possible values: non-empty

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

city_district (string | null)

Possible values: non-empty

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

island (string | null)

Possible values: non-empty

Named islands e.g. "Maui"

state_district (string | null)

Possible values: non-empty

Usually a second-level administrative division or county.

country_region (string | null)

Possible values: non-empty

Informal subdivision of a country without any political status.

world_region (string | null)

Possible values: non-empty

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

phone_number (string | null)

Possible values: non-empty

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

reg_number (string | null)

Possible values: non-empty

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

vat_number (string | null)

Possible values: non-empty

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

cashback (string | null)

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

Possible values: non-empty

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

country_code (string | null)

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

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

currency_code (string | null)

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

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

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

default_category (string | null)

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

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 of an order's delivery in ISO 8601 format. Typically found on invoices.

delivery_note_number (string | null)

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 (number | null)

The amount deducted from the gross price.

document_type (string | null)

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

document_reference_number (string | null)

Possible values: non-empty

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

document_title (string | null)

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 date

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

final_balance (number | null)

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

guest_count (string | null)

Possible values: non-empty

The number of guests or seats extracted from the document.

incoterms (string | null)

Possible values: non-empty

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

insurance (number | null)

The insurance cost. Typically found on invoices.

invoice_number (string | null)

Possible values: non-empty

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

is_money_in (boolean | null)

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

is_transaction (boolean | null)

This flag marks card slips as true.

license_plate_number (string | null)

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 Payment

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

card_number (string | null)

Possible values: non-empty

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

display_name (string | null)

Possible values: non-empty

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

terms (string | null)

Possible values: non-empty

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

type (string | null)

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

The payment type found on the document.

previous_balance (number | null)

The previous invoice balance.

purchase_order_number (string | null)

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

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

Possible values: non-empty

The restaurant's server name.

service_start_date date

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 date

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 ShipTo

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

address (string | null)

Possible values: non-empty

The delivery address found on the document.

name (string | null)

Possible values: non-empty

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

parsed_address ParsedAddress

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

building (string | null)

Possible values: non-empty

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

city (string | null)

Possible values: non-empty

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

country (string | null)

Possible values: non-empty

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

country_alpha_2 (string | null)

Possible values: non-empty

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

postcode (string | null)

Possible values: non-empty

The postal code used for mail sorting

state (string | null)

Possible values: non-empty

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

street_address (string | null)

Possible values: non-empty

A sum of house_number road, building, unit.

house (string | null)

Possible values: non-empty

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

house_number (string | null)

Possible values: non-empty

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

road (string | null)

Possible values: non-empty

Street name(s)

unit (string | null)

Possible values: non-empty

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

level (string | null)

Possible values: non-empty

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

staircase (string | null)

Possible values: non-empty

Numbered/lettered staircase

entrance (string | null)

Possible values: non-empty

Numbered/lettered entrance

po_box (string | null)

Possible values: non-empty

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

suburb (string | null)

Possible values: non-empty

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

city_district (string | null)

Possible values: non-empty

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

island (string | null)

Possible values: non-empty

Named islands e.g. "Maui"

state_district (string | null)

Possible values: non-empty

Usually a second-level administrative division or county.

country_region (string | null)

Possible values: non-empty

Informal subdivision of a country without any political status.

world_region (string | null)

Possible values: non-empty

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

shipping (number | null)

The cost of shipping or delivery of a package.

store_number (string | null)

Possible values: non-empty

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

subtotal (number | null)

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

tax (number | null)

The tax amount applied to the purchase(s).

tip (number | null)

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

total (number | null)

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

total_quantity (number | null)

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

total_weight (string | null)

Possible values: non-empty

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

tracking_number (string | null)

Possible values: non-empty

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

tracking_numbers object[]
An array of unique identification numbers assigned to packages for referencing shipping information.
Array [
anyOf
MOD1
string
]
vending_person (string | null)

Possible values: non-empty

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

vending_person_number (string | null)

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 Vendor

An object containing a detailed breakdown of vendor elements.

abn_number (string | null)

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

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

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

Possible values: non-empty

The vendor's bank account number.

address (string | null)

Possible values: non-empty

The address of the vendor.

biller_code (string | null)

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

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

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.

vendor_account_number (string | null)

Possible values: non-empty

The vendor's bank account number.

vendor_bank_address (string | null)

Possible values: non-empty

The address of the vendor bank.

parsed_address ParsedAddress

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

building (string | null)

Possible values: non-empty

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

city (string | null)

Possible values: non-empty

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

country (string | null)

Possible values: non-empty

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

country_alpha_2 (string | null)

Possible values: non-empty

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

postcode (string | null)

Possible values: non-empty

The postal code used for mail sorting

state (string | null)

Possible values: non-empty

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

street_address (string | null)

Possible values: non-empty

A sum of house_number road, building, unit.

house (string | null)

Possible values: non-empty

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

house_number (string | null)

Possible values: non-empty

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

road (string | null)

Possible values: non-empty

Street name(s)

unit (string | null)

Possible values: non-empty

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

level (string | null)

Possible values: non-empty

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

staircase (string | null)

Possible values: non-empty

Numbered/lettered staircase

entrance (string | null)

Possible values: non-empty

Numbered/lettered entrance

po_box (string | null)

Possible values: non-empty

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

suburb (string | null)

Possible values: non-empty

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

city_district (string | null)

Possible values: non-empty

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

island (string | null)

Possible values: non-empty

Named islands e.g. "Maui"

state_district (string | null)

Possible values: non-empty

Usually a second-level administrative division or county.

country_region (string | null)

Possible values: non-empty

Informal subdivision of a country without any political status.

world_region (string | null)

Possible values: non-empty

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

vendor_bank_addresses object[]

Array [

anyOf

MOD1

string

]

vendor_bank_name (string | null)

Possible values: non-empty

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

vendor_bank_names object[]

Array [

anyOf

MOD1

string

]

vendor_bank_number (string | null)

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

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

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

Possible values: non-empty

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

bank_number (string | null)

Possible values: non-empty

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

bank_swift (string | null)

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

Possible values: non-empty

Same as vendor.type

country_code (string | null)

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

The country code belonging to a vendor

email (string | null)

Possible values: non-empty

The vendor's email address.

external_id (string | null)

Possible values: non-empty

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

fax_number (string | null)

Possible values: non-empty

The fax number of the vendor.

iban (string | null)

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

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

lng (number | null)

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

logo uri

Possible values: non-empty and <= 2083 characters

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

logo_name (string | null)

Possible values: non-empty

A vendor logo 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 (string | null)

Possible values: non-empty

The normalized name of the vendor.

parsed_address ParsedAddress

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

building (string | null)

Possible values: non-empty

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

city (string | null)

Possible values: non-empty

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

country (string | null)

Possible values: non-empty

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

country_alpha_2 (string | null)

Possible values: non-empty

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

postcode (string | null)

Possible values: non-empty

The postal code used for mail sorting

state (string | null)

Possible values: non-empty

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

street_address (string | null)

Possible values: non-empty

A sum of house_number road, building, unit.

house (string | null)

Possible values: non-empty

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

house_number (string | null)

Possible values: non-empty

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

road (string | null)

Possible values: non-empty

Street name(s)

unit (string | null)

Possible values: non-empty

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

level (string | null)

Possible values: non-empty

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

staircase (string | null)

Possible values: non-empty

Numbered/lettered staircase

entrance (string | null)

Possible values: non-empty

Numbered/lettered entrance

po_box (string | null)

Possible values: non-empty

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

suburb (string | null)

Possible values: non-empty

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

city_district (string | null)

Possible values: non-empty

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

island (string | null)

Possible values: non-empty

Named islands e.g. "Maui"

state_district (string | null)

Possible values: non-empty

Usually a second-level administrative division or county.

country_region (string | null)

Possible values: non-empty

Informal subdivision of a country without any political status.

world_region (string | null)

Possible values: non-empty

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

phone_number (string | null)

Possible values: non-empty

The phone number of the vendor.

raw_address (string | null)

Possible values: non-empty

The raw vendor address exactly as found on the document.

raw_name (string | null)

Possible values: non-empty

The raw vendor name exactly as found on the document.

reg_number (string | null)

Possible values: non-empty

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

type object

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

anyOf

MOD1

string

MOD2

string

order_number (string | null)

Possible values: non-empty

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

vat_number (string | null)

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. For United States invoices, the Employer Identification Number (EIN) of the vendor.

web (string | null)

Possible values: non-empty

The vendor's website address (URL).

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 [
anyOf
MOD1
string
]
vin_number (string | null)

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 object[]
An array of the weights found on the document.
Array [
anyOf
MOD1
string
]

Example (from schema)

{
  "id": 0,
  "accounting_entry_type": "debit",
  "custom_fields": {},
  "is_approved": true,
  "status": "processed",
  "country_code": "IO",
  "currency_code": "BMD",
  "default_category": "other",
  "document_type": "other"
}

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

Example (from schema)

{}

403

User error

application/json

Schema

Schema

oneOf

AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED

status string

Default value: fail

error string

Default value: Authentication credentials were not provided.

Example (from schema)

{}

404

Not found

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)

{}

413

Request body too large

application/json

Schema

Schema

oneOf

REQUEST_BODY_TOO_LARGE

status string

Default value: fail

error string

Default value: Request body too large

Example (from schema)

{}

429

Rate limit

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)

{}

500

Unexpected error

503

Service is temporarily unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

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

Example (from schema)

{}

504

Gateway timeout. Returned if request takes more than 100 seconds. The request might finish successfully later.

application/json

Schema

Schema

oneOf

GATEWAY_TIMEOUT

status string

Default value: fail

error string

Default value: Gateway timeout

Example (from schema)

{}

default

General error response

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

{
  "status": "fail",
  "error": "string"
}

Loading...