Update a Line Item

PUT 
/api/v8/partner/documents/:document_id/line-items/:line_item_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.

line_item_id int64required

The unique identifier of the line item.

application/json

Body

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

DetailedClassPUTField

value stringrequired

Possible values: >= 4 characters

The value to update

country_of_origin object

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

anyOf

MOD1

string

PUTLineItemCountryOfOriginFieldType

value stringrequired

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

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
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 stringrequired
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_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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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
]
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 stringrequired
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 integer
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 stringrequired
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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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. This value is computable.
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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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 stringrequired
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 stringrequired
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 stringrequired
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 stringrequired
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 stringrequired
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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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 price for this line item. This value is computable.
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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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. This value is computable.
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 numberrequired
bounding_box object[]
Possible values: >= 5, <= 5
An array 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

PUTLineItemTypeFieldType

value stringrequired

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

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

Responses

200

Document's Line Item

application/json

Schema

Schema

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]

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

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

Possible values: non-empty and <= 1000 characters

The item text including dates, weight, etc.

normalized_description string

Possible values: non-empty

The line item description with expanded words

discount_price number

The lower price after discount.

discount_rate number

The discount percentage that was applied to the line item.

discount number

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

price number

The unit price for the line item.

quantity number

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

reference string

Possible values: non-empty

section string

Possible values: non-empty

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

sku string

Possible values: non-empty

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

tax_rate number

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

tax number

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

total number

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

subtotal number

Total charges and credits before tip and tax, if applicable. This value is computable.

unit_of_measure string

Possible values: non-empty

The unit of measurement for this line item.

category string

Possible values: non-empty

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

country_of_origin string

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

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

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.

product_details object[]
Product lookup details
Array [
avg_price numberrequired
The average price of the product
brand stringrequired
Possible values: non-empty
The brand name of the product
ean stringrequired
Possible values: non-empty
European Article Number (EAN) of the product
extra_fields objectrequired
Additional fields for the product details
gtin_14 stringrequired
Possible values: non-empty
Global Trade Item Number (GTIN-14) of the product
match_score numberrequired
Possible values: <= 1
The match score of the product
image stringrequired
Possible values: non-empty
The image URL of the product
image_url stringrequired
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 stringrequired
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

The line item total before deductions.

hsn string

Possible values: non-empty

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

lot string

Possible values: non-empty

The batch or lot number for the line item.

start_date date

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

tax_code string

Possible values: non-empty

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

manufacturer string

Possible values: non-empty

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

net_total number

The line item total after deductions.

upc string

Possible values: non-empty

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

weight string

Possible values: non-empty

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

Example (from schema)

{
  "id": 0,
  "order": 0,
  "tags": [
    "string"
  ],
  "text": "string",
  "type": "room",
  "date": "2025-02-16",
  "description": "string",
  "full_description": "string",
  "normalized_description": "string",
  "discount_price": 0,
  "discount_rate": 0,
  "discount": 0,
  "price": 0,
  "quantity": 0,
  "reference": "string",
  "section": "string",
  "sku": "string",
  "tax_rate": 0,
  "tax": 0,
  "total": 0,
  "subtotal": 0,
  "unit_of_measure": "string",
  "category": "string",
  "country_of_origin": "IN",
  "custom_fields": {},
  "product_details": [
    {
      "avg_price": 0,
      "brand": "string",
      "ean": "string",
      "extra_fields": {},
      "gtin_14": "string",
      "match_score": 0,
      "image": "string",
      "image_url": "string",
      "product_name": "string",
      "segment": "string",
      "veryn": "string"
    }
  ],
  "end_date": "2025-02-16",
  "gross_total": 0,
  "hsn": "string",
  "lot": "string",
  "start_date": "2025-02-16",
  "tax_code": "string",
  "manufacturer": "string",
  "net_total": 0,
  "upc": "string",
  "weight": "string"
}

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

details undefined[]

Default value: [object Object]

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)

{}

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)

{}

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

OperationStatus

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

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

Loading...