Microservices
Updated On 24 March 2024 |
Min(s) read
Enterprise APIs
The Document Storage exposes the following business and internal APIs as the REST endpoints. The table below summarizes the APIs.
For the complete APIs specification, see service specification (Swagger) or Swagger JSON file.
Version 1.0.0
| CATEGORY | FUNCTIONALITY | OPERATION ID | ACTION | URI | HTTP method | API DESCRIPTION |
|---|---|---|---|---|---|---|
| Business API | Documents | uploadDocument | /documents/ | POST | Upload a new document to the downstream DMS after virus scanned. | |
| generateDocument | /documents/generation | POST | Generate document based on template name and temple data and return the binary document. | |||
| downloadDocument | /documents/ | GET | Download a document using documentId. | |||
| deleteDocument | /documents/ | DELETE | Delete a document using documentId. | |||
| searchDocuments | /documents/ | GET | Search Document ID(s) using previously defined search metadata. | |||
| updateDocument | DELIVERY | /documents/ | PUT |
To promote Temenos Digital documents to the core banking documents.
|
||
| UPDATE_METADATA | /documents/ | PUT |
To update the existing document search metadata.
|
|||
| ADD_METADATA | /documents/ | PUT | To add new metadata to the
existing document search metadata.
|
|||
| Evidences | getEvidencesCategories | /evidences/categories | GET | Get all evidence categories | ||
| getEvidenceType | /evidences/types/ | GET | Get a evidence type | |||
| getEvidenceTypes | /evidences/types/ | GET | Get all evidence types | |||
| submitEvidenceForParty | evidences/ | POST | Submit evidences for a party owner without any fulfilment | |||
| updateExistingEvidence | VALIDITY | evidences/ | PUT | To make the current valid evidence to invalid. Cannot make an invalid evidence valid. | ||
| RESUSE | evidences/ | PUT | Change the reusability of an evidence | |||
| REVIEW | evidences/ | PUT | Make an evidence accepted/rejected | |||
| getSubmittedEvidences | evidences/ | GET | Get all non-fulfilment submitted evidences | |||
| getEvidencesOfOwner | /evidences/owner/ | GET | Get all evidences of a owner | |||
| updatePartyIdForEvidences | /evidences/owner/ | PUT |
If the owner type of the owner is "newProspect", the onwer type will be updated to "verifiedProspect"
If the ownerType of the owner is "verifiedProspect', the onwer type will be updated to "party" and all the valid documents will be promoted from Temenos Digitaldocuments to core banking documents |
|||
| deleteEvidencesOfOwner | /evidences/owner/ | DELETE | Delete all the evidences of owner | |||
| deleteEvidencesOfApplication | /evidences/application/ | DELETE | Delete all the information related to that application, but retain valid party documents since this can be reused | |||
| createApplicationFulfilment | /evidences/fulfilments/ | POST | ||||
| getApplicationFulfilment | /evidences/fulfilments/ | GET | ||||
| submitApplicationEvidence | /evidences/fulfilments/{appFulfilmentId}/appevidences | POST | ||||
| addApplicationEvidence | /evidences/appevidences/{appEvidenceId} | POST | ||||
| useAcceptedEvidence | /evidences/fulfilments/{appFulfilmentId}/appevidences/{appEvidenceId} | PUT | ||||
| deleteApplicationEvidence | /evidences/fulfilments/{appFulfilmentId}/appevidences/{appEvidenceId} | DELETE | ||||
| Admin API | Documents | getDocumentInfo | /documents/info/ | GET | Show the DocumentEntity data. | |
| Evidences | createEvidenceCategory | /evidences/categories | POST | Create a evidence category | ||
| createEvidenceCategory | /evidences/categories | POST | Create a evidence category | |||
| deleteEvidenceCategory | /evidences/categories/ | DELETE | Delete an existing evidence category with category id | |||
| createEvidenceType | /evidences/types | POST | Create a evidence type | |||
| updateEvidenceType | /evidences/types | PUT | Update an existing evidence type with type id | |||
| deleteEvidenceType | /evidences/types | DELETE | Delete an existing evidence type with type id |
In this topic