Main ReferenceDocuments

Update document information

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
id of the document to modify

Request

This endpoint expects an object.
datamap from strings to objectsOptional
Document data to update. Can contain any field extracted from the document.
clientDatamap from strings to anyOptional
Custom metadata object for your application's use. This data is stored with the document but not processed by Invofox.
publicStateenumOptional

Public state of the document. Only these user-controllable states are allowed for updates.

Allowed values:

Response

Updated document
_idstring or nullformat: "DocumentId"
accountstring or nullformat: "AccountId"
Account the document belongs to.
environmentstring or nullformat: "EnvironmentId"
Environment the document belongs to.
companystring or nullformat: "CompanyId"
Company the document belongs to.
creatorstring or nullformat: "UserId"
User that uploaded the document
clientDataobject or null
"Additional data to be added to each document. Must be an object or an array of objects. If data to be specified to each document is different, this parameter should have the following format: `[ { _filename: <name of the file to which attach this data>, <key>: <value> }, ... { _filename: <name of the file to which attach this data>, <key>: <value> } ]`."
typeenum or null
Allowed values:
namestring or null
Original name of the uploaded file
isGroundTruthboolean or null

Indicates the document is marked as Ground Truth (GT)

creationstring or nullformat: "date-time"
Upload timestamp
imageslist of strings or null

Array of Azure Storage URLs (SAS) to access the document extracted images

originalstring or nullformat: "URL"

Azure Storage URL (SAS) to access the original file

mimetypestring or null
datamap from strings to any or null
Extracted document data. Structure varies by document type.
publicStateenum or nullDefaults to processing
confidenceenum or null
Allowed values:
processInfoobject or null
validationInfoobject or null
approvalInfoobject or null
importobject or null
exportslist of objects or null
geometryobject or null
deletedboolean or null
Indicates whether the document has been logically deleted
duplicatedboolean or nullDeprecated

Errors