Document

The Document API allows you to perform the normal file system actions: create, update, move, copy, delete, download, and list information about files. Since most use cases involve some basic file system operation, this is one of our core APIs.

Let’s proceed to create a document. If you imported our Postman Collection, you can follow-along with the examples by invoking the requests in the Document Vault folder.

Introduction

1.1 The client needs to authenticate themselves for this request. Typically the service will allow accepting the client ID and secret in the HTTP Basic auth header, and add user_id to represent the specific user.

API Request

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

Data Model

Download file

1.2 When you successfully uploaded the file, you could download the file

API Request

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

Data Model

Preview file

1.3 When you successfully uploaded the file, you could preview the file as well

API Request

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

Data Model

Delete file

1.4 When you successfully uploaded the file, you could delete the file with associated versions

API Request

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

Data Model

🚧

File Delete Warning

Delete a document from the vault. Please note that when a document is deleted, all its associated file versions will also be permanently removed.