Main ReferenceDocuments

Update document information

Update the extracted data or custom metadata of a document. The document must be in `pendingCorrection` state. Documents in other states (such as `approved`) cannot be modified through this endpoint — a `403` error will be returned. To change a document's state, use the dedicated [Update document public state](/api-reference/main-reference/documents/change-the-public-state-of-a-document) endpoint.

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.

Response

Updated document
_idstringformat: "DocumentId"
accountstringformat: "AccountId"
Account the document belongs to.
environmentstringformat: "EnvironmentId"
Environment the document belongs to.
companystringformat: "CompanyId"
Company the document belongs to.
creatorstringformat: "UserId"
User that uploaded the document
clientDataobject

“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
Allowed values:
namestring
Original name of the uploaded file
isGroundTruthboolean

Indicates the document is marked as Ground Truth (GT)

creationstringformat: "date-time"
Upload timestamp
imageslist of strings

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

originalstringformat: "URL"

Azure Storage URL (SAS) to access the original file

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

Errors

400
Bad Request Error
403
Forbidden Error
410
Gone Error
429
Too Many Requests Error
500
Internal Server Error