Guides
Home

File Versions

In a Document Vault system, document versions refer to different iterations or revisions of a particular document that have been saved over time. Each version typically represents a snapshot of the document at a specific point in its editing history

Document versions are a critical feature of the Document Vault system, offering a way to track and manage changes made to a document over time. Each version preserves the document's content as it existed at a particular moment, allowing users to reference or revert to previous states

Key Features and Benefits:

  1. Version Tracking: Document versions enable a chronological record of changes made to a document. Users can see how the document has evolved, including who made the changes and when.
  2. Change History: By comparing versions, users can identify modifications, additions, and deletions. This facilitates collaboration and accountability, as well as ensuring compliance with regulatory requirements.
  3. Reversion and Rollback: Users can revert to a previous version of a document if needed. This is particularly useful when errors are introduced or when a previous version is preferred.
  4. Audit Trail: Document versions contribute to an audit trail, helping organizations maintain transparency and traceability in their document management processes.
  5. Document Comparison: Users can compare different versions to highlight textual differences, aiding in identifying changes and ensuring accuracy.

Delete a file version

API Request

Delete /api/v1/cores/document-vault/records/{externalId}/versions HTTP/1.1
Host: api-dev.fintechautomation.com
Accept: application/json
Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==

Data Model

FieldTypeDescriptionOptional/Required
externalIdstringquery parameterrequired
versionIdstringquery parameterrequired

Download specific file version

API Request

POST /api/v1/cores/document-vault/files/history/{externalId}/download HTTP/1.1
Host: api-dev.fintechautomation.com
Accept: application/json
Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==

Data Model

FieldTypeDescriptionOptional/Required
externalIdstringpath parameterrequired
versionIdstringfile version idrequired

List file versions

API Request

POST /api/v1/cores/document-vault/records/{externalId}/versions HTTP/1.1
Host: api-dev.fintechautomation.com
Accept: application/json
Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==

Data Model

FieldTypeDescriptionOptional/Required
externalIdstringquery parameterrequired