Enterprise APIs

The Document Storage exposes the following business and internal APIs as the REST endpoints. The table below summarizes the APIs.

Version 1.0.0

CATEGORY	OPERATION ID	ACTION	URI	API DESCRIPTION
Business API	uploadDocument		/documents/	Upload a new document to the downstream DMS after virus scanned.
	downloadDocument		/documents/	Download a document using documentId.
	deleteDocument		/documents/	Delete a document using documentId.
	searchDocuments		/documents/	Search Document ID(s) using previously defined search metadata.
	updateDocument	DELIVERY	/documents/	To promote infinity documents to the core banking documents. Document moved from infinity channel to core channel in DMS Remove all the old metadata Update with the new metadata in the request Update with the new document group A new document ID will be generated and returned.
		UPDATE_METADATA	/documents/	To update the existing document search metadata. Remove all the old metadata Update with the new metadata in the request Document ID and its channel and owner system ID remains unchanged.
		ADD_METADATA	/documents/	To add new metadata to the existing document search metadata. Add new metadata to the existing document Old metadata will remain Reject the request if new metadata key already exists. (case sensitive) Document ID and its channel and owner system ID remains unchanged.
Admin API	getDocumentInfo		/documents/info/	Show the DocumentEntity data.

For the complete APIs specification, see service specification (Swagger) or Swagger JSON file.

Dark Mode

Expand/Collapse

Share

Print

In this topic

Feedback

x

Feedback