Main ReferenceDocuments

Update document information

Update the extracted data or custom metadata of a document — for example, to submit corrections or feedback on the extracted fields. Documents in pendingCorrection or approved state can be updated through this endpoint.

Autenticación

x-api-keystring

Autenticación con clave API vía encabezado

Parámetros de ruta

idstringRequerido
id of the document to modify

Solicitud

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

Respuesta

Updated document
_idstringOpcionalformat: "DocumentId"
accountstringOpcionalformat: "AccountId"
Account the document belongs to.
environmentstringOpcionalformat: "EnvironmentId"
Environment the document belongs to.
companystringOpcionalformat: "CompanyId"
Company the document belongs to.
creatorstringOpcionalformat: "UserId"
User that uploaded the document
clientDataobjectOpcional

“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> } ].”

typeenumOpcional
namestringOpcional
Original name of the uploaded file
isGroundTruthbooleanOpcional

Indicates the document is marked as Ground Truth (GT)

creationstringOpcionalformat: "date-time"
Upload timestamp
imageslist of stringsOpcional

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

originalstringOpcionalformat: "URL"

Azure Storage URL (SAS) to access the original file

mimetypestringOpcional
datamap from strings to anyOpcional
Extracted document data. Structure varies by document type.
publicStateenumOpcionalValor predeterminado: processing
confidenceenumOpcional
processInfoobjectOpcional
validationInfoobjectOpcional
approvalInfoobjectOpcional
importobjectOpcional
exportslist of objectsOpcional
geometryobjectOpcional
deletedbooleanOpcional
Indicates whether the document has been logically deleted
duplicatedbooleanOpcionalDeprecated

Errores

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