<html>
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui.css" />
<div id="swagger-ui"> </div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-bundle.js" type="text/javascript">
</script>
<script type="text/javascript">
const ui = SwaggerUIBundle({
spec:
{
"openapi": "3.0.0",
"servers": [
{
"description": "Locally Deployed Environment",
"url": "http://localhost:8600/ms-corporatelos-api/api/v1.0.0"
}
],
"info": {
"title": "Corporate LOS API",
"description": "This API enables you to programmatically access all data related to Corporate LOS that users has granted access.",
"version": "1.0.0",
"contact": {
"email": "mprasadambati@temenos.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/origination/corporate/deals": {
"post": {
"summary": "Creates a new Corporate Deal",
"description": "Creates new Corporate Deal record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "createCorporateDealV1",
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Creation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreationResponse"
}
}
}
},
"400": {
"description": "Deal Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the corporate deal record",
"description": "Retrieves corporate deal record based on the Deal Id, Deal Name, User Id.",
"operationId": "getCorporateDealsV1",
"tags": [
"Deal"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dealName",
"in": "query",
"description": "Deal Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "All Deal Details Retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllDealDetailsResponse"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}": {
"put": {
"summary": "Updates an existing Corporate Deal",
"description": "Update Corporate Deal record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "updateCorporateDealV1",
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealUpdatedResponse"
}
}
}
},
"400": {
"description": "Deal Update Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/facilities": {
"post": {
"summary": "Creates new facilities for a Deal",
"description": "Create Facility record with the provided data such as dealId, facilityType and partyId etc.",
"operationId": "createFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates already existing facilities for a Deal",
"description": "Update Facility record with the provided data such as dealId, facilityType and partyId etc.",
"operationId": "updateFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility": {
"get": {
"summary": "Retrieves the Facility record",
"description": "Retrieves the Facility record based on the Deal Id, Facility Id, Party Id and Facility Name .",
"operationId": "getFacilityV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityName",
"in": "query",
"description": "Facility Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Facility"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties": {
"post": {
"summary": "Create a relationship to the given Party id with the facility owner",
"description": "Create RelatedPartie record with the provided data such as dealId, facilityType and partyId etc.",
"operationId": "createRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the relationship to the given party id with the facilty owner",
"description": "Update RelatedPartie record with the provided data such as dealId, facilityId and partyId etc.",
"operationId": "updateRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the relatedParty record",
"description": "Retrieves the relatedParty record based on facilityId, relatedPartyId, partyId and dealId.",
"operationId": "getRelatedPartiesV1",
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatedPartyId",
"in": "query",
"description": "Related Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks/{indicator}": {
"post": {
"summary": "Creates tasks for a Deal",
"description": "Create Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "createTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "indicator",
"in": "path",
"description": "indicator",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks": {
"put": {
"summary": "Updates the Task record",
"description": "Update Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "updateTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks": {
"get": {
"summary": "Retrieves the details of tasks for the provided criteria",
"description": "Retrieves Task record based on dealId, partyId and Facility Id etc.",
"operationId": "getTasksV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "assignUserId",
"in": "query",
"description": "Assigned User Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "task status",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"in": "query",
"description": "task stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals": {
"post": {
"tags": [
"Collateral"
],
"summary": "Add a new collateral to the Deal",
"description": "Create collateral record with the provided data such as dealId, facilityId and collateral type etc.",
"operationId": "createCollateralV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "ID of deal for the request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of facility for the request",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Collateral"
],
"summary": "Update the collateral associated to the Deal",
"description": "Update collateral record with the provided data such as dealId, facilityId and collateral type etc.",
"operationId": "updateCollateralV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "ID of deal for the request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of facility for the request",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Collateral"
],
"summary": "Fetch the collaterals associated to the Deal/Facility/Party/Collateral",
"description": "Retrieves the collateral records based on dealId, facilityId, partyId and collateralId.",
"operationId": "getCollateralV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "DealId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "PartyId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents": {
"post": {
"summary": "creates new documents and adds them to deal",
"description": "Create document records with the provided data such as dealId, facilityId and document name etc.",
"operationId": "createDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCreationRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "updates the existing documents data",
"description": "Update document records with the provided data such as dealId, facilityId and document name etc.",
"operationId": "updateDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of documents for the provided criteria",
"description": "Retrieve the document records based on dealId, facilityId and partyId.",
"operationId": "getDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives": {
"post": {
"summary": "Create narrative and add to deal",
"description": "Create narrative records with the provided data such as dealId, facilityId , partyId and categoryId etc.",
"operationId": "createNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update narrative",
"description": "Update narrative records with the provided data such as dealId, facilityId, partyId and categoryId etc.",
"operationId": "updateNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Narrative records",
"description": "Retrieves the Narrative records based on dealId, facilityId and partyId.",
"operationId": "getNarrativesV1",
"tags": [
"Narratives"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/reference/{referenceId}": {
"get": {
"summary": "gets the reference data from reference tables",
"description": "Retrieves the reference data based on the referenceId.",
"operationId": "getRefData",
"tags": [
"Reference Data"
],
"parameters": [
{
"name": "referenceId",
"in": "path",
"description": "Reference Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerRequest": {
"post": {
"summary": "Stores the captured information of the request submission form",
"description": "Create customerRequest records with the provided data such as userId, requestId and customerInformation etc.",
"operationId": "createCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get all the information associated to the userid and requestid",
"description": "Retrieves customerRequest records based on userId, requestId and status.",
"operationId": "getCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "status",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestsInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions": {
"post": {
"summary": "Creates draw restrictions for a particular deal",
"description": "Create drawRestriction records with the provided data such as dealId, facilityId and restrictionType etc.",
"operationId": "createDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Draw restrictions against a deal",
"description": "Update drawRestriction records with the provided data such as dealId, facilityId and restrictionType etc.",
"operationId": "updateDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of draw restrictions against deal or facility",
"description": "Retrieves drawRestriction records based on dealId, facilityId.",
"operationId": "getDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance": {
"get": {
"summary": "Retrieves the details of the compliance for the provided criteria",
"description": "Retrieves the compliance records based on dealId, facilityId and complianceId.",
"operationId": "getComplianceV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "complianceId",
"in": "query",
"description": "complaince Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Compliance"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Compliance"
],
"summary": "Add a new compliance to the Deal",
"description": "Create the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "createComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails": {
"post": {
"summary": "Create funding details",
"description": "Create the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "createFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update fundings Details",
"description": "Update the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "updateFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Funding details",
"description": "Retrieves the funding records based on dealId, facilityId and fundingId.",
"operationId": "getFundingDetailsV1",
"tags": [
"Funding"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fundingId",
"in": "query",
"description": "Funding Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits": {
"post": {
"summary": "Create limit records",
"description": "Create the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "createLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Limit details to the given limit id",
"description": "Update the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "updateLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieve the Limit record",
"description": "Retrieve the Limit record based on limitId.",
"operationId": "getLimitsV1",
"tags": [
"Limits"
],
"parameters": [
{
"name": "limitId",
"in": "query",
"description": "limit Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees": {
"post": {
"summary": "create Fee details to the given facility/deal",
"description": "Create the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "createFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Fee details to the given id",
"description": "Update the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "updateFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Fee details to the given facility id/deal id",
"description": "Retrieve the Fee records based on dealId, facilityId, feeType.",
"operationId": "getFeesV1",
"tags": [
"Fees"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings": {
"post": {
"summary": "create Pricing details to the given deal/facility",
"description": "Create the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "createPricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Pricing details to the given Pricing id",
"description": "Update the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "updatePricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Pricing details to the given facility id",
"description": "Retrieve the Pricing records based on dealId, facilityId.",
"operationId": "getPricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "deal Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants": {
"post": {
"summary": "Creates covenants for a Deal",
"description": "Create the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "createCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Covenants for a Deal",
"description": "Update the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the details of covenants for the provided criteria",
"description": "Retrieve the Covenant records based on dealId, facilityId, partyId and covenantId.",
"operationId": "getCovenantsV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "covenantId",
"in": "query",
"description": "covenant Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/{facilityId}/creditDecisions": {
"post": {
"summary": "create credit decisions to the given facility",
"description": "Create the creditDecision records with the provided data such as dealId, facilityId and decisionDate etc.",
"operationId": "createCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions": {
"get": {
"summary": "get the credit decisions to the given facility",
"description": "Retrieve the creditDecision records based on facilityId and decisionId.",
"operationId": "getCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "decisionId",
"in": "query",
"description": "decision Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}": {
"get": {
"summary": "Retrieves the requestOverview details",
"description": "Retrieves the requestOverview details based on requestId.",
"operationId": "getRequestOverviewV1",
"tags": [
"RequestOverView"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure": {
"post": {
"summary": "Create Exposure records",
"description": "Create the Exposure records with the provided data such as partyId, exposureType and exposureUniqueId etc.",
"operationId": "createExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureType",
"in": "query",
"description": "exposureType",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given party",
"description": "Retrieve the exposure records based on partyId and exposureUniqueId.",
"operationId": "getExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/{facilityId}": {
"get": {
"summary": "Retrieves FacilityOverview details",
"description": "Retrieves FacilityOverview details based on facilityId.",
"operationId": "getFacilityOverviewV1",
"tags": [
"FacilityOverview"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasksparams": {
"get": {
"summary": "Retrieves the data related to tasks params",
"description": "Retrieves the task records based on taskStage and taskId.",
"operationId": "getTasksParamsV1",
"tags": [
"TasksParams"
],
"parameters": [
{
"name": "taskStage",
"in": "query",
"description": "Task Stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task ID",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksParamsReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/{partyId}": {
"get": {
"summary": "Retrieves PartyOverview details",
"description": "Retrieves PartyOverview details based on partyId.",
"operationId": "getEntityOverviewV1",
"tags": [
"EntityOverview"
],
"parameters": [
{
"name": "partyId",
"in": "path",
"description": "party Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message/{userId}": {
"post": {
"summary": "creates the messages to the dealId",
"description": "Create the messages records with the provided data such as userId, dealId and messagedescription etc.",
"operationId": "createMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessagesList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message": {
"get": {
"summary": "Retrieve the message records",
"description": "Retrieve the message records based on userId and messageId.",
"operationId": "getMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "messageId",
"in": "query",
"description": "message Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"FailureMessage": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"StandardErrorResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailureMessage"
}
},
"ProcessedFacilityResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"FacilityCreateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityType"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"FacilityUpdateRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "03",
"type": "string",
"x-referencetype": "FacilityType"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "01",
"type": "string",
"x-referencetype": "AcceptanceStatus"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"FacilityResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "Line of Credit",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "Working Capital",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "Awaiting Approval",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "Approved",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"FacilityCreateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
}
}
},
"FacilityUpdateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityUpdateRequest"
}
}
}
},
"FacilityResponses": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"RelatedPartiesSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"CreateRelatedPartiesRequest": {
"properties": {
"dealId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"UpdateRelatedPartiesRequest": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "D202012345678",
"type": "string"
},
"dealId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"RelatedPartiesResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "12345678",
"type": "string"
},
"dealId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "Guarantor",
"type": "string"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "Amount",
"type": "string"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CreateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
}
}
},
"UpdateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequest"
}
}
}
},
"RelatedPartiesResponses": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
}
}
},
"ProcessedTasksResponse": {
"properties": {
"taskId": {
"description": "Unique identifier for Task",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"NoteItem": {
"properties": {
"noteDescription": {
"description": "description notes",
"example": "task notes",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
}
}
},
"TasksRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskProvider"
},
"taskPackage": {
"description": "Package of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPackage"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskCategory"
},
"taskType": {
"description": "Type of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskType"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPriority"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"TasksResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "Moody's",
"type": "string"
},
"taskPackage": {
"description": "Package of the task",
"example": "Fraud-Check",
"type": "string"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "Prescreening",
"type": "string"
},
"taskType": {
"description": "Type of the task",
"example": "Auto",
"type": "string"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "In-Process",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "medium",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"TasksRequests": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksRequest"
}
}
}
},
"TasksResponses": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"CollateralRequest": {
"properties": {
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P129343",
"type": "string"
},
"collateralType": {
"description": "Type of the Collateral",
"example": "Personal property",
"type": "string"
},
"collateralSubType": {
"description": "Subtype of the Collateral",
"example": "sub property",
"type": "string"
},
"collateralName": {
"description": "Name of the Collateral",
"example": "Assert",
"type": "string"
},
"collateralMarketValue": {
"description": "Market value of the Collateral",
"example": "1000000",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of the Collateral",
"example": "1:2",
"type": "string"
},
"collateralStatus": {
"description": "Status of the Collateral",
"example": "inProgress",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral",
"example": "1001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CollateralResponse": {
"properties": {
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F200722894",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P129343",
"type": "string"
},
"collateralType": {
"description": "Type of the Collateral",
"example": "property",
"type": "string"
},
"collateralSubType": {
"description": "Subtype of the Collateral",
"example": "subproperty",
"type": "string"
},
"collateralName": {
"description": "Name of the Collateral",
"example": "Assert",
"type": "string"
},
"collateralMarketValue": {
"description": "Market value of the Collateral",
"example": "1000000",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of the Colateral",
"example": "1:2",
"type": "string"
},
"collateralStatus": {
"description": "Status of the Collateral",
"example": "inProgress",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral",
"example": "1001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the collateral was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CollateralRequests": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
}
}
},
"CollateralResponses": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
}
}
},
"ProcessedCollateralResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202035269718",
"type": "string"
},
"collateralId": {
"description": "Unique identifier for Collateral",
"example": "C202035292905",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"DocumentCreationRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentType"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategory"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"ProcessedDocumentsResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D2020123456",
"type": "string"
},
"documentId": {
"description": "Unique identifier for Document",
"example": "123456789",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"DocumentUpdateRequest": {
"properties": {
"documentId": {
"description": "Unique Identifier for Document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentType"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategory"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DocumentResponse": {
"properties": {
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "Terms Sheet",
"type": "string"
},
"documentCategory": {
"description": "Category of a document",
"example": "Entity",
"type": "string"
},
"documentStatus": {
"description": "Status of a document",
"example": "Approved",
"type": "string"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DocumentCreationRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
}
}
},
"DocumentUpdateRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentUpdateRequest"
}
}
}
},
"DocumentResponses": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
}
},
"FacilityTerm": {
"properties": {
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
}
}
},
"CreateDealSchema": {
"properties": {
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"facilityName": {
"description": "name of the facility",
"example": "Facility1234",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityType"
},
"facilityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/FacilityTerm"
}
]
},
"relatedPartiesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
},
"documentsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
},
"collateralsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"dealName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"dealStatus": {
"description": "status of a deal",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DealCreationResponse": {
"properties": {
"requestId": {
"description": "Request ID of the Deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "D487598",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "200722894",
"type": "string"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"status": {
"description": "Status of the deal",
"example": "Created",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"UpdateDealSchema": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"dealStatus": {
"description": "Status of the deal",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"dealName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DealUpdatedResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"dealStatus": {
"description": "Status of the deal",
"example": "Success",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"dealName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DealDetailsResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"dealStatus": {
"description": "Status of the deal",
"example": "Submitted",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"dealName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"AllDealDetailsResponse": {
"properties": {
"allDealsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
}
}
},
"NarrativesCreateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string",
"x-referencetype": "NarrativeCategories"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
}
}
},
"NarrativesUpdateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string",
"x-referencetype": "NarrativeCategories"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
}
}
},
"ProcessedNarrativesResponse": {
"properties": {
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"NarrativesResponse": {
"properties": {
"categoryId": {
"description": "ID of the category",
"example": "2",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
}
}
},
"NarrativesResponses": {
"properties": {
"Narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
}
}
},
"EnrichmentResponseItem": {
"properties": {
"value": {
"description": "Value of the reference record",
"type": "string"
},
"description": {
"type": "string"
}
}
},
"CollateralSubTypesItem": {
"properties": {
"collateralSubTypeId": {
"description": "Collateral Sub Type Id",
"example": "001",
"type": "string"
},
"collateralSubTypeValue": {
"description": "Collateral Sub Type Value",
"example": "Car",
"type": "string"
}
}
},
"CollateralTypesItem": {
"properties": {
"collateralTypeId": {
"description": "Collateral Type Id",
"example": "01",
"type": "string"
},
"collateralTypeValue": {
"description": "Collateral Type Value",
"example": "Vehicles",
"type": "string"
},
"collateralSubTypes": {
"description": "Collateral Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralSubTypesItem"
}
}
}
},
"IndustrialSubTypesItem": {
"properties": {
"industrialSubTypeId": {
"description": "industrial Sub Type Id",
"example": "001",
"type": "string"
},
"industrialSubTypeValue": {
"description": "Industrial Sub Type Value",
"example": "Car",
"type": "string"
}
}
},
"IndustrialTypesItem": {
"properties": {
"industrialTypeId": {
"description": "Industrial Type Id",
"example": "01",
"type": "string"
},
"industrialTypeValue": {
"description": "Industrial Type Value",
"example": "Vehicles",
"type": "string"
},
"industrialSubTypes": {
"description": "Industrial Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialSubTypesItem"
}
}
}
},
"FeeNamesItem": {
"properties": {
"feeNameId": {
"description": "Fee Name Id",
"example": "001",
"type": "string"
},
"feeNameValue": {
"description": "Fee Name Value",
"example": "Car",
"type": "string"
}
}
},
"FeeTypesItem": {
"properties": {
"feeTypesId": {
"description": "Fee Type Id",
"example": "01",
"type": "string"
},
"feeTypesValue": {
"description": "Fee Type Value",
"example": "Vehicles",
"type": "string"
},
"feeNames": {
"description": "Fee Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeNamesItem"
}
}
}
},
"ConditionNamesItem": {
"properties": {
"conditionNameId": {
"description": "Condition Name Id",
"example": "001",
"type": "string"
},
"conditionNameValue": {
"description": "Condition Name Value",
"example": "Car",
"type": "string"
}
}
},
"ConditionTypesItem": {
"properties": {
"conditionTypesId": {
"description": "Condition Type Id",
"example": "01",
"type": "string"
},
"conditionTypesValue": {
"description": "Condition Type Value",
"example": "Vehicles",
"type": "string"
},
"conditionNames": {
"description": "Condition Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionNamesItem"
}
}
}
},
"CovenantNamesItem": {
"properties": {
"covenantNameId": {
"description": "Covenant Name Id",
"example": "001",
"type": "string"
},
"covenantNameValue": {
"description": "Covenant Name Value",
"example": "Car",
"type": "string"
}
}
},
"CovenantTypesItem": {
"properties": {
"covenantTypesId": {
"description": "Covenant Type Id",
"example": "01",
"type": "string"
},
"covenantTypesValue": {
"description": "Covenant Type Value",
"example": "Vehicles",
"type": "string"
},
"covenantNames": {
"description": "Covenant Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantNamesItem"
}
}
}
},
"ComplianceNamesItem": {
"properties": {
"complianceNameId": {
"description": "Compliance Name Id",
"example": "001",
"type": "string"
},
"complianceNameValue": {
"description": "Compliance Name Value",
"example": "Car",
"type": "string"
}
}
},
"ComplianceTypesItem": {
"properties": {
"complianceTypesId": {
"description": "Compliance Type Id",
"example": "01",
"type": "string"
},
"complianceTypesValue": {
"description": "Compliance Type Value",
"example": "Vehicles",
"type": "string"
},
"complianceNames": {
"description": "Compliance Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceNamesItem"
}
}
}
},
"StateInfo": {
"properties": {
"stateCode": {
"description": "code of the state",
"example": "AK",
"type": "string"
},
"stateName": {
"description": "State name",
"example": "Alaska",
"type": "string"
}
}
},
"CountryInfo": {
"properties": {
"countryCode": {
"description": "Code of the country",
"example": "US",
"type": "string"
},
"countryUniCode": {
"description": "Uni code of the country",
"example": "+840",
"type": "string"
},
"countryName": {
"description": "Name of the country",
"example": "United States",
"type": "string"
},
"countryPhoneCode": {
"description": "Phone code of the country",
"example": "+840",
"type": "string"
},
"states": {
"description": "List of states",
"type": "array",
"items": {
"$ref": "#/components/schemas/StateInfo"
}
}
}
},
"TasksInfoItem": {
"properties": {
"taskId": {
"description": "Task Id",
"example": "01",
"type": "string"
},
"taskName": {
"description": "Task Name",
"example": "Borrower Info",
"type": "string"
},
"taskDescription": {
"description": "Task Description",
"example": "Borrower Info",
"type": "string"
},
"taskType": {
"description": "Task Type",
"example": "Manual",
"type": "string"
},
"defaultUserId": {
"description": "Default User Id",
"example": "1001",
"type": "string"
},
"ruleId": {
"description": "rule Id",
"example": "01",
"type": "string"
},
"taskPackage": {
"description": "task Package",
"example": "Fraud-check",
"type": "string"
},
"taskProvider": {
"description": "task Provider",
"example": "Borrower",
"type": "string"
},
"noOfDays": {
"description": "Task Lifetime for no of days",
"example": "5",
"type": "string"
},
"defaultUserEmail": {
"description": "Default User Email",
"example": "temenostestmail@gmail.com",
"type": "string"
},
"partyIndicator": {
"description": "Party Indicator",
"example": "00",
"type": "string"
}
}
},
"TasksCheckListItem": {
"properties": {
"taskCheckListId": {
"description": "Task Check List Id",
"example": "01",
"type": "string"
},
"taskCheckListName": {
"description": "Task Check List Name",
"example": "Fraud check",
"type": "string"
},
"tasksInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksInfoItem"
}
}
}
},
"TasksParamsItem": {
"properties": {
"taskStage": {
"description": "Task Stage",
"example": "Onboarding",
"type": "string"
},
"tasksCheckList": {
"description": "Task CheckList",
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"lastChangeUserId": {
"description": "Last Change User Id",
"example": "1001",
"type": "string"
}
}
},
"ReferenceDataItems": {
"properties": {
"documentType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"limitType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"relatedPartyRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"dealStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"operator": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"interestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"restrictionType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"payType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"addressType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"currency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"noOfEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"portfolio": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"profitCenter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPriority": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"salutation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"partyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"fundingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingInterestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeBalanceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"basisTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collectionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"policyExceptionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPackage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingIndex": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityPurpose": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"policyExceptionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"jobTitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskProvider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"acceptanceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"companyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"contactTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeFrequencyTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"riskRatingTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"narrativeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"beneficialOwnerDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rateTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralTypesItem"
}
},
"industryTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialTypesItem"
}
},
"conditionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionTypesItem"
}
},
"covenantTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantTypesItem"
}
},
"complianceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceTypesItem"
}
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryInfo"
}
},
"feeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeTypesItem"
}
},
"UITasksCheckList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
}
}
},
"BasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"legalName": {
"description": "legalName of the Customer",
"example": "ABC Company",
"type": "string"
},
"registrationNumber": {
"description": "registration number of the Customer",
"example": "ABC Company",
"type": "string"
},
"companyType": {
"description": "company type",
"example": "Community Interest Company (CIC)",
"type": "string",
"x-referencetype": "CompanyType"
},
"industryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"subIndustryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"registrationDate": {
"description": "date of registration",
"example": "Telecom",
"type": "string"
},
"yearsInBusiness": {
"description": "years in business",
"example": "5",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedAnnualRevenue": {
"description": "estimated annual revenue",
"example": "10000000",
"type": "string"
},
"noOfEmployees": {
"description": "no of employees",
"example": "01",
"type": "string",
"x-referencetype": "NoOfEmployees"
},
"websiteAddress": {
"description": "websire address",
"example": "www.abc.com",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"companyOverview": {
"description": "company overview",
"example": "Telecom company",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"jobTitle": {
"description": "jobTitle of the person",
"example": "MD",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phnNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddr": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
}
}
},
"IndividualBasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"dateOfBirth": {
"description": "dob of the person",
"example": "1978-06-03",
"type": "string"
},
"identificationNumber": {
"description": "id proof of the person",
"example": "9876095404361276",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddress": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
}
}
},
"FacilityInfo": {
"properties": {
"facilityId": {
"description": "unique identifier of the facility",
"example": "F20201234567",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "facility123",
"type": "string"
},
"purpose": {
"description": "purpose of the facility",
"example": "working capital",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "line of credit",
"type": "string"
},
"currency": {
"description": "Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "amount of the facility",
"example": "10000000",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
}
}
},
"RelatedPartyInfo": {
"properties": {
"Id": {
"description": "unique identifier",
"example": "12345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"partyName": {
"description": "name of the party",
"example": "abc",
"type": "string"
},
"role": {
"description": "role",
"example": "director",
"type": "string"
},
"limitType": {
"description": "amount or percentage of limit",
"example": "percentage",
"type": "string"
},
"limitCurrency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"limitValue": {
"description": "value",
"example": "10000000",
"type": "string"
}
}
},
"CollateralInfo": {
"properties": {
"collateralId": {
"description": "unique identifier of the collateral",
"example": "C202012345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"name": {
"description": "name of the collateral",
"example": "building",
"type": "string"
},
"type": {
"description": "type of the collateral",
"example": "01",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedValue": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
}
}
},
"DocumentInfo": {
"properties": {
"documentId": {
"description": "Id of the document",
"example": "123456",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"documentName": {
"description": "name of the document",
"example": "agreement",
"type": "string"
},
"documentType": {
"description": "type of the document",
"example": "02",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"uploadOn": {
"description": "date of upload",
"example": "2020-06-03",
"type": "string"
},
"category": {
"description": "category",
"example": "",
"type": "string"
}
}
},
"CustomerRequestInfo": {
"properties": {
"requestId": {
"description": "Id of the request",
"example": "654564",
"type": "string"
},
"userId": {
"description": "id of the user who created the request",
"example": "87654",
"type": "string"
},
"status": {
"description": "current step of submission process",
"example": "Draft",
"type": "string"
},
"screenFlag": {
"description": "Specifies screen of the request",
"example": "Facility",
"type": "string"
},
"summary": {
"description": "summary of the request being raised",
"example": "test summary",
"type": "string"
},
"requestDate": {
"description": "Date of the request being raised",
"example": "2020-06-03",
"type": "string"
},
"customerInformation": {
"allOf": [
{
"$ref": "#/components/schemas/BasicInfo"
}
]
},
"facilityItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityInfo"
}
},
"relatedPartyItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyInfo"
}
},
"newRelatedPartyIndividualItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndividualBasicInfo"
}
},
"newRelatedPartyBusinessItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicInfo"
}
},
"collateralItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"documentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentInfo"
}
}
}
},
"CustomerRequestsInfo": {
"properties": {
"customerRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"CreateCustomerProcessedResponse": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "TEMP-12345678",
"type": "string"
},
"customerPartyId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"facilityId": {
"description": "unique id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"individualPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"businessPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"collateralIds": {
"description": "unique id of the collaterals",
"example": "C202012345678",
"type": "string"
},
"documentIds": {
"description": "unique id of the documents",
"example": "D202012345678",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"DrawRestrictionsRequest": {
"properties": {
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "01",
"type": "string",
"x-referencetype": "RestrictionType"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"description": "Currency Id",
"example": "1001",
"type": "string"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012586",
"type": "string"
}
}
},
"ProcessedDrawRestrictionsResponse": {
"properties": {
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"DrawRestrictionResponse": {
"properties": {
"dealId": {
"description": "Unique Identifier of deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012566",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "Maximum Limit amount",
"type": "string"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"description": "Currency Id",
"example": "1001",
"type": "string"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
}
}
},
"DrawRestrictionResponses": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
}
}
},
"ComplianceRequest": {
"properties": {
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
}
}
},
"ComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceRequest"
}
}
}
},
"ComplianceResponse": {
"properties": {
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "123456789",
"type": "string"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
}
}
},
"ComplianceResponses": {
"properties": {
"Compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
}
}
},
"ProcessedComplianceResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"complianceId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"AddressDetails": {
"properties": {
"addressLine1": {
"description": "address Line1",
"example": "1-2-33/4/5, Baker Street",
"type": "string"
},
"addressLine2": {
"description": "address Line2",
"example": "Opp. White House",
"type": "string"
},
"city": {
"description": "city",
"example": "Los Angeles",
"type": "string"
},
"countryId": {
"description": "country id",
"example": "0",
"type": "string"
},
"state": {
"description": "state",
"example": "ca",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "10011",
"type": "string"
}
}
},
"FundingDetailsCreateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressType": {
"description": "Type of the address",
"example": "01",
"type": "string",
"x-referencetype": "AddressType"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
}
}
},
"FundingDetailsUpdateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"fundingId": {
"description": "ID of the funding created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressType": {
"description": "Type of the address",
"example": "01",
"type": "string",
"x-referencetype": "AddressType"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
}
}
},
"ProcessedFundingDetailsResponse": {
"properties": {
"fundingId": {
"type": "string",
"description": "Specifies the ID of the funding",
"example": "F123"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"FundingDetailsResponse": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"fundingId": {
"description": "ID of the funding created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "ABC",
"type": "string"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "ABC",
"type": "string"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "FUND1",
"type": "string"
},
"payType": {
"description": "How the payment was to be done",
"example": "Cheque",
"type": "string"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressType": {
"description": "Type of the address",
"example": "Office",
"type": "string"
},
"lastChangeUserid": {
"description": "ID of the lastchange user",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date and Time of the lastchange",
"example": "2020-09-05 10:08 08 800",
"type": "string",
"format": "date"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
}
}
},
"FundingDetailsResponses": {
"properties": {
"Funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
}
}
},
"LimitThings": {
"properties": {
"unadvisedLimit": {
"description": "Limit that unadvised",
"example": "$10000",
"type": "string"
},
"advisedLimit": {
"description": "Limit that advised",
"example": "$5000",
"type": "string"
},
"utilisedLimit": {
"description": "Already used limit",
"example": "$5000",
"type": "string"
},
"availableLimit": {
"description": "Limit that available",
"example": "$5000",
"type": "string"
},
"requestedAmount": {
"description": "Amount that requested",
"example": "$10000",
"type": "string"
}
}
},
"LimitsRequest": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": "Specifies the outstanding debt",
"example": "$5000",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
}
}
},
"LimitsResponse": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": " Specifies the outstanding debt",
"example": "$50000",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"previousLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"modifiedDate": {
"description": "The date modify the Limit",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Limit",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
}
}
},
"ProcessedLimitResponse": {
"properties": {
"limitId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"FeeTypeOnGoing": {
"properties": {
"balanceType": {
"description": "DD field,Visible only If Percentage is selected in Percentage/Amount",
"example": "01",
"type": "string",
"x-referencetype": "FeeBalanceTypes"
},
"frequency": {
"description": "Fee Frequency",
"example": "05",
"type": "string",
"x-referencetype": "FeeFrequencyTypes"
},
"rateBasis": {
"description": "DD field, Visible only If Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"rateType": {
"description": "Default to Fixed, Visible only if Percentage is selected in Percentage/Amount",
"example": "fixed",
"type": "string"
}
}
},
"FeeTypeEvent": {
"properties": {
"feeBasis": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
}
}
},
"FeeTypeClosing": {
"properties": {
"feeBasis": {
"description": "feeBasisId",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "percentage",
"example": "48",
"type": "string"
},
"collection": {
"description": "DD field, collection",
"example": "12345678",
"type": "string"
},
"status": {
"description": "DD field, status",
"example": "01",
"type": "string",
"x-referencetype": "FeeStatus"
}
}
},
"CreateFeeRequest": {
"properties": {
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
}
}
},
"UpdateFeeRequest": {
"properties": {
"feeId": {
"description": "unique id of the fee",
"example": "FEE202035269718",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
}
}
},
"FeeResponse": {
"properties": {
"feeId": {
"description": "Specifies id of the fees",
"example": "12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
}
}
},
"CreateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFeeRequest"
}
}
}
},
"UpdateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFeeRequest"
}
}
}
},
"FeesResponse": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
}
}
},
"ProcessedFeesResponse": {
"properties": {
"feesId": {
"description": "Unique identifier for fees",
"example": "FEE202035292905",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"StandardSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"FixedInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingInterestType"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "12345",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "",
"type": "string"
},
"rateLockDate": {
"description": "The rateLockDate",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "",
"type": "string"
},
"period": {
"description": "The period",
"example": "",
"type": "string"
}
}
},
"PeriodicInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingInterestType"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "12345",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "",
"type": "string"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "",
"type": "string"
},
"period": {
"description": "The period",
"example": "",
"type": "string"
},
"rateIndex": {
"description": "The rateIndex",
"example": "",
"type": "string"
},
"repricingFrequency": {
"description": "The repricingFrequency",
"example": "",
"type": "string"
},
"interestCap": {
"description": "The interestCap",
"example": "",
"type": "string"
},
"interestFloor": {
"description": "The interestFloor",
"example": "",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "",
"type": "string"
},
"roundingRule": {
"description": "The roundingRule",
"example": "",
"type": "string"
}
}
},
"FloatingInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingInterestType"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "12345",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "",
"type": "string"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "",
"type": "string"
},
"period": {
"description": "The period",
"example": "",
"type": "string"
},
"rateIndex": {
"description": "The rateIndex",
"example": "",
"type": "string"
},
"rateChangeMethod": {
"description": "The rateChangeMethod",
"example": "",
"type": "string"
},
"interestCap": {
"description": "The interestCap",
"example": "",
"type": "string"
},
"interestFloor": {
"description": "The interestFloor",
"example": "",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "",
"type": "string"
},
"roundingRule": {
"description": "The roundingRule",
"example": "Round_near",
"type": "string"
},
"capBasis": {
"description": "The capBasis",
"example": "",
"type": "string"
}
}
},
"PricingRequest": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"interestRateType": {
"description": "The type of interest",
"example": "01",
"type": "string",
"x-referencetype": "InterestType"
},
"fixedInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestRate"
}
]
},
"periodicInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/PeriodicInterestRate"
}
]
},
"floatingInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FloatingInterestRate"
}
]
},
"status": {
"description": "The status",
"example": "01",
"type": "string",
"x-referencetype": "PricingStatus"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
}
}
},
"PricingResponse": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"interestRateType": {
"description": "The type of interest",
"example": "Fixed",
"type": "string"
},
"fixedInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestRate"
}
]
},
"periodicInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/PeriodicInterestRate"
}
]
},
"floatingInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FloatingInterestRate"
}
]
},
"status": {
"description": "The status",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
}
}
},
"PricingRequests": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingRequest"
}
}
}
},
"PricingResponses": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
}
}
},
"ProcessedPricingResponse": {
"properties": {
"pricingId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"ProcessedCovenantsResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"covenantId": {
"description": "Unique identifier for covenant",
"example": "COV2345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"CovenantsRequest": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "C12345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string",
"x-referencetype": "CovenantType"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string",
"x-referencetype": "CovenantFrequency"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "CovenantStatus"
},
"operator": {
"description": "Operator of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "Operator"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "requirement",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CovenantsResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "COV202012345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string"
},
"operator": {
"description": "Operator of the Covenant",
"example": "==",
"type": "string"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CovenantsRequests": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsRequest"
}
}
}
},
"CovenantsResponses": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
}
}
},
"ConditionsInfo": {
"properties": {
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
}
}
},
"CreditDecisionInfo": {
"properties": {
"dealId": {
"description": "Unique identifier of the deal",
"example": "D202035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string",
"x-referencetype": "Decision"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
}
}
},
"CreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
}
}
},
"RequestOverViewResponse": {
"properties": {
"requestOverView": {
"allOf": [
{
"$ref": "#/components/schemas/DealDetailsResponse"
}
]
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"borrowerFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"checklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"AdjustmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"facilityName": {
"description": "Name of the facility",
"example": "ABC ltd",
"type": "string"
},
"adjustedAmount": {
"description": "Adjusted Amount",
"example": "2 million",
"type": "string"
},
"adjustedCurrency": {
"description": "Adjusted Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedComment": {
"description": "adjusted comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
}
}
},
"ExternalCommitmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"lenderName": {
"description": "Name of the lender",
"example": "Jhon",
"type": "string"
},
"commitmentAmount": {
"description": "commitment Amount",
"example": "2 million",
"type": "string"
},
"maturitydate": {
"description": "maturity Date",
"example": "2020-06-03",
"type": "string"
}
}
},
"ExposureCommentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"comment": {
"description": "comment",
"example": "this exposure is pending",
"type": "string"
}
}
},
"ExposureInfo": {
"properties": {
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"exposureUniqueId": {
"description": "Unique identifier of the Exposure",
"example": "P202035292905",
"type": "string"
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsInfo"
}
},
"externalCommitments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalCommitmentsInfo"
}
},
"exposureComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureCommentsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"exposureDate": {
"description": "Exposure Date",
"example": "2020-06-03",
"type": "string"
},
"exposureTime": {
"description": "Exposure Time",
"example": "02:22",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
}
}
},
"ExposureList": {
"properties": {
"exposureItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
}
}
},
"FacilityOverViewResponse": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"fees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"drawRestriction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
},
"compliance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"TasksParamsReferenceDataItems": {
"properties": {
"tasksParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksParamsItem"
}
},
"tasksInfo": {
"$ref": "#/components/schemas/TasksInfoItem"
}
}
},
"EntityOverViewResponse": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"Exposures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
}
}
},
"MessageList": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
}
}
},
"MessagesList": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageList"
}
}
}
},
"CreateMessagesResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"GetMessageResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"userId": {
"description": "user Id",
"example": "12345",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"lastChangeDateTime": {
"description": "read flag",
"example": "true",
"type": "string",
"format": "date"
}
}
},
"GetMessagesResponse": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetMessageResponse"
}
}
}
}
}
}
}
,
dom_id: "#swagger-ui",
presets: [
SwaggerUIBundle.presets.apis,
]
})
</script>
|
|
<html>
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui.css" />
<div id="swagger-ui1"> </div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-bundle.js" type="text/javascript">
</script>
<script type="text/javascript">
const ui1 = SwaggerUIBundle({
spec:
{
"openapi": "3.0.0",
"servers": [
{
"description": "Locally Deployed Environment",
"url": "http://localhost:8600/ms-corporatelos-api/api/v1.0.0"
}
],
"info": {
"title": "Corporate LOS API",
"description": "This API enables you to programmatically access all data related to Corporate LOS that users has granted access.",
"version": "1.0.0",
"contact": {
"email": "mprasadambati@temenos.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/origination/corporate/deals": {
"post": {
"summary": "Creates a new Corporate Deal",
"description": "Creates new Corporate Deal record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "createCorporateDealV1",
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Creation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreationResponse"
}
}
}
},
"400": {
"description": "Deal Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the corporate deal record",
"description": "Retrieves corporate deal record based on the Deal Id, Deal Name, User Id.",
"operationId": "getCorporateDealsV1",
"tags": [
"Deal"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dealName",
"in": "query",
"description": "Deal Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "All Deal Details Retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllDealDetailsResponse"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}": {
"put": {
"summary": "Updates an existing Corporate Deal",
"description": "Update Corporate Deal record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "updateCorporateDealV1",
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Deal"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealUpdatedResponse"
}
}
}
},
"400": {
"description": "Deal Update Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/facilities": {
"post": {
"summary": "Creates new facilities for a Deal",
"description": "Create Facility record with the provided data such as dealId, facilityType and partyId etc.",
"operationId": "createFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates already existing facilities for a Deal",
"description": "Update Facility record with the provided data such as dealId, facilityType and partyId etc.",
"operationId": "updateFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility": {
"get": {
"summary": "Retrieves the Facility record",
"description": "Retrieves the Facility record based on the Deal Id, Facility Id, Party Id and Facility Name .",
"operationId": "getFacilityV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityName",
"in": "query",
"description": "Facility Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Facility"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties": {
"post": {
"summary": "Create a relationship to the given Party id with the facility owner",
"description": "Create RelatedPartie record with the provided data such as dealId, facilityType and partyId etc.",
"operationId": "createRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the relationship to the given party id with the facilty owner",
"description": "Update RelatedPartie record with the provided data such as dealId, facilityId and partyId etc.",
"operationId": "updateRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the relatedParty record",
"description": "Retrieves the relatedParty record based on facilityId, relatedPartyId, partyId and dealId.",
"operationId": "getRelatedPartiesV1",
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatedPartyId",
"in": "query",
"description": "Related Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks/{indicator}": {
"post": {
"summary": "Creates tasks for a Deal",
"description": "Create Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "createTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "indicator",
"in": "path",
"description": "indicator",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks": {
"put": {
"summary": "Updates the Task record",
"description": "Update Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "updateTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks": {
"get": {
"summary": "Retrieves the details of tasks for the provided criteria",
"description": "Retrieves Task record based on dealId, partyId and Facility Id etc.",
"operationId": "getTasksV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "assignUserId",
"in": "query",
"description": "Assigned User Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "task status",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"in": "query",
"description": "task stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals": {
"post": {
"tags": [
"Collateral"
],
"summary": "Add a new collateral to the Deal",
"description": "Create collateral record with the provided data such as dealId, facilityId and collateral type etc.",
"operationId": "createCollateralV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "ID of deal for the request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of facility for the request",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Collateral"
],
"summary": "Update the collateral associated to the Deal",
"description": "Update collateral record with the provided data such as dealId, facilityId and collateral type etc.",
"operationId": "updateCollateralV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "ID of deal for the request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of facility for the request",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Collateral"
],
"summary": "Fetch the collaterals associated to the Deal/Facility/Party/Collateral",
"description": "Retrieves the collateral records based on dealId, facilityId, partyId and collateralId.",
"operationId": "getCollateralV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "DealId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "PartyId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents": {
"post": {
"summary": "creates new documents and adds them to deal",
"description": "Create document records with the provided data such as dealId, facilityId and document name etc.",
"operationId": "createDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCreationRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "updates the existing documents data",
"description": "Update document records with the provided data such as dealId, facilityId and document name etc.",
"operationId": "updateDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of documents for the provided criteria",
"description": "Retrieve the document records based on dealId, facilityId and partyId.",
"operationId": "getDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives": {
"post": {
"summary": "Create narrative and add to deal",
"description": "Create narrative records with the provided data such as dealId, facilityId , partyId and categoryId etc.",
"operationId": "createNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update narrative",
"description": "Update narrative records with the provided data such as dealId, facilityId, partyId and categoryId etc.",
"operationId": "updateNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Narrative records",
"description": "Retrieves the Narrative records based on dealId, facilityId and partyId.",
"operationId": "getNarrativesV1",
"tags": [
"Narratives"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/reference/{referenceId}": {
"get": {
"summary": "gets the reference data from reference tables",
"description": "Retrieves the reference data based on the referenceId.",
"operationId": "getRefData",
"tags": [
"Reference Data"
],
"parameters": [
{
"name": "referenceId",
"in": "path",
"description": "Reference Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerRequest": {
"post": {
"summary": "Stores the captured information of the request submission form",
"description": "Create customerRequest records with the provided data such as userId, requestId and customerInformation etc.",
"operationId": "createCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get all the information associated to the userid and requestid",
"description": "Retrieves customerRequest records based on userId, requestId and status.",
"operationId": "getCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "status",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestsInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions": {
"post": {
"summary": "Creates draw restrictions for a particular deal",
"description": "Create drawRestriction records with the provided data such as dealId, facilityId and restrictionType etc.",
"operationId": "createDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Draw restrictions against a deal",
"description": "Update drawRestriction records with the provided data such as dealId, facilityId and restrictionType etc.",
"operationId": "updateDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of draw restrictions against deal or facility",
"description": "Retrieves drawRestriction records based on dealId, facilityId.",
"operationId": "getDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance": {
"get": {
"summary": "Retrieves the details of the compliance for the provided criteria",
"description": "Retrieves the compliance records based on dealId, facilityId and complianceId.",
"operationId": "getComplianceV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "complianceId",
"in": "query",
"description": "complaince Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Compliance"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Compliance"
],
"summary": "Add a new compliance to the Deal",
"description": "Create the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "createComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails": {
"post": {
"summary": "Create funding details",
"description": "Create the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "createFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update fundings Details",
"description": "Update the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "updateFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Funding details",
"description": "Retrieves the funding records based on dealId, facilityId and fundingId.",
"operationId": "getFundingDetailsV1",
"tags": [
"Funding"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fundingId",
"in": "query",
"description": "Funding Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits": {
"post": {
"summary": "Create limit records",
"description": "Create the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "createLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Limit details to the given limit id",
"description": "Update the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "updateLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieve the Limit record",
"description": "Retrieve the Limit record based on limitId.",
"operationId": "getLimitsV1",
"tags": [
"Limits"
],
"parameters": [
{
"name": "limitId",
"in": "query",
"description": "limit Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees": {
"post": {
"summary": "create Fee details to the given facility/deal",
"description": "Create the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "createFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Fee details to the given id",
"description": "Update the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "updateFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Fee details to the given facility id/deal id",
"description": "Retrieve the Fee records based on dealId, facilityId, feeType.",
"operationId": "getFeesV1",
"tags": [
"Fees"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings": {
"post": {
"summary": "create Pricing details to the given deal/facility",
"description": "Create the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "createPricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Pricing details to the given Pricing id",
"description": "Update the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "updatePricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Pricing details to the given facility id",
"description": "Retrieve the Pricing records based on dealId, facilityId.",
"operationId": "getPricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "deal Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants": {
"post": {
"summary": "Creates covenants for a Deal",
"description": "Create the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "createCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Covenants for a Deal",
"description": "Update the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the details of covenants for the provided criteria",
"description": "Retrieve the Covenant records based on dealId, facilityId, partyId and covenantId.",
"operationId": "getCovenantsV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "covenantId",
"in": "query",
"description": "covenant Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/{facilityId}/creditDecisions": {
"post": {
"summary": "create credit decisions to the given facility",
"description": "Create the creditDecision records with the provided data such as dealId, facilityId and decisionDate etc.",
"operationId": "createCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions": {
"get": {
"summary": "get the credit decisions to the given facility",
"description": "Retrieve the creditDecision records based on facilityId and decisionId.",
"operationId": "getCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "decisionId",
"in": "query",
"description": "decision Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}": {
"get": {
"summary": "Retrieves the requestOverview details",
"description": "Retrieves the requestOverview details based on requestId.",
"operationId": "getRequestOverviewV1",
"tags": [
"RequestOverView"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure": {
"post": {
"summary": "Create Exposure records",
"description": "Create the Exposure records with the provided data such as partyId, exposureType and exposureUniqueId etc.",
"operationId": "createExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureType",
"in": "query",
"description": "exposureType",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given party",
"description": "Retrieve the exposure records based on partyId and exposureUniqueId.",
"operationId": "getExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/{facilityId}": {
"get": {
"summary": "Retrieves FacilityOverview details",
"description": "Retrieves FacilityOverview details based on facilityId.",
"operationId": "getFacilityOverviewV1",
"tags": [
"FacilityOverview"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasksparams": {
"get": {
"summary": "Retrieves the data related to tasks params",
"description": "Retrieves the task records based on taskStage and taskId.",
"operationId": "getTasksParamsV1",
"tags": [
"TasksParams"
],
"parameters": [
{
"name": "taskStage",
"in": "query",
"description": "Task Stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task ID",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksParamsReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/{partyId}": {
"get": {
"summary": "Retrieves PartyOverview details",
"description": "Retrieves PartyOverview details based on partyId.",
"operationId": "getEntityOverviewV1",
"tags": [
"EntityOverview"
],
"parameters": [
{
"name": "partyId",
"in": "path",
"description": "party Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message/{userId}": {
"post": {
"summary": "creates the messages to the dealId",
"description": "Create the messages records with the provided data such as userId, dealId and messagedescription etc.",
"operationId": "createMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessagesList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message": {
"get": {
"summary": "Retrieve the message records",
"description": "Retrieve the message records based on userId and messageId.",
"operationId": "getMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "messageId",
"in": "query",
"description": "message Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"FailureMessage": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"StandardErrorResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailureMessage"
}
},
"ProcessedFacilityResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"FacilityCreateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityType"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"FacilityUpdateRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "03",
"type": "string",
"x-referencetype": "FacilityType"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "01",
"type": "string",
"x-referencetype": "AcceptanceStatus"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"FacilityResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "Line of Credit",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "Working Capital",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "Awaiting Approval",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "Approved",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"FacilityCreateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
}
}
},
"FacilityUpdateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityUpdateRequest"
}
}
}
},
"FacilityResponses": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"RelatedPartiesSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"CreateRelatedPartiesRequest": {
"properties": {
"dealId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"UpdateRelatedPartiesRequest": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "D202012345678",
"type": "string"
},
"dealId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"RelatedPartiesResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "12345678",
"type": "string"
},
"dealId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "Guarantor",
"type": "string"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "Amount",
"type": "string"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CreateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
}
}
},
"UpdateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequest"
}
}
}
},
"RelatedPartiesResponses": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
}
}
},
"ProcessedTasksResponse": {
"properties": {
"taskId": {
"description": "Unique identifier for Task",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"NoteItem": {
"properties": {
"noteDescription": {
"description": "description notes",
"example": "task notes",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
}
}
},
"TasksRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskProvider"
},
"taskPackage": {
"description": "Package of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPackage"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskCategory"
},
"taskType": {
"description": "Type of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskType"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPriority"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"TasksResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "Moody's",
"type": "string"
},
"taskPackage": {
"description": "Package of the task",
"example": "Fraud-Check",
"type": "string"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "Prescreening",
"type": "string"
},
"taskType": {
"description": "Type of the task",
"example": "Auto",
"type": "string"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "In-Process",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "medium",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"TasksRequests": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksRequest"
}
}
}
},
"TasksResponses": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"CollateralRequest": {
"properties": {
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P129343",
"type": "string"
},
"collateralType": {
"description": "Type of the Collateral",
"example": "Personal property",
"type": "string"
},
"collateralSubType": {
"description": "Subtype of the Collateral",
"example": "sub property",
"type": "string"
},
"collateralName": {
"description": "Name of the Collateral",
"example": "Assert",
"type": "string"
},
"collateralMarketValue": {
"description": "Market value of the Collateral",
"example": "1000000",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of the Collateral",
"example": "1:2",
"type": "string"
},
"collateralStatus": {
"description": "Status of the Collateral",
"example": "inProgress",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral",
"example": "1001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CollateralResponse": {
"properties": {
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F200722894",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P129343",
"type": "string"
},
"collateralType": {
"description": "Type of the Collateral",
"example": "property",
"type": "string"
},
"collateralSubType": {
"description": "Subtype of the Collateral",
"example": "subproperty",
"type": "string"
},
"collateralName": {
"description": "Name of the Collateral",
"example": "Assert",
"type": "string"
},
"collateralMarketValue": {
"description": "Market value of the Collateral",
"example": "1000000",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of the Colateral",
"example": "1:2",
"type": "string"
},
"collateralStatus": {
"description": "Status of the Collateral",
"example": "inProgress",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral",
"example": "1001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the collateral was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CollateralRequests": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
}
}
},
"CollateralResponses": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
}
}
},
"ProcessedCollateralResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202035269718",
"type": "string"
},
"collateralId": {
"description": "Unique identifier for Collateral",
"example": "C202035292905",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"DocumentCreationRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentType"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategory"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"ProcessedDocumentsResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D2020123456",
"type": "string"
},
"documentId": {
"description": "Unique identifier for Document",
"example": "123456789",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"DocumentUpdateRequest": {
"properties": {
"documentId": {
"description": "Unique Identifier for Document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentType"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategory"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DocumentResponse": {
"properties": {
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "Terms Sheet",
"type": "string"
},
"documentCategory": {
"description": "Category of a document",
"example": "Entity",
"type": "string"
},
"documentStatus": {
"description": "Status of a document",
"example": "Approved",
"type": "string"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DocumentCreationRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
}
}
},
"DocumentUpdateRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentUpdateRequest"
}
}
}
},
"DocumentResponses": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
}
},
"FacilityTerm": {
"properties": {
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
}
}
},
"CreateDealSchema": {
"properties": {
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"facilityName": {
"description": "name of the facility",
"example": "Facility1234",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityType"
},
"facilityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/FacilityTerm"
}
]
},
"relatedPartiesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
},
"documentsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
},
"collateralsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"dealName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"dealStatus": {
"description": "status of a deal",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DealCreationResponse": {
"properties": {
"requestId": {
"description": "Request ID of the Deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "D487598",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "200722894",
"type": "string"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"status": {
"description": "Status of the deal",
"example": "Created",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"UpdateDealSchema": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"dealStatus": {
"description": "Status of the deal",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"dealName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DealUpdatedResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"dealStatus": {
"description": "Status of the deal",
"example": "Success",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"dealName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"DealDetailsResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"dealStatus": {
"description": "Status of the deal",
"example": "Submitted",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"dealName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"AllDealDetailsResponse": {
"properties": {
"allDealsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
}
}
},
"NarrativesCreateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string",
"x-referencetype": "NarrativeCategories"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
}
}
},
"NarrativesUpdateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string",
"x-referencetype": "NarrativeCategories"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
}
}
},
"ProcessedNarrativesResponse": {
"properties": {
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"NarrativesResponse": {
"properties": {
"categoryId": {
"description": "ID of the category",
"example": "2",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
}
}
},
"NarrativesResponses": {
"properties": {
"Narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
}
}
},
"EnrichmentResponseItem": {
"properties": {
"value": {
"description": "Value of the reference record",
"type": "string"
},
"description": {
"type": "string"
}
}
},
"CollateralSubTypesItem": {
"properties": {
"collateralSubTypeId": {
"description": "Collateral Sub Type Id",
"example": "001",
"type": "string"
},
"collateralSubTypeValue": {
"description": "Collateral Sub Type Value",
"example": "Car",
"type": "string"
}
}
},
"CollateralTypesItem": {
"properties": {
"collateralTypeId": {
"description": "Collateral Type Id",
"example": "01",
"type": "string"
},
"collateralTypeValue": {
"description": "Collateral Type Value",
"example": "Vehicles",
"type": "string"
},
"collateralSubTypes": {
"description": "Collateral Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralSubTypesItem"
}
}
}
},
"IndustrialSubTypesItem": {
"properties": {
"industrialSubTypeId": {
"description": "industrial Sub Type Id",
"example": "001",
"type": "string"
},
"industrialSubTypeValue": {
"description": "Industrial Sub Type Value",
"example": "Car",
"type": "string"
}
}
},
"IndustrialTypesItem": {
"properties": {
"industrialTypeId": {
"description": "Industrial Type Id",
"example": "01",
"type": "string"
},
"industrialTypeValue": {
"description": "Industrial Type Value",
"example": "Vehicles",
"type": "string"
},
"industrialSubTypes": {
"description": "Industrial Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialSubTypesItem"
}
}
}
},
"FeeNamesItem": {
"properties": {
"feeNameId": {
"description": "Fee Name Id",
"example": "001",
"type": "string"
},
"feeNameValue": {
"description": "Fee Name Value",
"example": "Car",
"type": "string"
}
}
},
"FeeTypesItem": {
"properties": {
"feeTypesId": {
"description": "Fee Type Id",
"example": "01",
"type": "string"
},
"feeTypesValue": {
"description": "Fee Type Value",
"example": "Vehicles",
"type": "string"
},
"feeNames": {
"description": "Fee Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeNamesItem"
}
}
}
},
"ConditionNamesItem": {
"properties": {
"conditionNameId": {
"description": "Condition Name Id",
"example": "001",
"type": "string"
},
"conditionNameValue": {
"description": "Condition Name Value",
"example": "Car",
"type": "string"
}
}
},
"ConditionTypesItem": {
"properties": {
"conditionTypesId": {
"description": "Condition Type Id",
"example": "01",
"type": "string"
},
"conditionTypesValue": {
"description": "Condition Type Value",
"example": "Vehicles",
"type": "string"
},
"conditionNames": {
"description": "Condition Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionNamesItem"
}
}
}
},
"CovenantNamesItem": {
"properties": {
"covenantNameId": {
"description": "Covenant Name Id",
"example": "001",
"type": "string"
},
"covenantNameValue": {
"description": "Covenant Name Value",
"example": "Car",
"type": "string"
}
}
},
"CovenantTypesItem": {
"properties": {
"covenantTypesId": {
"description": "Covenant Type Id",
"example": "01",
"type": "string"
},
"covenantTypesValue": {
"description": "Covenant Type Value",
"example": "Vehicles",
"type": "string"
},
"covenantNames": {
"description": "Covenant Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantNamesItem"
}
}
}
},
"ComplianceNamesItem": {
"properties": {
"complianceNameId": {
"description": "Compliance Name Id",
"example": "001",
"type": "string"
},
"complianceNameValue": {
"description": "Compliance Name Value",
"example": "Car",
"type": "string"
}
}
},
"ComplianceTypesItem": {
"properties": {
"complianceTypesId": {
"description": "Compliance Type Id",
"example": "01",
"type": "string"
},
"complianceTypesValue": {
"description": "Compliance Type Value",
"example": "Vehicles",
"type": "string"
},
"complianceNames": {
"description": "Compliance Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceNamesItem"
}
}
}
},
"StateInfo": {
"properties": {
"stateCode": {
"description": "code of the state",
"example": "AK",
"type": "string"
},
"stateName": {
"description": "State name",
"example": "Alaska",
"type": "string"
}
}
},
"CountryInfo": {
"properties": {
"countryCode": {
"description": "Code of the country",
"example": "US",
"type": "string"
},
"countryUniCode": {
"description": "Uni code of the country",
"example": "+840",
"type": "string"
},
"countryName": {
"description": "Name of the country",
"example": "United States",
"type": "string"
},
"countryPhoneCode": {
"description": "Phone code of the country",
"example": "+840",
"type": "string"
},
"states": {
"description": "List of states",
"type": "array",
"items": {
"$ref": "#/components/schemas/StateInfo"
}
}
}
},
"TasksInfoItem": {
"properties": {
"taskId": {
"description": "Task Id",
"example": "01",
"type": "string"
},
"taskName": {
"description": "Task Name",
"example": "Borrower Info",
"type": "string"
},
"taskDescription": {
"description": "Task Description",
"example": "Borrower Info",
"type": "string"
},
"taskType": {
"description": "Task Type",
"example": "Manual",
"type": "string"
},
"defaultUserId": {
"description": "Default User Id",
"example": "1001",
"type": "string"
},
"ruleId": {
"description": "rule Id",
"example": "01",
"type": "string"
},
"taskPackage": {
"description": "task Package",
"example": "Fraud-check",
"type": "string"
},
"taskProvider": {
"description": "task Provider",
"example": "Borrower",
"type": "string"
},
"noOfDays": {
"description": "Task Lifetime for no of days",
"example": "5",
"type": "string"
},
"defaultUserEmail": {
"description": "Default User Email",
"example": "temenostestmail@gmail.com",
"type": "string"
},
"partyIndicator": {
"description": "Party Indicator",
"example": "00",
"type": "string"
}
}
},
"TasksCheckListItem": {
"properties": {
"taskCheckListId": {
"description": "Task Check List Id",
"example": "01",
"type": "string"
},
"taskCheckListName": {
"description": "Task Check List Name",
"example": "Fraud check",
"type": "string"
},
"tasksInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksInfoItem"
}
}
}
},
"TasksParamsItem": {
"properties": {
"taskStage": {
"description": "Task Stage",
"example": "Onboarding",
"type": "string"
},
"tasksCheckList": {
"description": "Task CheckList",
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"lastChangeUserId": {
"description": "Last Change User Id",
"example": "1001",
"type": "string"
}
}
},
"ReferenceDataItems": {
"properties": {
"documentType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"limitType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"relatedPartyRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"dealStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"operator": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"interestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"restrictionType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"payType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"addressType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"currency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"noOfEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"portfolio": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"profitCenter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPriority": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"salutation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"partyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"fundingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingInterestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeBalanceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"basisTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collectionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"policyExceptionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPackage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingIndex": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityPurpose": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"policyExceptionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"jobTitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskProvider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"acceptanceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"companyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"contactTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeFrequencyTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"riskRatingTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"narrativeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"beneficialOwnerDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rateTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralTypesItem"
}
},
"industryTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialTypesItem"
}
},
"conditionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionTypesItem"
}
},
"covenantTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantTypesItem"
}
},
"complianceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceTypesItem"
}
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryInfo"
}
},
"feeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeTypesItem"
}
},
"UITasksCheckList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
}
}
},
"BasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"legalName": {
"description": "legalName of the Customer",
"example": "ABC Company",
"type": "string"
},
"registrationNumber": {
"description": "registration number of the Customer",
"example": "ABC Company",
"type": "string"
},
"companyType": {
"description": "company type",
"example": "Community Interest Company (CIC)",
"type": "string",
"x-referencetype": "CompanyType"
},
"industryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"subIndustryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"registrationDate": {
"description": "date of registration",
"example": "Telecom",
"type": "string"
},
"yearsInBusiness": {
"description": "years in business",
"example": "5",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedAnnualRevenue": {
"description": "estimated annual revenue",
"example": "10000000",
"type": "string"
},
"noOfEmployees": {
"description": "no of employees",
"example": "01",
"type": "string",
"x-referencetype": "NoOfEmployees"
},
"websiteAddress": {
"description": "websire address",
"example": "www.abc.com",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"companyOverview": {
"description": "company overview",
"example": "Telecom company",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"jobTitle": {
"description": "jobTitle of the person",
"example": "MD",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phnNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddr": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
}
}
},
"IndividualBasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"dateOfBirth": {
"description": "dob of the person",
"example": "1978-06-03",
"type": "string"
},
"identificationNumber": {
"description": "id proof of the person",
"example": "9876095404361276",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddress": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
}
}
},
"FacilityInfo": {
"properties": {
"facilityId": {
"description": "unique identifier of the facility",
"example": "F20201234567",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "facility123",
"type": "string"
},
"purpose": {
"description": "purpose of the facility",
"example": "working capital",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "line of credit",
"type": "string"
},
"currency": {
"description": "Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "amount of the facility",
"example": "10000000",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
}
}
},
"RelatedPartyInfo": {
"properties": {
"Id": {
"description": "unique identifier",
"example": "12345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"partyName": {
"description": "name of the party",
"example": "abc",
"type": "string"
},
"role": {
"description": "role",
"example": "director",
"type": "string"
},
"limitType": {
"description": "amount or percentage of limit",
"example": "percentage",
"type": "string"
},
"limitCurrency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"limitValue": {
"description": "value",
"example": "10000000",
"type": "string"
}
}
},
"CollateralInfo": {
"properties": {
"collateralId": {
"description": "unique identifier of the collateral",
"example": "C202012345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"name": {
"description": "name of the collateral",
"example": "building",
"type": "string"
},
"type": {
"description": "type of the collateral",
"example": "01",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedValue": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
}
}
},
"DocumentInfo": {
"properties": {
"documentId": {
"description": "Id of the document",
"example": "123456",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"documentName": {
"description": "name of the document",
"example": "agreement",
"type": "string"
},
"documentType": {
"description": "type of the document",
"example": "02",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"uploadOn": {
"description": "date of upload",
"example": "2020-06-03",
"type": "string"
},
"category": {
"description": "category",
"example": "",
"type": "string"
}
}
},
"CustomerRequestInfo": {
"properties": {
"requestId": {
"description": "Id of the request",
"example": "654564",
"type": "string"
},
"userId": {
"description": "id of the user who created the request",
"example": "87654",
"type": "string"
},
"status": {
"description": "current step of submission process",
"example": "Draft",
"type": "string"
},
"screenFlag": {
"description": "Specifies screen of the request",
"example": "Facility",
"type": "string"
},
"summary": {
"description": "summary of the request being raised",
"example": "test summary",
"type": "string"
},
"requestDate": {
"description": "Date of the request being raised",
"example": "2020-06-03",
"type": "string"
},
"customerInformation": {
"allOf": [
{
"$ref": "#/components/schemas/BasicInfo"
}
]
},
"facilityItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityInfo"
}
},
"relatedPartyItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyInfo"
}
},
"newRelatedPartyIndividualItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndividualBasicInfo"
}
},
"newRelatedPartyBusinessItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicInfo"
}
},
"collateralItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"documentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentInfo"
}
}
}
},
"CustomerRequestsInfo": {
"properties": {
"customerRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"CreateCustomerProcessedResponse": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "TEMP-12345678",
"type": "string"
},
"customerPartyId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"facilityId": {
"description": "unique id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"individualPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"businessPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"collateralIds": {
"description": "unique id of the collaterals",
"example": "C202012345678",
"type": "string"
},
"documentIds": {
"description": "unique id of the documents",
"example": "D202012345678",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"DrawRestrictionsRequest": {
"properties": {
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "01",
"type": "string",
"x-referencetype": "RestrictionType"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"description": "Currency Id",
"example": "1001",
"type": "string"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012586",
"type": "string"
}
}
},
"ProcessedDrawRestrictionsResponse": {
"properties": {
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"DrawRestrictionResponse": {
"properties": {
"dealId": {
"description": "Unique Identifier of deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012566",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "Maximum Limit amount",
"type": "string"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"description": "Currency Id",
"example": "1001",
"type": "string"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
}
}
},
"DrawRestrictionResponses": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
}
}
},
"ComplianceRequest": {
"properties": {
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
}
}
},
"ComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceRequest"
}
}
}
},
"ComplianceResponse": {
"properties": {
"dealId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "123456789",
"type": "string"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
}
}
},
"ComplianceResponses": {
"properties": {
"Compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
}
}
},
"ProcessedComplianceResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"complianceId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"AddressDetails": {
"properties": {
"addressLine1": {
"description": "address Line1",
"example": "1-2-33/4/5, Baker Street",
"type": "string"
},
"addressLine2": {
"description": "address Line2",
"example": "Opp. White House",
"type": "string"
},
"city": {
"description": "city",
"example": "Los Angeles",
"type": "string"
},
"countryId": {
"description": "country id",
"example": "0",
"type": "string"
},
"state": {
"description": "state",
"example": "ca",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "10011",
"type": "string"
}
}
},
"FundingDetailsCreateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressType": {
"description": "Type of the address",
"example": "01",
"type": "string",
"x-referencetype": "AddressType"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
}
}
},
"FundingDetailsUpdateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"fundingId": {
"description": "ID of the funding created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressType": {
"description": "Type of the address",
"example": "01",
"type": "string",
"x-referencetype": "AddressType"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
}
}
},
"ProcessedFundingDetailsResponse": {
"properties": {
"fundingId": {
"type": "string",
"description": "Specifies the ID of the funding",
"example": "F123"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"FundingDetailsResponse": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"fundingId": {
"description": "ID of the funding created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "ABC",
"type": "string"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "ABC",
"type": "string"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "FUND1",
"type": "string"
},
"payType": {
"description": "How the payment was to be done",
"example": "Cheque",
"type": "string"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressType": {
"description": "Type of the address",
"example": "Office",
"type": "string"
},
"lastChangeUserid": {
"description": "ID of the lastchange user",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date and Time of the lastchange",
"example": "2020-09-05 10:08 08 800",
"type": "string",
"format": "date"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
}
}
},
"FundingDetailsResponses": {
"properties": {
"Funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
}
}
},
"LimitThings": {
"properties": {
"unadvisedLimit": {
"description": "Limit that unadvised",
"example": "$10000",
"type": "string"
},
"advisedLimit": {
"description": "Limit that advised",
"example": "$5000",
"type": "string"
},
"utilisedLimit": {
"description": "Already used limit",
"example": "$5000",
"type": "string"
},
"availableLimit": {
"description": "Limit that available",
"example": "$5000",
"type": "string"
},
"requestedAmount": {
"description": "Amount that requested",
"example": "$10000",
"type": "string"
}
}
},
"LimitsRequest": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": "Specifies the outstanding debt",
"example": "$5000",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
}
}
},
"LimitsResponse": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": " Specifies the outstanding debt",
"example": "$50000",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"previousLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"modifiedDate": {
"description": "The date modify the Limit",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Limit",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
}
}
},
"ProcessedLimitResponse": {
"properties": {
"limitId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"FeeTypeOnGoing": {
"properties": {
"balanceType": {
"description": "DD field,Visible only If Percentage is selected in Percentage/Amount",
"example": "01",
"type": "string",
"x-referencetype": "FeeBalanceTypes"
},
"frequency": {
"description": "Fee Frequency",
"example": "05",
"type": "string",
"x-referencetype": "FeeFrequencyTypes"
},
"rateBasis": {
"description": "DD field, Visible only If Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"rateType": {
"description": "Default to Fixed, Visible only if Percentage is selected in Percentage/Amount",
"example": "fixed",
"type": "string"
}
}
},
"FeeTypeEvent": {
"properties": {
"feeBasis": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
}
}
},
"FeeTypeClosing": {
"properties": {
"feeBasis": {
"description": "feeBasisId",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "percentage",
"example": "48",
"type": "string"
},
"collection": {
"description": "DD field, collection",
"example": "12345678",
"type": "string"
},
"status": {
"description": "DD field, status",
"example": "01",
"type": "string",
"x-referencetype": "FeeStatus"
}
}
},
"CreateFeeRequest": {
"properties": {
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
}
}
},
"UpdateFeeRequest": {
"properties": {
"feeId": {
"description": "unique id of the fee",
"example": "FEE202035269718",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
}
}
},
"FeeResponse": {
"properties": {
"feeId": {
"description": "Specifies id of the fees",
"example": "12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
}
}
},
"CreateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFeeRequest"
}
}
}
},
"UpdateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFeeRequest"
}
}
}
},
"FeesResponse": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
}
}
},
"ProcessedFeesResponse": {
"properties": {
"feesId": {
"description": "Unique identifier for fees",
"example": "FEE202035292905",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"StandardSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"FixedInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingInterestType"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "12345",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "",
"type": "string"
},
"rateLockDate": {
"description": "The rateLockDate",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "",
"type": "string"
},
"period": {
"description": "The period",
"example": "",
"type": "string"
}
}
},
"PeriodicInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingInterestType"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "12345",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "",
"type": "string"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "",
"type": "string"
},
"period": {
"description": "The period",
"example": "",
"type": "string"
},
"rateIndex": {
"description": "The rateIndex",
"example": "",
"type": "string"
},
"repricingFrequency": {
"description": "The repricingFrequency",
"example": "",
"type": "string"
},
"interestCap": {
"description": "The interestCap",
"example": "",
"type": "string"
},
"interestFloor": {
"description": "The interestFloor",
"example": "",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "",
"type": "string"
},
"roundingRule": {
"description": "The roundingRule",
"example": "",
"type": "string"
}
}
},
"FloatingInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingInterestType"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "12345",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "",
"type": "string"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "",
"type": "string"
},
"period": {
"description": "The period",
"example": "",
"type": "string"
},
"rateIndex": {
"description": "The rateIndex",
"example": "",
"type": "string"
},
"rateChangeMethod": {
"description": "The rateChangeMethod",
"example": "",
"type": "string"
},
"interestCap": {
"description": "The interestCap",
"example": "",
"type": "string"
},
"interestFloor": {
"description": "The interestFloor",
"example": "",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "",
"type": "string"
},
"roundingRule": {
"description": "The roundingRule",
"example": "Round_near",
"type": "string"
},
"capBasis": {
"description": "The capBasis",
"example": "",
"type": "string"
}
}
},
"PricingRequest": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"interestRateType": {
"description": "The type of interest",
"example": "01",
"type": "string",
"x-referencetype": "InterestType"
},
"fixedInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestRate"
}
]
},
"periodicInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/PeriodicInterestRate"
}
]
},
"floatingInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FloatingInterestRate"
}
]
},
"status": {
"description": "The status",
"example": "01",
"type": "string",
"x-referencetype": "PricingStatus"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
}
}
},
"PricingResponse": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"interestRateType": {
"description": "The type of interest",
"example": "Fixed",
"type": "string"
},
"fixedInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestRate"
}
]
},
"periodicInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/PeriodicInterestRate"
}
]
},
"floatingInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FloatingInterestRate"
}
]
},
"status": {
"description": "The status",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
}
}
},
"PricingRequests": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingRequest"
}
}
}
},
"PricingResponses": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
}
}
},
"ProcessedPricingResponse": {
"properties": {
"pricingId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"ProcessedCovenantsResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"covenantId": {
"description": "Unique identifier for covenant",
"example": "COV2345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"CovenantsRequest": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "C12345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string",
"x-referencetype": "CovenantType"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string",
"x-referencetype": "CovenantFrequency"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "CovenantStatus"
},
"operator": {
"description": "Operator of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "Operator"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "requirement",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CovenantsResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "COV202012345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string"
},
"operator": {
"description": "Operator of the Covenant",
"example": "==",
"type": "string"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"allOf": [
{
"$ref": "extensionData.json#/components/schemas/customFields"
}
]
}
}
},
"CovenantsRequests": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsRequest"
}
}
}
},
"CovenantsResponses": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
}
}
},
"ConditionsInfo": {
"properties": {
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
}
}
},
"CreditDecisionInfo": {
"properties": {
"dealId": {
"description": "Unique identifier of the deal",
"example": "D202035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string",
"x-referencetype": "Decision"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
}
}
},
"CreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
}
}
},
"RequestOverViewResponse": {
"properties": {
"requestOverView": {
"allOf": [
{
"$ref": "#/components/schemas/DealDetailsResponse"
}
]
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"borrowerFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"checklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"AdjustmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"facilityName": {
"description": "Name of the facility",
"example": "ABC ltd",
"type": "string"
},
"adjustedAmount": {
"description": "Adjusted Amount",
"example": "2 million",
"type": "string"
},
"adjustedCurrency": {
"description": "Adjusted Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedComment": {
"description": "adjusted comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
}
}
},
"ExternalCommitmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"lenderName": {
"description": "Name of the lender",
"example": "Jhon",
"type": "string"
},
"commitmentAmount": {
"description": "commitment Amount",
"example": "2 million",
"type": "string"
},
"maturitydate": {
"description": "maturity Date",
"example": "2020-06-03",
"type": "string"
}
}
},
"ExposureCommentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"comment": {
"description": "comment",
"example": "this exposure is pending",
"type": "string"
}
}
},
"ExposureInfo": {
"properties": {
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"exposureUniqueId": {
"description": "Unique identifier of the Exposure",
"example": "P202035292905",
"type": "string"
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsInfo"
}
},
"externalCommitments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalCommitmentsInfo"
}
},
"exposureComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureCommentsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"exposureDate": {
"description": "Exposure Date",
"example": "2020-06-03",
"type": "string"
},
"exposureTime": {
"description": "Exposure Time",
"example": "02:22",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
}
}
},
"ExposureList": {
"properties": {
"exposureItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
}
}
},
"FacilityOverViewResponse": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"fees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"drawRestriction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
},
"compliance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"TasksParamsReferenceDataItems": {
"properties": {
"tasksParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksParamsItem"
}
},
"tasksInfo": {
"$ref": "#/components/schemas/TasksInfoItem"
}
}
},
"EntityOverViewResponse": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"Exposures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
}
}
},
"MessageList": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
}
}
},
"MessagesList": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageList"
}
}
}
},
"CreateMessagesResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"GetMessageResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"userId": {
"description": "user Id",
"example": "12345",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"lastChangeDateTime": {
"description": "read flag",
"example": "true",
"type": "string",
"format": "date"
}
}
},
"GetMessagesResponse": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetMessageResponse"
}
}
}
}
}
}
}
,
dom_id: "#swagger-ui1",
presets: [
SwaggerUIBundle.presets.apis,
]
})
</script>
|
|
<html>
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui.css" />
<div id="swagger-ui2">Â </div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-bundle.js" type="text/javascript">
</script>
<script type="text/javascript">
const ui2 = SwaggerUIBundle({
spec:
{
"openapi": "3.0.0",
"servers": [
{
"description": "Locally Deployed Environment",
"url": "http://localhost:8600/ms-corporatelos-api/api/v1.0.0"
}
],
"info": {
"title": "Corporate LOS API",
"description": "This API enables you to programmatically access all data related to Corporate LOS that users has granted access.",
"version": "1.0.0",
"contact": {
"email": "mprasadambati@temenos.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/origination/corporate/deals": {
"post": {
"summary": "Creates a new Corporate Request",
"description": "Creates new Corporate Request record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "createCorporateDealV1",
"tags": [
"Request"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Creation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreationResponse"
}
}
}
},
"400": {
"description": "Deal Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the corporate requests record",
"description": "Retrieves corporate requests record based on the request Id, Deal Name, User Id.",
"operationId": "getCorporateDealsV1",
"tags": [
"Request"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestName",
"in": "query",
"description": "Request Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "All Deal Details Retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllDealDetailsResponse"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{requestId}": {
"put": {
"summary": "Updates an existing Corporate Request",
"description": "Update Corporate Deal record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "updateCorporateDealV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Request"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealUpdatedResponse"
}
}
}
},
"400": {
"description": "Deal Update Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete the record of corporate request",
"description": "Delete Corporate Request record for given requestId .",
"operationId": "deleteCorporateDealV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Request"
],
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Deal Delete Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}/facilities": {
"post": {
"summary": "Creates new facilities for a Deal",
"description": "Create Facility record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "createFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates already existing facilities for a Request",
"description": "Update Facility record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "updateFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/{facilityId}": {
"delete": {
"summary": "Delete facilitie",
"description": "Delete Facility record based on facilityId.",
"operationId": "deleteFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility": {
"get": {
"summary": "Retrieves the Facility record",
"description": "Retrieves the Facility record based on the Request Id, Facility Id, Party Id and Facility Name .",
"operationId": "getFacilityV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityName",
"in": "query",
"description": "Facility Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Facility"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties": {
"post": {
"summary": "Create a relationship to the given Party id with the facility owner",
"description": "Create RelatedPartie record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "createRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the relationship to the given party id with the facilty owner",
"description": "Update RelatedPartie record with the provided data such as requestId, facilityId and partyId etc.",
"operationId": "updateRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the relatedParty record",
"description": "Retrieves the relatedParty record based on facilityId, relatedPartyId, partyId and requestId.",
"operationId": "getRelatedPartiesV1",
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatedPartyId",
"in": "query",
"description": "Related Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/connectedParties": {
"get": {
"summary": "Retrieves the connected Parties",
"description": "Retrieves the relatedParty record based on partyIds if they are related.",
"operationId": "getDealRelatedPartiesV1",
"parameters": [
{
"name": "party1",
"in": "query",
"description": "first party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "party2",
"in": "query",
"description": "second Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties/{rowId}": {
"delete": {
"tags": [
"Related Parties"
],
"summary": "soft delete the related parties",
"description": "related partyies record with the provided rowId, will be deleted softly.",
"operationId": "deleteRelatedPartiesV1",
"parameters": [
{
"name": "rowId",
"in": "path",
"description": "ID of row for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks/{indicator}": {
"post": {
"summary": "Creates tasks for a Deal",
"description": "Create Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "createTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "indicator",
"in": "path",
"description": "indicator",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks": {
"put": {
"summary": "Updates the Task record",
"description": "Update Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "updateTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks": {
"get": {
"summary": "Retrieves the details of tasks for the provided criteria",
"description": "Retrieves Task record based on dealId, partyId and Facility Id etc.",
"operationId": "getTasksV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "assignUserId",
"in": "query",
"description": "Assigned User Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "task status",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"in": "query",
"description": "task stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks/{taskId}": {
"delete": {
"summary": "Delete the task record",
"description": "Delete Task record based on taskId.",
"operationId": "deleteTasksV1",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "task Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "partyId",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals": {
"post": {
"tags": [
"Collateral"
],
"summary": "Add a new collateral to the Deal",
"description": "Create collateral record with the provided data such as dealId, facilityId and collateral type etc.",
"operationId": "createCollateralV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Collateral"
],
"summary": "Update the collateral associated to the Deal",
"description": "Update collateral record with the provided data such as dealId, facilityId and collateral type etc.",
"operationId": "updateCollateralV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Collateral"
],
"summary": "Fetch the collaterals associated to the Deal/Facility/Party/Collateral",
"description": "Retrieves the collateral records based on dealId, facilityId, partyId and collateralId.",
"operationId": "getCollateralV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "DealId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "PartyId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals/{collateralId}": {
"delete": {
"tags": [
"Collateral"
],
"summary": "soft delete the collateral",
"description": "collateral record with the provided collateralId, will be deleted softly.",
"operationId": "deleteCollateralV1",
"parameters": [
{
"name": "collateralId",
"in": "path",
"description": "unique ID of collateral for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "unique ID of facility for the request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "unique ID of request",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/collaterals": {
"put": {
"tags": [
"Collateral"
],
"summary": "Update the collateral From FacilityOverView",
"description": "Update collateral record with the provided data such as dealId, facilityId and collateral type etc.",
"operationId": "updateCollateralFromFOV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents": {
"post": {
"summary": "creates new documents and adds them to deal",
"description": "Create document records with the provided data such as requestId, facilityId and document name etc.",
"operationId": "createDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCreationRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "updates the existing documents data",
"description": "Update document records with the provided data such as requestId, facilityId and document name etc.",
"operationId": "updateDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of documents for the provided criteria",
"description": "Retrieve the document records based on dealId, facilityId and partyId.",
"operationId": "getDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents/{documentId}": {
"delete": {
"tags": [
"Documents"
],
"summary": "soft delete the document",
"description": "Document record with the provided documentId,requestId,facilityId will be deleted softly.",
"operationId": "deletedocumentV1",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "ID of Document for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives": {
"post": {
"summary": "Create narrative and add to deal",
"description": "Create narrative records with the provided data such as dealId, facilityId , partyId and categoryId etc.",
"operationId": "createNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update narrative",
"description": "Update narrative records with the provided data such as dealId, facilityId, partyId and categoryId etc.",
"operationId": "updateNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Narrative records",
"description": "Retrieves the Narrative records based on dealId, facilityId and partyId.",
"operationId": "getNarrativesV1",
"tags": [
"Narratives"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "Collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives/{narrativeId}": {
"delete": {
"tags": [
"Narratives"
],
"summary": "soft delete the narrative",
"description": "narrative record with the provided narrativeId, will be deleted softly.",
"operationId": "deleteNarrativeV1",
"parameters": [
{
"name": "narrativeId",
"in": "path",
"description": "ID of narrative for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "ID of Request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of Facility",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/narratives": {
"put": {
"tags": [
"Narratives"
],
"summary": "Update narratives from Facility Overview",
"description": "Update narrative records with the provided data such as facilityId, category,userId etc.",
"operationId": "updateNarrativesFromFOV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/reference/{referenceId}": {
"get": {
"summary": "gets the reference data from reference tables",
"description": "Retrieves the reference data based on the referenceId.",
"operationId": "getRefData",
"tags": [
"Reference Data"
],
"parameters": [
{
"name": "referenceId",
"in": "path",
"description": "Reference Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerRequest": {
"post": {
"summary": "Stores the captured information of the request submission form",
"description": "Create customerRequest records with the provided data such as userId, requestId and customerInformation etc.",
"operationId": "createCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete the captured information of the request submission form",
"description": "Delete customerRequest records with the provided data such as userId, requestId etc.",
"operationId": "deleteCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get all the information associated to the userid and requestid",
"description": "Retrieves customerRequest records based on userId, requestId and status.",
"operationId": "getCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "status",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestsInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions": {
"post": {
"summary": "Creates draw restrictions for a particular deal",
"description": "Create drawRestriction records with the provided data such as requestId, facilityId and restrictionType etc.",
"operationId": "createDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Draw restrictions against a deal",
"description": "Update drawRestriction records with the provided data such as requestId, facilityId and restrictionType etc.",
"operationId": "updateDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of draw restrictions against request or facility",
"description": "Retrieves drawRestriction records based on requestId, facilityId.",
"operationId": "getDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions/{drawRestrictionId}": {
"delete": {
"tags": [
"Draw Restrictions"
],
"summary": "soft delete the Draw Restrictions",
"description": "Draw Restrictions record with the provided drawRestrictionId, will be deleted softly.",
"operationId": "deleteDrawRestrictionV1",
"parameters": [
{
"name": "drawRestrictionId",
"in": "path",
"description": "ID of Draw Restrictions for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of Facility",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance": {
"get": {
"summary": "Retrieves the details of the compliance for the provided criteria",
"description": "Retrieves the compliance records based on requestId, facilityId,partyId and complianceId.",
"operationId": "getComplianceV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "complianceId",
"in": "query",
"description": "complaince Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Compliance"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Compliance"
],
"summary": "Add a new compliance to the Deal",
"description": "Create the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "createComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Compliance"
],
"summary": "Update compliance to the Deal",
"description": "Update the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "updateComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance/{complianceId}": {
"delete": {
"tags": [
"Compliance"
],
"summary": "soft delete the compliance",
"description": "Compliance record with the provided complianceId, will be deleted softly.",
"operationId": "deleteComplianceV1",
"parameters": [
{
"name": "complianceId",
"in": "path",
"description": "ID of Compliance for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails": {
"post": {
"summary": "Create funding details",
"description": "Create the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "createFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update fundings Details",
"description": "Update the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "updateFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Funding details",
"description": "Retrieves the funding records based on dealId, facilityId and fundingId.",
"operationId": "getFundingDetailsV1",
"tags": [
"Funding"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fundingId",
"in": "query",
"description": "Funding Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "addressRefrence",
"in": "query",
"description": "refrence of address",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails/{fundingId}": {
"delete": {
"tags": [
"Funding"
],
"summary": "soft delete the fundings",
"description": "Fundings record with the provided fundingId, will be deleted softly.",
"operationId": "deleteFundingV1",
"parameters": [
{
"name": "fundingId",
"in": "path",
"description": "ID of funding for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits": {
"post": {
"summary": "Create limit records",
"description": "Create the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "createLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Limit details to the given limit id",
"description": "Update the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "updateLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieve the Limit record",
"description": "Retrieve the Limit record based on limitId.",
"operationId": "getLimitsV1",
"tags": [
"Limits"
],
"parameters": [
{
"name": "limitId",
"in": "query",
"description": "limit Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits/{limitId}": {
"delete": {
"tags": [
"Limits"
],
"summary": "soft delete the limits",
"description": "Limits record with the provided limitId, will be deleted softly.",
"operationId": "deleteLimitsV1",
"parameters": [
{
"name": "limitId",
"in": "path",
"description": "ID of limit for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees": {
"post": {
"summary": "create Fee details to the given facility/deal",
"description": "Create the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "createFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Fee details to the given id",
"description": "Update the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "updateFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Fee details to the given facility id/deal id",
"description": "Retrieve the Fee records based on dealId, facilityId, feeType.",
"operationId": "getFeesV1",
"tags": [
"Fees"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees/{feeId}": {
"delete": {
"tags": [
"Fees"
],
"summary": "soft delete the fees",
"description": "fees record with the provided feeId, will be deleted softly.",
"operationId": "deleteFeesV1",
"parameters": [
{
"name": "feeId",
"in": "path",
"description": "ID of fees for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings": {
"post": {
"summary": "create Pricing details to the given deal/facility",
"description": "Create the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "createPricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Pricing details to the given Pricing id",
"description": "Update the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "updatePricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Pricing details to the given facility id",
"description": "Retrieve the Pricing records based on dealId, facilityId.",
"operationId": "getPricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "deal Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings/{pricingId}": {
"delete": {
"summary": "delete Pricing details to the given pricing id",
"description": "Delete the Pricing records based on pricing Id.",
"operationId": "deletePricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "pricingId",
"in": "path",
"description": "pricing Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants": {
"post": {
"summary": "Creates covenants for a Deal",
"description": "Create the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "createCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Covenants for a Deal",
"description": "Update the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the details of covenants for the provided criteria",
"description": "Retrieve the Covenant records based on dealId, facilityId, partyId and covenantId.",
"operationId": "getCovenantsV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "covenantId",
"in": "query",
"description": "covenant Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants/{covenantId}": {
"delete": {
"summary": "Delete the covenant record.",
"description": "Delete the covenant record based on covenantId.",
"operationId": "deleteCovenantsV1",
"parameters": [
{
"name": "covenantId",
"in": "path",
"description": "covenant Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/covenants": {
"put": {
"summary": "Update the covenant record from Facility overview.",
"description": "Update the Covenant records From FO with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsFromFOV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions": {
"post": {
"summary": "create credit decisions to the given facility",
"description": "Create the creditDecision records with the provided data such as requestId, facilityId and decisionDate etc.",
"operationId": "createCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditDecisionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update credit decisions to the given creditDecision id",
"description": "Update the creditDecision records with the provided data such as requestId, facilityId and decisionDate etc.",
"operationId": "updateCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDecisionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given facility",
"description": "Retrieve the creditDecision records based on requestId,facilityId and decisionId.",
"operationId": "getCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "decisionId",
"in": "query",
"description": "decision Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions/{creditDecisionId}": {
"delete": {
"summary": "Delete credit decisions to the given creditDecision id",
"description": "Delete the creditDecision record to given creditDecision id.",
"operationId": "deleteCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "creditDecisionId",
"in": "path",
"description": "creditDecision Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/policyExceptions": {
"post": {
"summary": "create policy exceptions to the given facility",
"description": "Create the policyExceptions records with the provided data such as requestId, facilityId and exceptionType etc.",
"operationId": "createPolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExceptionsList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPolicyResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the policy exception to the given facility",
"description": "Retrieve the policy exception records based on facilityId and policyExceptionId.",
"operationId": "getPolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExceptionResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update policy exceptions to the given policyException id",
"description": "Update the PolicyExceptions records with the provided data such as requestId, facilityId and exceptionType etc.",
"operationId": "updatePolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePolicyExceptionsList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPolicyResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/policyExceptions/{policyExceptionId}": {
"delete": {
"summary": "Delete policy exceptions to the given policy id",
"description": "Delete the policy exceptions record to given policy id.",
"operationId": "deletePolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"parameters": [
{
"name": "policyExceptionId",
"in": "path",
"description": "policyException Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/conditions": {
"put": {
"summary": "update condition the given condition id",
"description": "Update the condition records with the provided data such as conditionId, creditDecisionId and etc.",
"operationId": "updateConditionV1",
"tags": [
"Conditions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConditionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedConditionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/conditions/{conditionId}": {
"delete": {
"summary": "Delete the condition for given condition id",
"description": "Delete the condition records with the provided conditionId.",
"operationId": "deleteConditionV1",
"tags": [
"Conditions"
],
"parameters": [
{
"name": "conditionId",
"in": "path",
"description": "Condition Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}": {
"get": {
"summary": "Retrieves the requestOverview details",
"description": "Retrieves the requestOverview details based on requestId.",
"operationId": "getRequestOverviewV1",
"tags": [
"RequestOverView"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure": {
"post": {
"summary": "Create Exposure records",
"description": "Create the Exposure records with the provided data such as partyId, exposureType and exposureUniqueId etc.",
"operationId": "createExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureType",
"in": "query",
"description": "exposureType",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given party",
"description": "Retrieve the exposure records based on partyId and exposureUniqueId.",
"operationId": "getExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/{facilityId}": {
"get": {
"summary": "Retrieves FacilityOverview details",
"description": "Retrieves FacilityOverview details based on facilityId.",
"operationId": "getFacilityOverviewV1",
"tags": [
"FacilityOverview"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasksparams": {
"get": {
"summary": "Retrieves the data related to tasks params",
"description": "Retrieves the task records based on taskStage and taskId.",
"operationId": "getTasksParamsV1",
"tags": [
"TasksParams"
],
"parameters": [
{
"name": "taskStage",
"in": "query",
"description": "Task Stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task ID",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksParamsReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/{partyId}": {
"get": {
"summary": "Retrieves PartyOverview details",
"description": "Retrieves PartyOverview details based on partyId.",
"operationId": "getEntityOverviewV1",
"tags": [
"EntityOverview"
],
"parameters": [
{
"name": "partyId",
"in": "path",
"description": "party Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message/{userId}": {
"post": {
"summary": "creates the messages to the dealId",
"description": "Create the messages records with the provided data such as userId, dealId and messagedescription etc.",
"operationId": "createMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessagesList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message": {
"get": {
"summary": "Retrieve the message records",
"description": "Retrieve the message records based on userId and messageId.",
"operationId": "getMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "messageId",
"in": "query",
"description": "message Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/integrationServices": {
"get": {
"summary": "Retrieves the details of the integrationServices for the provided criteria",
"description": "Retrieves the integrationServices records based on requestId, facilityId,partyId and integrationServicesId.",
"operationId": "getIntegrationServicesV1",
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "integrationServicesId",
"in": "query",
"description": "integrationServices Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"IntegrationServices"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"IntegrationServices"
],
"summary": "Add a new integrationServices to the facility or party",
"description": "Create the integrationService records with the provided data.",
"operationId": "createIntegrationServicesV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedIntegrationServicesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"IntegrationServices"
],
"summary": "Update IntegrationServices to the facility or party",
"description": "Update the integrationService records with the provided data.",
"operationId": "updateIntegrationServicesV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedIntegrationServicesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/integrationServices/{integrationServicesId}": {
"delete": {
"tags": [
"IntegrationServices"
],
"summary": "soft delete the integrationServices",
"description": "IntegrationServices record with the provided integrationServicesId, will be deleted softly.",
"operationId": "deleteIntegrationServicesV1",
"parameters": [
{
"name": "integrationServicesId",
"in": "path",
"description": "ID of IntegrationServices for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/externalServicesHistory": {
"get": {
"summary": "Retrieves the details of the externalServicesHistory for the provided criteria",
"description": "Retrieves the externalServicesHistory records based on requestId, facilityId,partyId and externalServicesHistoryId.",
"operationId": "getExternalServicesHistoryV1",
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "externalServicesHistoryId",
"in": "query",
"description": "externalServicesHistory Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"ExternalServicesHistory"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryResposes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"ExternalServicesHistory"
],
"summary": "Add a new externalServicesHistory to the request",
"description": "Create the externalServicesHistory records with the provided data.",
"operationId": "createExternalServicesHistoryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedExternalServicesHistoryResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"ExternalServicesHistory"
],
"summary": "Update externalServicesHistory to the facility or party",
"description": "Update the externalServicesHistory records with the provided data.",
"operationId": "updateExternalServicesHistoryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedExternalServicesHistoryResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/externalServicesHistory/{externalServicesHistoryId}": {
"delete": {
"tags": [
"ExternalServicesHistory"
],
"summary": "soft delete the externalServicesHistory",
"description": "ExternalServicesHistory record with the provided externalServicesHistoryId, will be deleted softly.",
"operationId": "deleteExternalServicesHistoryV1",
"parameters": [
{
"name": "externalServicesHistoryId",
"in": "path",
"description": "ID of externalServicesHistory for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requestProcessRelation": {
"post": {
"summary": "Creates a new Request Process relationship",
"description": "Creates new requestProcessRelation record with the provided data such as facilityId, parenProcessId and requestId etc.",
"operationId": "createRequestProcessRelationV1",
"tags": [
"RequestProcessRelationship"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestProcessRelations"
}
}
}
},
"responses": {
"200": {
"description": "Create RequestProcessRelation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "RequestProcessRelation Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Request Process relationship",
"description": "Retrieves Request Process relationship record based on the request Id,facility Id, parenProcess Id.",
"operationId": "getRequestProcessRelationV1",
"tags": [
"RequestProcessRelationship"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "parenProcessId",
"in": "query",
"description": "parenProcess Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "RequestProcessRelation retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestProcessRelationResponses"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"FailureMessage": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"StandardErrorResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailureMessage"
}
},
"ProcessedFacilityResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityCreateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "01",
"type": "string"
},
"facilityId": {
"description": "Temperory id of the facility from onboarding",
"example": "T1234567",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string",
"x-referencetype": "FacilityUsage"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityUpdateRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "03",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string",
"x-referencetype": "FacilityUsage"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "01",
"type": "string",
"x-referencetype": "AcceptanceStatus"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "Line of Credit",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "Working Capital",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "Awaiting Approval",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "Approved",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityCreateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
}
}
},
"FacilityUpdateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityUpdateRequest"
}
}
}
},
"FacilityResponses": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"RelatedPartiesSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
},
"rowId": {
"description": "Specifies RowId of the request",
"example": "R1234,R1290",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRelatedPartiesRequest": {
"properties": {
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateRelatedPartiesRequest": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "D202012345678",
"type": "string"
},
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RelatedPartiesResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "12345678",
"type": "string"
},
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "Guarantor",
"type": "string"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "Amount",
"type": "string"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
}
}
},
"UpdateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequest"
}
}
}
},
"RelatedPartiesResponses": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
}
}
},
"ProcessedTasksResponse": {
"properties": {
"taskId": {
"description": "Unique identifier for Task",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"NoteItem": {
"properties": {
"noteDescription": {
"description": "description notes",
"example": "task notes",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"TasksRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskProvider"
},
"taskPackage": {
"description": "Package of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPackage"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskCategory"
},
"taskType": {
"description": "Type of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskType"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPriority"
},
"extensionData": {
"type": "object"
}
}
},
"TasksResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "Moody's",
"type": "string"
},
"taskPackage": {
"description": "Package of the task",
"example": "Fraud-Check",
"type": "string"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "Prescreening",
"type": "string"
},
"taskType": {
"description": "Type of the task",
"example": "Auto",
"type": "string"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "In-Process",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "medium",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"TasksRequests": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksRequest"
}
}
}
},
"TasksResponses": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"CollateralRequest": {
"properties": {
"collateralId": {
"description": "Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"requestId": {
"description": "Identifier of Request",
"example": "R20210421",
"type": "string"
},
"facilityId": {
"description": "Identifier of Facility",
"example": "F12345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P129343",
"type": "string"
},
"collateralType": {
"description": "Type of the Collateral",
"example": "01",
"type": "string"
},
"collateralSubType": {
"description": "Subtype of the Collateral",
"example": "001",
"type": "string"
},
"collateralName": {
"description": "Name of the Collateral",
"example": "Assert",
"type": "string"
},
"collateralMarketValue": {
"description": "Market value of the Collateral",
"example": "1000000",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of the Collateral",
"example": "1:2",
"type": "string"
},
"collateralStatus": {
"description": "Status of the Collateral",
"example": "inProgress",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral",
"example": "1001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralResponse": {
"properties": {
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"requestId": {
"description": "Unique Identifier of Request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F200722894",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P129343",
"type": "string"
},
"collateralType": {
"description": "Type of the Collateral",
"example": "01",
"type": "string"
},
"collateralSubType": {
"description": "Subtype of the Collateral",
"example": "001",
"type": "string"
},
"collateralName": {
"description": "Name of the Collateral",
"example": "Assert",
"type": "string"
},
"collateralMarketValue": {
"description": "Market value of the Collateral",
"example": "1000000",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of the Colateral",
"example": "1:2",
"type": "string"
},
"collateralStatus": {
"description": "Status of the Collateral",
"example": "inProgress",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral",
"example": "1001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the collateral was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRequests": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
}
}
},
"CollateralResponses": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
}
}
},
"ProcessedCollateralResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for request",
"example": "D202035269718",
"type": "string"
},
"collateralId": {
"description": "Collateral id",
"example": "C202035292905",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentCreationRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentType"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategory"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDocumentsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D2020123456",
"type": "string"
},
"documentId": {
"description": "Unique identifier for Document",
"example": "123456789",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentUpdateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier for Document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentType"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategory"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "Terms Sheet",
"type": "string"
},
"documentCategory": {
"description": "Category of a document",
"example": "Entity",
"type": "string"
},
"documentStatus": {
"description": "Status of a document",
"example": "Approved",
"type": "string"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentCreationRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
}
}
},
"DocumentUpdateRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentUpdateRequest"
}
}
}
},
"DocumentResponses": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
}
},
"FacilityTerm": {
"properties": {
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateDealSchema": {
"properties": {
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"usageId": {
"description": "Usage of the deal",
"example": "01",
"type": "string",
"x-referencetype": "FacilityUsage"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"facilityList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
},
"relatedPartiesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
},
"documentsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
},
"collateralsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
},
"lastChangeUserId": {
"description": "last Modification made by user on Requests",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a Request",
"example": "ABC Corp",
"type": "string"
},
"requestStatus": {
"description": "status of a Request",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"activeProcessId": {
"description": "Active Process for Request",
"example": "1",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DealCreationResponse": {
"properties": {
"requestId": {
"description": "Request ID of the Deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "D487598",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "200722894",
"type": "string"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"status": {
"description": "Status of the deal",
"example": "Created",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateDealSchema": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string",
"x-referencetype": "FacilityUsage"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"requestStatus": {
"description": "Status of the deal",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DealUpdatedResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"requestStatus": {
"description": "Status of the deal",
"example": "Success",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"RequestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DealDetailsResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"requestStatus": {
"description": "Status of the deal",
"example": "Submitted",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"AllDealDetailsResponse": {
"properties": {
"allDealsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
}
}
},
"NarrativesCreateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"collateralId": {
"description": "ID of the Collateral created for this deal",
"example": "C1234567",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesUpdateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"collateralId": {
"description": "ID of the Collateral created for this deal",
"example": "C12345678",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedNarrativesResponse": {
"properties": {
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesResponse": {
"properties": {
"categoryId": {
"description": "ID of the category",
"example": "2",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "F123456",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F123456",
"type": "string"
},
"collateralId": {
"description": "Unique identifier for Collateral",
"example": "N20201234",
"type": "string"
},
"partyId": {
"description": "Unique identifier for Party",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesResponses": {
"properties": {
"Narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
}
}
},
"NarrativesCreateRequests": {
"properties": {
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesCreateRequest"
}
}
}
},
"NarrativesUpdateRequests": {
"properties": {
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesUpdateRequest"
}
}
}
},
"EnrichmentResponseItem": {
"properties": {
"value": {
"description": "Value of the reference record",
"type": "string"
},
"description": {
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralSubTypesItem": {
"properties": {
"collateralSubTypeId": {
"description": "Collateral Sub Type Id",
"example": "001",
"type": "string"
},
"collateralSubTypeValue": {
"description": "Collateral Sub Type Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralTypesItem": {
"properties": {
"collateralTypeId": {
"description": "Collateral Type Id",
"example": "01",
"type": "string"
},
"collateralTypeValue": {
"description": "Collateral Type Value",
"example": "Vehicles",
"type": "string"
},
"collateralSubTypes": {
"description": "Collateral Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralSubTypesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"StageSignalTypesItems": {
"properties": {
"stage": {
"description": "Stage Value",
"example": "01",
"type": "string"
},
"signalName": {
"description": "Stage Name",
"example": "prescreeningSignal",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndustrialSubTypesItem": {
"properties": {
"industrialSubTypeId": {
"description": "industrial Sub Type Id",
"example": "001",
"type": "string"
},
"industrialSubTypeValue": {
"description": "Industrial Sub Type Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndustrialTypesItem": {
"properties": {
"industrialTypeId": {
"description": "Industrial Type Id",
"example": "01",
"type": "string"
},
"industrialTypeValue": {
"description": "Industrial Type Value",
"example": "Vehicles",
"type": "string"
},
"industrialSubTypes": {
"description": "Industrial Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialSubTypesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"FeeNamesItem": {
"properties": {
"feeNameId": {
"description": "Fee Name Id",
"example": "001",
"type": "string"
},
"feeNameValue": {
"description": "Fee Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypesItem": {
"properties": {
"feeTypesId": {
"description": "Fee Type Id",
"example": "01",
"type": "string"
},
"feeTypesValue": {
"description": "Fee Type Value",
"example": "Vehicles",
"type": "string"
},
"feeNames": {
"description": "Fee Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ConditionNamesItem": {
"properties": {
"conditionNameId": {
"description": "Condition Name Id",
"example": "001",
"type": "string"
},
"conditionNameValue": {
"description": "Condition Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ConditionTypesItem": {
"properties": {
"conditionTypesId": {
"description": "Condition Type Id",
"example": "01",
"type": "string"
},
"conditionTypesValue": {
"description": "Condition Type Value",
"example": "Vehicles",
"type": "string"
},
"conditionNames": {
"description": "Condition Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"CovenantNamesItem": {
"properties": {
"covenantNameId": {
"description": "Covenant Name Id",
"example": "001",
"type": "string"
},
"covenantNameValue": {
"description": "Covenant Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantTypesItem": {
"properties": {
"covenantTypesId": {
"description": "Covenant Type Id",
"example": "01",
"type": "string"
},
"covenantTypesValue": {
"description": "Covenant Type Value",
"example": "Vehicles",
"type": "string"
},
"covenantNames": {
"description": "Covenant Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceNamesItem": {
"properties": {
"complianceNameId": {
"description": "Compliance Name Id",
"example": "001",
"type": "string"
},
"complianceNameValue": {
"description": "Compliance Name Value",
"example": "Car",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceTypesItem": {
"properties": {
"complianceTypesId": {
"description": "Compliance Type Id",
"example": "01",
"type": "string"
},
"complianceTypesValue": {
"description": "Compliance Type Value",
"example": "Vehicles",
"type": "string"
},
"complianceNames": {
"description": "Compliance Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativeCategoryItem": {
"properties": {
"type": {
"description": "Narrative Category Type",
"example": "financial",
"type": "string"
},
"value": {
"description": "Narrative Category Value",
"example": "01",
"type": "string"
},
"description": {
"description": "description of Narrative category",
"example": "financial",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionTypesItem": {
"properties": {
"type": {
"description": "Policy Exception Type",
"example": "equity",
"type": "string"
},
"value": {
"description": "Policy Exception Value",
"example": "01",
"type": "string"
},
"description": {
"description": "description of Policy exception",
"example": "equity",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"StateInfo": {
"properties": {
"stateCode": {
"description": "code of the state",
"example": "AK",
"type": "string"
},
"stateName": {
"description": "State name",
"example": "Alaska",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CountryInfo": {
"properties": {
"countryCode": {
"description": "Code of the country",
"example": "US",
"type": "string"
},
"countryUniCode": {
"description": "Uni code of the country",
"example": "+840",
"type": "string"
},
"countryName": {
"description": "Name of the country",
"example": "United States",
"type": "string"
},
"countryPhoneCode": {
"description": "Phone code of the country",
"example": "+840",
"type": "string"
},
"states": {
"description": "List of states",
"type": "array",
"items": {
"$ref": "#/components/schemas/StateInfo"
}
},
"extensionData": {
"type": "object"
}
}
},
"TasksInfoItem": {
"properties": {
"taskId": {
"description": "Task Id",
"example": "01",
"type": "string"
},
"taskName": {
"description": "Task Name",
"example": "Borrower Info",
"type": "string"
},
"taskDescription": {
"description": "Task Description",
"example": "Borrower Info",
"type": "string"
},
"taskType": {
"description": "Task Type",
"example": "Manual",
"type": "string"
},
"defaultUserId": {
"description": "Default User Id",
"example": "1001",
"type": "string"
},
"ruleId": {
"description": "rule Id",
"example": "01",
"type": "string"
},
"taskPackage": {
"description": "task Package",
"example": "Fraud-check",
"type": "string"
},
"taskProvider": {
"description": "task Provider",
"example": "Borrower",
"type": "string"
},
"noOfDays": {
"description": "Task Lifetime for no of days",
"example": "5",
"type": "string"
},
"defaultUserEmail": {
"description": "Default User Email",
"example": "temenostestmail@gmail.com",
"type": "string"
},
"partyIndicator": {
"description": "Party Indicator",
"example": "00",
"type": "string"
},
"overview": {
"description": "overview screen",
"example": "Entity Overview",
"type": "string"
},
"section": {
"description": "Section Screen",
"example": "Documents",
"type": "string"
},
"processDefId": {
"description": "Id of process initiated by PAM",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"TasksCheckListItem": {
"properties": {
"taskCheckListId": {
"description": "Task Check List Id",
"example": "01",
"type": "string"
},
"taskCheckListName": {
"description": "Task Check List Name",
"example": "Fraud check",
"type": "string"
},
"tasksInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksInfoItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"TasksParamsItem": {
"properties": {
"taskStage": {
"description": "Task Stage",
"example": "Onboarding",
"type": "string"
},
"tasksCheckList": {
"description": "Task CheckList",
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"lastChangeUserId": {
"description": "Last Change User Id",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ReferenceDataItems": {
"properties": {
"documentType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"limitType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"relatedPartyRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"dealStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"operator": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"interestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"restrictionType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"payType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"addressType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"currency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"noOfEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"portfolio": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"profitCenter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPriority": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"salutation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"partyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"fundingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingInterestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeBalanceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"basisTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collectionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPackage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingIndex": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityPurpose": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityUsage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"policyExceptionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"productReferenceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branchReferenceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"jobTitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskProvider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"acceptanceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"companyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"contactTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeFrequencyTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"riskRatingTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"beneficialOwnerDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rateTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"provider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"providerType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"repricingFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"paymentFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralTypesItem"
}
},
"stageSignalTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageSignalTypesItems"
}
},
"industryTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialTypesItem"
}
},
"conditionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionTypesItem"
}
},
"covenantTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantTypesItem"
}
},
"complianceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceTypesItem"
}
},
"narrativeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativeCategoryItem"
}
},
"policyExceptionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionTypesItem"
}
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryInfo"
}
},
"feeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeTypesItem"
}
},
"UITasksCheckList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
}
}
},
"BasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"legalName": {
"description": "legalName of the Customer",
"example": "ABC Company",
"type": "string"
},
"registrationNumber": {
"description": "registration number of the Customer",
"example": "ABC Company",
"type": "string"
},
"companyType": {
"description": "company type",
"example": "Community Interest Company (CIC)",
"type": "string",
"x-referencetype": "CompanyType"
},
"industryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"subIndustryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"registrationDate": {
"description": "date of registration",
"example": "Telecom",
"type": "string"
},
"yearsInBusiness": {
"description": "years in business",
"example": "5",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedAnnualRevenue": {
"description": "estimated annual revenue",
"example": "10000000",
"type": "string"
},
"noOfEmployees": {
"description": "no of employees",
"example": "01",
"type": "string",
"x-referencetype": "NoOfEmployees"
},
"websiteAddress": {
"description": "websire address",
"example": "www.abc.com",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"companyOverview": {
"description": "company overview",
"example": "Telecom company",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"jobTitle": {
"description": "jobTitle of the person",
"example": "MD",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phnNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddr": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PartyInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "12345",
"type": "string"
},
"partyName": {
"description": "Name of the party",
"example": "ABC corporation",
"type": "string"
},
"partyType": {
"description": "Type of the party",
"example": "Individual",
"type": "string"
}
}
},
"GroupInfo": {
"properties": {
"groupId": {
"description": "unique identifier of the group",
"example": "1234567",
"type": "string"
},
"groupName": {
"description": "Name of the Group",
"example": "ABC Group",
"type": "string"
},
"groupType": {
"description": "Type of the Group",
"example": "Borrowing",
"type": "string"
},
"overView": {
"description": "Overview of the Group",
"type": "string"
},
"partyInfoList": {
"description": "party infor of particular group",
"type": "array",
"items": {
"$ref": "#/components/schemas/PartyInfo"
}
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "+91",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndividualBasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"dateOfBirth": {
"description": "dob of the person",
"example": "1978-06-03",
"type": "string"
},
"identificationNumber": {
"description": "id proof of the person",
"example": "9876095404361276",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddress": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityInfo": {
"properties": {
"facilityId": {
"description": "unique identifier of the facility",
"example": "F20201234567",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P20201234567",
"type": "string"
},
"groupId": {
"description": "unique identifier of the group",
"example": "P20201234567",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "facility123",
"type": "string"
},
"purpose": {
"description": "purpose of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"usageId": {
"description": "usage id of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityUsage"
},
"type": {
"description": "type of the facility",
"example": "line of credit",
"type": "string"
},
"currency": {
"description": "Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "amount of the facility",
"example": "10000000",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RelatedPartyInfo": {
"properties": {
"id": {
"description": "unique identifier",
"example": "12345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"groupId": {
"description": "unique identifier of the group",
"example": "P20201234567",
"type": "string"
},
"relatedGroupId": {
"description": "unique identifier of the related group",
"example": "P20201234567",
"type": "string"
},
"relatedPartyId": {
"description": "unique identifier of the related party",
"example": "P20201234567",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"partyName": {
"description": "name of the party",
"example": "abc",
"type": "string"
},
"relatedPartyName": {
"description": "name of the related party",
"example": "party1",
"type": "string"
},
"relatedGroupName": {
"description": "name of the relatedGroup",
"example": "group1",
"type": "string"
},
"relatedPartyType": {
"description": "type of the relatedparty",
"example": "abc",
"type": "string"
},
"role": {
"description": "role",
"example": "01",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "amount or percentage of limit",
"example": "percentage",
"type": "string"
},
"limitCurrency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"limitValue": {
"description": "value",
"example": "10000000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralInfo": {
"properties": {
"collateralId": {
"description": "unique identifier of the collateral",
"example": "C202012345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"name": {
"description": "name of the collateral",
"example": "building",
"type": "string"
},
"type": {
"description": "type of the collateral",
"example": "01",
"type": "string"
},
"subType": {
"description": "subtype of the collateral",
"example": "001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedValue": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentInfo": {
"properties": {
"documentId": {
"description": "Id of the document",
"example": "123456",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"collateralId": {
"description": "unique identifier of the Collateral",
"example": "T202012345678",
"type": "string"
},
"requestId": {
"description": "unique identifier of the request",
"example": "T202012345",
"type": "string"
},
"documentName": {
"description": "name of the document",
"example": "agreement",
"type": "string"
},
"documentType": {
"description": "type of the document",
"example": "02",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"uploadOn": {
"description": "date of upload",
"example": "2020-06-03",
"type": "string"
},
"category": {
"description": "category",
"example": "",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerRequestInfo": {
"properties": {
"requestId": {
"description": "Id of the request",
"example": "654564",
"type": "string"
},
"userId": {
"description": "id of the user who created the request",
"example": "87654",
"type": "string"
},
"usageId": {
"description": "id of the usage who created the request",
"example": "U123",
"type": "string",
"x-referencetype": "FacilityUsage"
},
"currency": {
"description": "currency",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"status": {
"description": "current step of submission process",
"example": "Draft",
"type": "string"
},
"screenFlag": {
"description": "Specifies screen of the request",
"example": "Facility",
"type": "string"
},
"requestType": {
"description": "Specifies request type",
"example": "delete",
"type": "string"
},
"summary": {
"description": "summary of the request being raised",
"example": "test summary",
"type": "string"
},
"requestDate": {
"description": "Date of the request being raised",
"example": "2020-06-03",
"type": "string"
},
"customerInformation": {
"allOf": [
{
"$ref": "#/components/schemas/BasicInfo"
}
]
},
"groupInformation": {
"allOf": [
{
"$ref": "#/components/schemas/GroupInfo"
}
]
},
"facilityItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityInfo"
}
},
"relatedPartyItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyInfo"
}
},
"newRelatedPartyIndividualItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndividualBasicInfo"
}
},
"newRelatedPartyBusinessItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicInfo"
}
},
"collateralItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"documentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentInfo"
}
},
"extensionData": {
"type": "object"
}
}
},
"CustomerRequestsInfo": {
"properties": {
"customerRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"CreateCustomerProcessedResponse": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "TEMP-12345678",
"type": "string"
},
"customerPartyId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"customerGroupId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"facilityId": {
"description": "unique id of the facility",
"example": "F202012345678",
"type": "string"
},
"Ids": {
"description": "unique id of the relatedParties",
"example": "P202012345678",
"type": "string"
},
"individualPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"businessPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"collateralIds": {
"description": "unique id of the collaterals",
"example": "C202012345678",
"type": "string"
},
"documentIds": {
"description": "unique id of the documents",
"example": "D202012345678",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionsRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "01",
"type": "string",
"x-referencetype": "RestrictionType"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyIdsArray"
}
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012586",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDrawRestrictionsResponse": {
"properties": {
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012566",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "Maximum Limit amount",
"type": "string"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyIdsArray"
}
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the restriction was last changed",
"type": "string",
"format": "date"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionsRequests": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionsRequest"
}
}
}
},
"DrawRestrictionResponses": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
}
}
},
"ComplianceRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "R2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateComplianceRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "COMP123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceRequest"
}
}
}
},
"UpdateComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateComplianceRequest"
}
}
}
},
"ComplianceResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "123456789",
"type": "string"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceResponses": {
"properties": {
"Compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
}
}
},
"PolicyExceptionResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P3456789",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"policyExceptionId": {
"description": "Unique Identifier of PolicyException",
"example": "123456789",
"type": "string"
},
"exceptionType": {
"description": "Type of Exception",
"type": "string"
},
"description": {
"description": "description of the exception",
"type": "string"
},
"comment": {
"description": "policyException comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a policyException",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionResponses": {
"properties": {
"policyExceptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionResponse"
}
}
}
},
"ProcessedComplianceResponse": {
"properties": {
"RequestId": {
"description": "Unique identifier for Deal",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"complianceId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedConditionResponse": {
"properties": {
"conditionId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"ProcessedDecisionResponse": {
"properties": {
"creditDecisionId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"ProcessedPolicyResponse": {
"properties": {
"policyExceptionId": {
"description": "Unique identifier for PolicyExceptions",
"example": "PE123456",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"AddressDetails": {
"properties": {
"addressLine1": {
"description": "address Line1",
"example": "1-2-33/4/5, Baker Street",
"type": "string"
},
"addressLine2": {
"description": "address Line2",
"example": "Opp. White House",
"type": "string"
},
"city": {
"description": "city",
"example": "Los Angeles",
"type": "string"
},
"countryId": {
"description": "country id",
"example": "0",
"type": "string"
},
"state": {
"description": "state",
"example": "ca",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "10011",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsCreateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressRefrence": {
"description": "Refrence of address",
"example": "A123456",
"type": "string"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsUpdateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"fundingId": {
"description": "ID of the funding created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressRefrence": {
"description": "Refrence of address",
"example": "A123456",
"type": "string"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedFundingDetailsResponse": {
"properties": {
"fundingId": {
"type": "string",
"description": "Specifies the ID of the funding",
"example": "F123"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"FundingDetailsResponse": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"fundingId": {
"description": "ID of the funding created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "ABC",
"type": "string"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "ABC",
"type": "string"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "FUND1",
"type": "string"
},
"payType": {
"description": "How the payment was to be done",
"example": "Cheque",
"type": "string"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressRefrence": {
"description": "Refrence of address",
"example": "A123456",
"type": "string"
},
"lastChangeUserid": {
"description": "ID of the lastchange user",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date and Time of the lastchange",
"example": "2020-09-05 10:08 08 800",
"type": "string",
"format": "date"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsResponses": {
"properties": {
"Funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
}
}
},
"LimitThings": {
"properties": {
"unadvisedLimit": {
"description": "Limit that unadvised",
"example": "$10000",
"type": "string"
},
"advisedLimit": {
"description": "Limit that advised",
"example": "$5000",
"type": "string"
},
"utilisedLimit": {
"description": "Already used limit",
"example": "$5000",
"type": "string"
},
"availableLimit": {
"description": "Limit that available",
"example": "$5000",
"type": "string"
},
"requestedAmount": {
"description": "Amount that requested",
"example": "$10000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"LimitsRequest": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": "Specifies the outstanding debt",
"example": "$5000",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"LimitsResponse": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": " Specifies the outstanding debt",
"example": "$50000",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"previousLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"modifiedDate": {
"description": "The date modify the Limit",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Limit",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedLimitResponse": {
"properties": {
"limitId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"FeeTypeOnGoing": {
"properties": {
"balanceType": {
"description": "DD field,Visible only If Percentage is selected in Percentage/Amount",
"example": "01",
"type": "string",
"x-referencetype": "FeeBalanceTypes"
},
"frequency": {
"description": "Fee Frequency",
"example": "05",
"type": "string",
"x-referencetype": "FeeFrequencyTypes"
},
"rateBasis": {
"description": "DD field, Visible only If Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"rateType": {
"description": "Default to Fixed, Visible only if Percentage is selected in Percentage/Amount",
"example": "fixed",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypeEvent": {
"properties": {
"feeBasis": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypeClosing": {
"properties": {
"feeBasis": {
"description": "feeBasisId",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "percentage",
"example": "48",
"type": "string"
},
"collection": {
"description": "DD field, collection",
"example": "12345678",
"type": "string"
},
"status": {
"description": "DD field, status",
"example": "01",
"type": "string",
"x-referencetype": "FeeStatus"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFeeRequest": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateFeeRequest": {
"properties": {
"feeId": {
"description": "unique id of the fee",
"example": "FEE202035269718",
"type": "string"
},
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeResponse": {
"properties": {
"feeId": {
"description": "Specifies id of the fees",
"example": "12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFeeRequest"
}
}
}
},
"UpdateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFeeRequest"
}
}
}
},
"FeesResponse": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
}
}
},
"ProcessedFeesResponse": {
"properties": {
"feesId": {
"description": "Unique identifier for fees",
"example": "FEE202035292905",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"StandardSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"FixedInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingIndex"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "12345",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "20",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "20",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "20",
"type": "string"
},
"rateLockDate": {
"description": "The rateLockDate",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "01",
"type": "string",
"x-referencetype": "PaymentFrequency"
},
"period": {
"description": "The period",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"currencyIdsArray": {
"properties": {
"currency": {
"description": "The restricted currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
}
}
},
"repricingFrequencyArray": {
"properties": {
"frequencyId": {
"description": "The repricingFrequency",
"example": "01",
"type": "string",
"x-referencetype": "RepricingFrequency"
}
}
},
"PeriodicInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingIndex"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "01",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "20",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "20",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "20",
"type": "string"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "01",
"type": "string",
"x-referencetype": "PaymentFrequency"
},
"period": {
"description": "The period",
"example": "Daily",
"type": "string"
},
"repricingPeriod": {
"description": "The repricing Frequency period",
"example": "Weekly",
"type": "string"
},
"rateIndex": {
"description": "The rateIndex",
"example": "01",
"type": "string"
},
"repricingFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/repricingFrequencyArray"
}
},
"interestCap": {
"description": "The interestCap",
"example": "30",
"type": "string"
},
"interestFloor": {
"description": "The interestFloor",
"example": "30",
"type": "string"
},
"capBasis": {
"description": "The capBasis",
"example": "Base rate",
"type": "string"
},
"floorBasis": {
"description": "The Floor basis",
"example": "Base rate",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "01",
"type": "string"
},
"roundingRule": {
"description": "The roundingRule",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FloatingInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingIndex"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "01",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "20",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "20",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "20",
"type": "string"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "01",
"type": "string",
"x-referencetype": "PaymentFrequency"
},
"lagPeriod": {
"description": "The lagPeriod",
"example": "01",
"type": "string"
},
"freezePeriod": {
"description": "The freezePeriod",
"example": "01",
"type": "string"
},
"rateIndex": {
"description": "The rateIndex",
"example": "01",
"type": "string"
},
"rateChangeMethod": {
"description": "The rateChangeMethod",
"example": "01",
"type": "string"
},
"interestCap": {
"description": "The interestCap",
"example": "30",
"type": "string"
},
"interestFloor": {
"description": "The interestFloor",
"example": "30",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "01",
"type": "string"
},
"roundingRule": {
"description": "The roundingRule",
"example": "01",
"type": "string"
},
"capBasis": {
"description": "The capBasis",
"example": "Base rate",
"type": "string"
},
"floorBasis": {
"description": "The capBasis",
"example": "Base rate",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PricingRequest": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"interestRateType": {
"description": "The type of interest",
"example": "01",
"type": "string",
"x-referencetype": "InterestType"
},
"fixedInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestRate"
}
]
},
"periodicInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/PeriodicInterestRate"
}
]
},
"floatingInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FloatingInterestRate"
}
]
},
"status": {
"description": "The status",
"example": "01",
"type": "string",
"x-referencetype": "PricingStatus"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"PricingResponse": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"interestRateType": {
"description": "The type of interest",
"example": "Fixed",
"type": "string"
},
"fixedInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestRate"
}
]
},
"periodicInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/PeriodicInterestRate"
}
]
},
"floatingInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FloatingInterestRate"
}
]
},
"status": {
"description": "The status",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"PricingRequests": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingRequest"
}
}
}
},
"PricingResponses": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
}
}
},
"ProcessedPricingResponse": {
"properties": {
"pricingId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedCreditDecisionResponse": {
"properties": {
"creditDecisionId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"conditionId": {
"description": "Unique Identifier",
"example": "CON12345",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedCovenantsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"covenantId": {
"description": "Unique identifier for covenant",
"example": "COV2345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"CovenantsRequest": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "C12345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string",
"x-referencetype": "CovenantType"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string",
"x-referencetype": "CovenantFrequency"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "CovenantStatus"
},
"operator": {
"description": "Operator of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "Operator"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "requirement",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "COV202012345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string"
},
"operator": {
"description": "Operator of the Covenant",
"example": "==",
"type": "string"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantsRequests": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsRequest"
}
}
}
},
"CovenantsResponses": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
}
}
},
"ConditionsInfo": {
"properties": {
"conditionId": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateConditionRequest": {
"properties": {
"conditionId": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"creditDecisionId": {
"description": "id of credit decision",
"example": "12345678",
"type": "string"
},
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditDecisionInfo": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"creditDecisionId": {
"description": "Unique identifier of the Credit decision",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string",
"x-referencetype": "Decision"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateCreditDecisionRequest": {
"properties": {
"creditDecisionId": {
"description": "Unique identifier of the CreditDecision",
"example": "123456",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string",
"x-referencetype": "Decision"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionsRequest": {
"properties": {
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"exceptionType": {
"description": "type of the exception",
"type": "string"
},
"description": {
"description": "Description of the exception",
"type": "string"
},
"status": {
"description": "The status of the exception",
"type": "string",
"x-referencetype": "PolicyExceptionStatus"
},
"comment": {
"description": "Policy exceptions comment",
"example": "comment",
"type": "string"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdatePolicyExceptionsRequest": {
"properties": {
"policyExceptionId": {
"description": "Unique identifier of the PolicyExceptions",
"example": "PE123456",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"exceptionType": {
"description": "type of the exception",
"type": "string"
},
"description": {
"description": "exception description",
"type": "string"
},
"status": {
"description": "The status of the exception",
"type": "string",
"x-referencetype": "PolicyExceptionStatus"
},
"comment": {
"description": "exception comment",
"example": "comment",
"type": "string"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
}
}
},
"UpdateCreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateCreditDecisionRequest"
}
}
}
},
"PolicyExceptionsList": {
"properties": {
"policyExceptionsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionsRequest"
}
}
}
},
"UpdatePolicyExceptionsList": {
"properties": {
"policyExceptionsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdatePolicyExceptionsRequest"
}
}
}
},
"UpdateConditionList": {
"properties": {
"conditionItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateConditionRequest"
}
}
}
},
"RequestOverViewResponse": {
"properties": {
"parentProcessId": {
"description": "Parent Process for Deal",
"example": "1",
"type": "string"
},
"requestOverView": {
"allOf": [
{
"$ref": "#/components/schemas/DealDetailsResponse"
}
]
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"borrowerFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"policyException": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionResponse"
}
},
"IntegrationService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
},
"ExternalServiceHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
},
"checklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"AdjustmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"facilityName": {
"description": "Name of the facility",
"example": "ABC ltd",
"type": "string"
},
"adjustedAmount": {
"description": "Adjusted Amount",
"example": "2 million",
"type": "string"
},
"adjustedCurrency": {
"description": "Adjusted Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedComment": {
"description": "adjusted comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalCommitmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"lenderName": {
"description": "Name of the lender",
"example": "Jhon",
"type": "string"
},
"commitmentAmount": {
"description": "commitment Amount",
"example": "2 million",
"type": "string"
},
"maturitydate": {
"description": "maturity Date",
"example": "2020-06-03",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureCommentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"comment": {
"description": "comment",
"example": "this exposure is pending",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureInfo": {
"properties": {
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"exposureUniqueId": {
"description": "Unique identifier of the Exposure",
"example": "P202035292905",
"type": "string"
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsInfo"
}
},
"externalCommitments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalCommitmentsInfo"
}
},
"exposureComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureCommentsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"exposureDate": {
"description": "Exposure Date",
"example": "2020-06-03",
"type": "string"
},
"exposureTime": {
"description": "Exposure Time",
"example": "02:22",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureList": {
"properties": {
"exposureItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
}
}
},
"FacilityOverViewResponse": {
"properties": {
"parentProcessId": {
"description": "Parent Process for Deal",
"example": "1",
"type": "string"
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"fees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"drawRestriction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
},
"compliance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"TasksParamsReferenceDataItems": {
"properties": {
"tasksParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksParamsItem"
}
},
"tasksInfo": {
"$ref": "#/components/schemas/TasksInfoItem"
}
}
},
"EntityOverViewResponse": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"Exposures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
},
"IntegrationService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
},
"ExternalServiceHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
}
}
},
"MessageList": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"MessagesList": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageList"
}
}
}
},
"CreateMessagesResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"GetMessageResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"userId": {
"description": "user Id",
"example": "12345",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"lastChangeDateTime": {
"description": "read flag",
"example": "true",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"GetMessagesResponse": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetMessageResponse"
}
}
}
},
"IntegrationServicesRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"integrationServicesId": {
"description": "Unique Identifier of IntegrationServices",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "01",
"type": "string",
"x-referencetype": "Provider"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "01",
"type": "string",
"x-referencetype": "ProviderType"
},
"accountNumber": {
"description": "Account Number",
"example": "abcd",
"type": "string"
},
"package1": {
"description": "Name of the first Package",
"example": "weekly package",
"type": "string"
},
"package2": {
"description": "Name of the second Package",
"example": "monthly package",
"type": "string"
},
"package3": {
"description": "Name of the third Package",
"example": "yearly package",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the Integration Service",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Integration Service was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"IntegrationServicesRequests": {
"properties": {
"integrationServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesRequest"
}
}
}
},
"IntegrationServicesResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"integrationServicesId": {
"description": "Unique Identifier of IntegrationServices",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "Airtel",
"type": "string"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "3g",
"type": "string"
},
"accountNumber": {
"description": "Account Number",
"example": "abcd",
"type": "string"
},
"package1": {
"description": "Name of the first Package",
"example": "weekly package",
"type": "string"
},
"package2": {
"description": "Name of the second Package",
"example": "monthly package",
"type": "string"
},
"package3": {
"description": "Name of the third Package",
"example": "yearly package",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the Integration Service",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Integration Service was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"IntegrationServicesResponses": {
"properties": {
"integrationServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
}
}
},
"ProcessedIntegrationServicesResponse": {
"properties": {
"integrationServicesId": {
"description": "Unique identifier for integrationServices",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"externalServicesHistoryId": {
"description": "Unique Identifier of externalServicesHistory",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "01",
"type": "string",
"x-referencetype": "Provider"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "01",
"type": "string",
"x-referencetype": "ProviderType"
},
"package1": {
"description": "Package of service",
"example": "monthly",
"type": "string"
},
"result": {
"description": "Link of external result",
"example": "www.result.com",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the externalServicesHistory",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the externalServicesHistoryId was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryRequests": {
"properties": {
"externalServicesHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequest"
}
}
}
},
"ExternalServicesHistoryRespose": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"externalServicesHistoryId": {
"description": "Unique Identifier of externalServicesHistory",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "Airtel",
"type": "string"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "3g",
"type": "string"
},
"package1": {
"description": "Package of service",
"example": "monthly",
"type": "string"
},
"result": {
"description": "Link of external result",
"example": "www.result.com",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the externalServicesHistory ",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the externalServicesHistory was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryResposes": {
"properties": {
"externalServicesHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
}
}
},
"ProcessedExternalServicesHistoryResponse": {
"properties": {
"externalServicesHistoryId": {
"description": "Unique identifier for externalServicesHistory",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRequestProcessRelation": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R123456",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F123456",
"type": "string"
},
"parentProcessId": {
"description": "unique identifier of parentProcess",
"example": "P123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRequestProcessRelations": {
"properties": {
"requestProcessRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRequestProcessRelation"
}
}
}
},
"RequestProcessRelationResponse": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R123456",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F123456",
"type": "string"
},
"parentProcessId": {
"description": "unique identifier of parentProcess",
"example": "P123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RequestProcessRelationResponses": {
"properties": {
"requestProcessRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestProcessRelationResponse"
}
}
}
}
}
}
}
,
dom_id: "#swagger-ui2",
presets: [
SwaggerUIBundle.presets.apis,
]
})
</script>
|
|
<html>
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui.css" />
<div id="swagger-ui3">Â </div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-bundle.js" type="text/javascript">
</script>
<script type="text/javascript">
const ui3 = SwaggerUIBundle({
spec:
{
"openapi": "3.0.0",
"servers": [
{
"description": "Locally Deployed Environment",
"url": "http://localhost:8600/ms-corporatelos-api/api/v1.0.0"
}
],
"info": {
"title": "Corporate LOS API",
"description": "This API enables you to programmatically access all data related to Corporate LOS that users has granted access.",
"version": "1.0.0",
"contact": {
"email": "mprasadambati@temenos.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/origination/corporate/deals": {
"post": {
"summary": "Creates a new Corporate Request",
"description": "Creates new Corporate Request record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "createCorporateDealV1",
"tags": [
"Request"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Creation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreationResponse"
}
}
}
},
"400": {
"description": "Deal Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the corporate requests record",
"description": "Retrieves corporate requests record based on the request Id, Deal Name, User Id.",
"operationId": "getCorporateDealsV1",
"tags": [
"Request"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestName",
"in": "query",
"description": "Request Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "count of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lineOfBusiness",
"in": "query",
"description": "lob of requests",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "All Deal Details Retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllDealDetailsResponse"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{requestId}": {
"put": {
"summary": "Updates an existing Corporate Request",
"description": "Update Corporate Deal record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "updateCorporateDealV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Request"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealUpdatedResponse"
}
}
}
},
"400": {
"description": "Deal Update Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete the record of corporate request",
"description": "Delete Corporate Request record for given requestId .",
"operationId": "deleteCorporateDealV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Request"
],
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Deal Delete Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}/facilities": {
"post": {
"summary": "Creates new facilities for a Deal",
"description": "Create Facility record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "createFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates already existing facilities for a Request",
"description": "Update Facility record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "updateFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/{facilityId}": {
"delete": {
"summary": "Delete facilitie",
"description": "Delete Facility record based on facilityId.",
"operationId": "deleteFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility": {
"get": {
"summary": "Retrieves the Facility record",
"description": "Retrieves the Facility record based on the Request Id, Facility Id, Party Id and Facility Name .",
"operationId": "getFacilityV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityName",
"in": "query",
"description": "Facility Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Facility"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/financialResult": {
"post": {
"summary": "Create Financial Result",
"description": "Create the Financial Result with the provided data.",
"operationId": "createFinancialResultV1",
"tags": [
"FinancialResult"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultListRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Financial Result with the given financialResultId",
"description": "Update the Financial Result with the provided data.",
"operationId": "updateFinancialResultV1",
"tags": [
"FinancialResult"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFinancialResultListRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Financial Result details to the given financialResultId/partyId",
"description": "Retrieve the Financial Result records based on financialResultId/partyId.",
"operationId": "getFinancialResultV1",
"tags": [
"FinancialResult"
],
"parameters": [
{
"name": "financialResultId",
"in": "query",
"description": "Financial Result Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialResultsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/financialResult/{financialResultId}": {
"delete": {
"tags": [
"FinancialResult"
],
"summary": "soft delete the Financial Result",
"description": "Financial Result record with the provided financialResultId, will be deleted softly.",
"operationId": "deleteFinancialResultV1",
"parameters": [
{
"name": "financialResultId",
"in": "path",
"description": "ID of Financial Result to be deleted",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties": {
"post": {
"summary": "Create a relationship to the given Party id with the facility owner",
"description": "Create RelatedPartie record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "createRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the relationship to the given party id with the facilty owner",
"description": "Update RelatedPartie record with the provided data such as requestId, facilityId and partyId etc.",
"operationId": "updateRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the relatedParty record",
"description": "Retrieves the relatedParty record based on facilityId, relatedPartyId, partyId and requestId.",
"operationId": "getRelatedPartiesV1",
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatedPartyId",
"in": "query",
"description": "Related Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/connectedParties": {
"get": {
"summary": "Retrieves the connected Parties",
"description": "Retrieves the relatedParty record based on partyIds if they are related.",
"operationId": "getDealRelatedPartiesV1",
"parameters": [
{
"name": "party1",
"in": "query",
"description": "first party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "party2",
"in": "query",
"description": "second Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties/{rowId}": {
"delete": {
"tags": [
"Related Parties"
],
"summary": "soft delete the related parties",
"description": "related partyies record with the provided rowId, will be deleted softly.",
"operationId": "deleteRelatedPartiesV1",
"parameters": [
{
"name": "rowId",
"in": "path",
"description": "ID of row for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks/{indicator}": {
"post": {
"summary": "Creates tasks for a Deal",
"description": "Create Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "createTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "indicator",
"in": "path",
"description": "indicator",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks": {
"put": {
"summary": "Updates the Task record",
"description": "Update Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "updateTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks": {
"get": {
"summary": "Retrieves the details of tasks for the provided criteria",
"description": "Retrieves Task record based on dealId, partyId and Facility Id etc.",
"operationId": "getTasksV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "assignUserId",
"in": "query",
"description": "Assigned User Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "task status",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"in": "query",
"description": "task stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks/{taskId}": {
"delete": {
"summary": "Delete the task record",
"description": "Delete Task record based on taskId.",
"operationId": "deleteTasksV1",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "task Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "partyId",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals": {
"post": {
"tags": [
"Collateral"
],
"summary": "Add a new collateral to the party",
"description": "Create collateral record with the provided data",
"operationId": "createCollateralV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Collateral"
],
"summary": "Update the collateral associated to the Party",
"description": "Update collateral record with the provided data for a Party",
"operationId": "updateCollateralV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Collateral"
],
"summary": "Fetch the collaterals associated to the Request/Facility/Party/Collateral",
"description": "Retrieves the collateral records based on RequestId, facilityId, partyId and collateralId.",
"operationId": "getCollateralV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "DealId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "PartyId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals/{collateralId}": {
"delete": {
"tags": [
"Collateral"
],
"summary": "soft delete the collateral",
"description": "collateral record with the provided collateralId, will be deleted softly.",
"operationId": "deleteCollateralV1",
"parameters": [
{
"name": "collateralId",
"in": "path",
"description": "unique ID of collateral for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collateralRelationships": {
"put": {
"tags": [
"Collateral"
],
"summary": "Map a collateral to the Request/Facility",
"description": "Delete existing collateral relationship and create new record with the provided data such as collateralId,requestId, facilityId.",
"operationId": "updateCollateralRelationshipV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRelationshipRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Collateral"
],
"summary": "Fetch the collateral Relationships associated to the Request/Facility/Collateral",
"description": "Delete the collateral Relationship records based on requestId, facilityId and collateralId.",
"operationId": "deleteCollateralRelationshipsV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "RequestId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents": {
"post": {
"summary": "creates new documents and adds them to deal",
"description": "Create document records with the provided data such as requestId, facilityId and document name etc.",
"operationId": "createDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCreationRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "updates the existing documents data",
"description": "Update document records with the provided data such as requestId, facilityId and document name etc.",
"operationId": "updateDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of documents for the provided criteria",
"description": "Retrieve the document records based on dealId, facilityId and partyId.",
"operationId": "getDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "Collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents/{documentId}": {
"delete": {
"tags": [
"Documents"
],
"summary": "soft delete the document",
"description": "Document record with the provided documentId,requestId,facilityId will be deleted softly.",
"operationId": "deletedocumentV1",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "ID of Document for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives": {
"post": {
"summary": "Create narrative and add to deal",
"description": "Create narrative records with the provided data such as dealId, facilityId , partyId and categoryId etc.",
"operationId": "createNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update narrative",
"description": "Update narrative records with the provided data such as dealId, facilityId, partyId and categoryId etc.",
"operationId": "updateNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Narrative records",
"description": "Retrieves the Narrative records based on dealId, facilityId and partyId.",
"operationId": "getNarrativesV1",
"tags": [
"Narratives"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "Collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives/{narrativeId}": {
"delete": {
"tags": [
"Narratives"
],
"summary": "soft delete the narrative",
"description": "narrative record with the provided narrativeId, will be deleted softly.",
"operationId": "deleteNarrativeV1",
"parameters": [
{
"name": "narrativeId",
"in": "path",
"description": "ID of narrative for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "ID of Request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of Facility",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/narratives": {
"put": {
"tags": [
"Narratives"
],
"summary": "Update narratives from Facility Overview",
"description": "Update narrative records with the provided data such as facilityId, category,userId etc.",
"operationId": "updateNarrativesFromFOV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/reference/{referenceId}": {
"get": {
"summary": "gets the reference data from reference tables",
"description": "Retrieves the reference data based on the referenceId.",
"operationId": "getRefData",
"tags": [
"Reference Data"
],
"parameters": [
{
"name": "referenceId",
"in": "path",
"description": "Reference Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerRequest": {
"post": {
"summary": "Stores the captured information of the request submission form",
"description": "Create customerRequest records with the provided data such as userId, requestId and customerInformation etc.",
"operationId": "createCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete the captured information of the request submission form",
"description": "Delete customerRequest records with the provided data such as userId, requestId etc.",
"operationId": "deleteCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get all the information associated to the userid and requestid",
"description": "Retrieves customerRequest records based on userId, requestId and status.",
"operationId": "getCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "status",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestsInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions": {
"post": {
"summary": "Creates draw restrictions for a particular deal",
"description": "Create drawRestriction records with the provided data such as requestId, facilityId and restrictionType etc.",
"operationId": "createDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Draw restrictions against a deal",
"description": "Update drawRestriction records with the provided data such as requestId, facilityId and restrictionType etc.",
"operationId": "updateDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of draw restrictions against request or facility",
"description": "Retrieves drawRestriction records based on requestId, facilityId.",
"operationId": "getDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions/{drawRestrictionId}": {
"delete": {
"tags": [
"Draw Restrictions"
],
"summary": "soft delete the Draw Restrictions",
"description": "Draw Restrictions record with the provided drawRestrictionId, will be deleted softly.",
"operationId": "deleteDrawRestrictionV1",
"parameters": [
{
"name": "drawRestrictionId",
"in": "path",
"description": "ID of Draw Restrictions for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of Facility",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance": {
"get": {
"summary": "Retrieves the details of the compliance for the provided criteria",
"description": "Retrieves the compliance records based on requestId, facilityId,partyId and complianceId.",
"operationId": "getComplianceV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "complianceId",
"in": "query",
"description": "complaince Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Compliance"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Compliance"
],
"summary": "Add a new compliance to the Deal",
"description": "Create the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "createComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Compliance"
],
"summary": "Update compliance to the Deal",
"description": "Update the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "updateComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance/{complianceId}": {
"delete": {
"tags": [
"Compliance"
],
"summary": "soft delete the compliance",
"description": "Compliance record with the provided complianceId, will be deleted softly.",
"operationId": "deleteComplianceV1",
"parameters": [
{
"name": "complianceId",
"in": "path",
"description": "ID of Compliance for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails": {
"post": {
"summary": "Create funding details",
"description": "Create the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "createFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update fundings Details",
"description": "Update the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "updateFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Funding details",
"description": "Retrieves the funding records based on dealId, facilityId and fundingId.",
"operationId": "getFundingDetailsV1",
"tags": [
"Funding"
],
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fundingId",
"in": "query",
"description": "Funding Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "addressRefrence",
"in": "query",
"description": "refrence of address",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails/{fundingId}": {
"delete": {
"tags": [
"Funding"
],
"summary": "soft delete the fundings",
"description": "Fundings record with the provided fundingId, will be deleted softly.",
"operationId": "deleteFundingV1",
"parameters": [
{
"name": "fundingId",
"in": "path",
"description": "ID of funding for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits": {
"post": {
"summary": "Create limit records",
"description": "Create the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "createLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Limit details to the given limit id",
"description": "Update the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "updateLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieve the Limit record",
"description": "Retrieve the Limit record based on limitId.",
"operationId": "getLimitsV1",
"tags": [
"Limits"
],
"parameters": [
{
"name": "limitId",
"in": "query",
"description": "limit Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits/{limitId}": {
"delete": {
"tags": [
"Limits"
],
"summary": "soft delete the limits",
"description": "Limits record with the provided limitId, will be deleted softly.",
"operationId": "deleteLimitsV1",
"parameters": [
{
"name": "limitId",
"in": "path",
"description": "ID of limit for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees": {
"post": {
"summary": "create Fee details to the given facility/deal",
"description": "Create the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "createFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Fee details to the given id",
"description": "Update the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "updateFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Fee details to the given facility id/deal id",
"description": "Retrieve the Fee records based on dealId, facilityId, feeType.",
"operationId": "getFeesV1",
"tags": [
"Fees"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees/{feeId}": {
"delete": {
"tags": [
"Fees"
],
"summary": "soft delete the fees",
"description": "fees record with the provided feeId, will be deleted softly.",
"operationId": "deleteFeesV1",
"parameters": [
{
"name": "feeId",
"in": "path",
"description": "ID of fees for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings": {
"post": {
"summary": "create Pricing details to the given deal/facility",
"description": "Create the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "createPricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Pricing details to the given Pricing id",
"description": "Update the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "updatePricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Pricing details to the given facility id",
"description": "Retrieve the Pricing records based on dealId, facilityId.",
"operationId": "getPricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "deal Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings/{pricingId}": {
"delete": {
"summary": "delete Pricing details to the given pricing id",
"description": "Delete the Pricing records based on pricing Id.",
"operationId": "deletePricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "pricingId",
"in": "path",
"description": "pricing Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants": {
"post": {
"summary": "Creates covenants for a Deal",
"description": "Create the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "createCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Covenants for a Deal",
"description": "Update the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the details of covenants for the provided criteria",
"description": "Retrieve the Covenant records based on dealId, facilityId, partyId and covenantId.",
"operationId": "getCovenantsV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "covenantId",
"in": "query",
"description": "covenant Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants/{covenantId}": {
"delete": {
"summary": "Delete the covenant record.",
"description": "Delete the covenant record based on covenantId.",
"operationId": "deleteCovenantsV1",
"parameters": [
{
"name": "covenantId",
"in": "path",
"description": "covenant Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/covenants": {
"put": {
"summary": "Update the covenant record from Facility overview.",
"description": "Update the Covenant records From FO with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsFromFOV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions": {
"post": {
"summary": "create credit decisions to the given facility",
"description": "Create the creditDecision records with the provided data such as requestId, facilityId and decisionDate etc.",
"operationId": "createCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditDecisionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update credit decisions to the given creditDecision id",
"description": "Update the creditDecision records with the provided data such as requestId, facilityId and decisionDate etc.",
"operationId": "updateCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDecisionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given facility",
"description": "Retrieve the creditDecision records based on requestId,facilityId and decisionId.",
"operationId": "getCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "decisionId",
"in": "query",
"description": "decision Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions/{creditDecisionId}": {
"delete": {
"summary": "Delete credit decisions to the given creditDecision id",
"description": "Delete the creditDecision record to given creditDecision id.",
"operationId": "deleteCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "creditDecisionId",
"in": "path",
"description": "creditDecision Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/policyExceptions": {
"post": {
"summary": "create policy exceptions to the given facility",
"description": "Create the policyExceptions records with the provided data such as requestId, facilityId and exceptionType etc.",
"operationId": "createPolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExceptionsList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPolicyResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the policy exception to the given facility",
"description": "Retrieve the policy exception records based on facilityId and policyExceptionId.",
"operationId": "getPolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExceptionResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update policy exceptions to the given policyException id",
"description": "Update the PolicyExceptions records with the provided data such as requestId, facilityId and exceptionType etc.",
"operationId": "updatePolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePolicyExceptionsList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPolicyResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/policyExceptions/{policyExceptionId}": {
"delete": {
"summary": "Delete policy exceptions to the given policy id",
"description": "Delete the policy exceptions record to given policy id.",
"operationId": "deletePolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"parameters": [
{
"name": "policyExceptionId",
"in": "path",
"description": "policyException Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/conditions": {
"put": {
"summary": "update condition the given condition id",
"description": "Update the condition records with the provided data such as conditionId, creditDecisionId and etc.",
"operationId": "updateConditionV1",
"tags": [
"Conditions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConditionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedConditionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/conditions/{conditionId}": {
"delete": {
"summary": "Delete the condition for given condition id",
"description": "Delete the condition records with the provided conditionId.",
"operationId": "deleteConditionV1",
"tags": [
"Conditions"
],
"parameters": [
{
"name": "conditionId",
"in": "path",
"description": "Condition Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}": {
"get": {
"summary": "Retrieves the requestOverview details",
"description": "Retrieves the requestOverview details based on requestId.",
"operationId": "getRequestOverviewV1",
"tags": [
"RequestOverView"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure": {
"post": {
"summary": "Create Exposure records",
"description": "Create the Exposure records with the provided data such as partyId, exposureType and exposureUniqueId etc.",
"operationId": "createExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureType",
"in": "query",
"description": "exposureType",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given party",
"description": "Retrieve the exposure records based on partyId and exposureUniqueId.",
"operationId": "getExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/{facilityId}": {
"get": {
"summary": "Retrieves FacilityOverview details",
"description": "Retrieves FacilityOverview details based on facilityId.",
"operationId": "getFacilityOverviewV1",
"tags": [
"FacilityOverview"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasksparams": {
"get": {
"summary": "Retrieves the data related to tasks params",
"description": "Retrieves the task records based on taskStage and taskId.",
"operationId": "getTasksParamsV1",
"tags": [
"TasksParams"
],
"parameters": [
{
"name": "taskStage",
"in": "query",
"description": "Task Stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task ID",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksParamsReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/{partyId}": {
"get": {
"summary": "Retrieves PartyOverview details",
"description": "Retrieves PartyOverview details based on partyId.",
"operationId": "getEntityOverviewV1",
"tags": [
"EntityOverview"
],
"parameters": [
{
"name": "partyId",
"in": "path",
"description": "party Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message/{userId}": {
"post": {
"summary": "creates the messages to the dealId",
"description": "Create the messages records with the provided data such as userId, dealId and messagedescription etc.",
"operationId": "createMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessagesList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message": {
"get": {
"summary": "Retrieve the message records",
"description": "Retrieve the message records based on userId and messageId.",
"operationId": "getMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "messageId",
"in": "query",
"description": "message Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/integrationServices": {
"get": {
"summary": "Retrieves the details of the integrationServices for the provided criteria",
"description": "Retrieves the integrationServices records based on requestId, facilityId,partyId and integrationServicesId.",
"operationId": "getIntegrationServicesV1",
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "integrationServicesId",
"in": "query",
"description": "integrationServices Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"IntegrationServices"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"IntegrationServices"
],
"summary": "Add a new integrationServices to the facility or party",
"description": "Create the integrationService records with the provided data.",
"operationId": "createIntegrationServicesV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedIntegrationServicesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"IntegrationServices"
],
"summary": "Update IntegrationServices to the facility or party",
"description": "Update the integrationService records with the provided data.",
"operationId": "updateIntegrationServicesV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedIntegrationServicesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/integrationServices/{integrationServicesId}": {
"delete": {
"tags": [
"IntegrationServices"
],
"summary": "soft delete the integrationServices",
"description": "IntegrationServices record with the provided integrationServicesId, will be deleted softly.",
"operationId": "deleteIntegrationServicesV1",
"parameters": [
{
"name": "integrationServicesId",
"in": "path",
"description": "ID of IntegrationServices for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/externalServicesHistory": {
"get": {
"summary": "Retrieves the details of the externalServicesHistory for the provided criteria",
"description": "Retrieves the externalServicesHistory records based on requestId, facilityId,partyId and externalServicesHistoryId.",
"operationId": "getExternalServicesHistoryV1",
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "externalServicesHistoryId",
"in": "query",
"description": "externalServicesHistory Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"ExternalServicesHistory"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryResposes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"ExternalServicesHistory"
],
"summary": "Add a new externalServicesHistory to the request",
"description": "Create the externalServicesHistory records with the provided data.",
"operationId": "createExternalServicesHistoryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedExternalServicesHistoryResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"ExternalServicesHistory"
],
"summary": "Update externalServicesHistory to the facility or party",
"description": "Update the externalServicesHistory records with the provided data.",
"operationId": "updateExternalServicesHistoryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedExternalServicesHistoryResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/externalServicesHistory/{externalServicesHistoryId}": {
"delete": {
"tags": [
"ExternalServicesHistory"
],
"summary": "soft delete the externalServicesHistory",
"description": "ExternalServicesHistory record with the provided externalServicesHistoryId, will be deleted softly.",
"operationId": "deleteExternalServicesHistoryV1",
"parameters": [
{
"name": "externalServicesHistoryId",
"in": "path",
"description": "ID of externalServicesHistory for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requestProcessRelation": {
"post": {
"summary": "Creates a new Request Process relationship",
"description": "Creates new requestProcessRelation record with the provided data such as facilityId, parenProcessId and requestId etc.",
"operationId": "createRequestProcessRelationV1",
"tags": [
"RequestProcessRelationship"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestProcessRelations"
}
}
}
},
"responses": {
"200": {
"description": "Create RequestProcessRelation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "RequestProcessRelation Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Request Process relationship",
"description": "Retrieves Request Process relationship record based on the request Id,facility Id, parenProcess Id.",
"operationId": "getRequestProcessRelationV1",
"tags": [
"RequestProcessRelationship"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "parenProcessId",
"in": "query",
"description": "parenProcess Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "RequestProcessRelation retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestProcessRelationResponses"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilityApproverInfo": {
"post": {
"summary": "Creates the Facility Approver Info",
"description": "Creates facility approver info with the provided data such as requestId, facilityId, committeeId and approverUserId etc.",
"operationId": "createFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFacilityApproversInfo"
}
}
}
},
"responses": {
"200": {
"description": "Create FacilityApproverInfo Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityApproverInfoResponse"
}
}
}
},
"400": {
"description": "FacilityApproverInfo Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Facility Approver Info",
"description": "Retrieves facility approver info based on the requestId,facilityId, committeeId",
"operationId": "getFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "FacilityApproverInfo retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityApproversInfo"
}
}
}
},
"400": {
"description": "FacilityApproverInfo Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Facility Approver Info",
"description": "Update the Facility Approver Info with the provided data",
"operationId": "updateFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityApproversInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityApproverInfoResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilityApproverInfo/{rowId}": {
"delete": {
"summary": "Delete the Facility Approver Info",
"description": "facilityApproverInfo will be deleted with the provided rowId",
"operationId": "deleteFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"parameters": [
{
"name": "rowId",
"in": "path",
"description": "ID of row for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditCommitteeInfo": {
"post": {
"summary": "Creates the Credit Committee Info",
"description": "Creates credit Committee info with the provided data",
"operationId": "createCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeRequests"
}
}
}
},
"responses": {
"200": {
"description": "Create CreditCommitteeInfo Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditCommitteeResponse"
}
}
}
},
"400": {
"description": "Credit Committee Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Credit Committee Info",
"description": "Retrieves credit Committee info",
"operationId": "getCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"parameters": [
{
"name": "committeeId",
"in": "query",
"description": "Committee Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "committeeName",
"in": "query",
"description": "Committee Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "CreditCommiteeInfo retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeResponses"
}
}
}
},
"400": {
"description": "CreditCommitteeInfo Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Credit Committee Info",
"description": "Update the Credit Committee Info with the provided data",
"operationId": "updateCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditCommitteeResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditCommitteeInfo/{committeeId}": {
"delete": {
"summary": "Delete the Credit Committee Info",
"description": "creditCommittee will be deleted with the provided committeeId",
"operationId": "deleteCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"parameters": [
{
"name": "committeeId",
"in": "path",
"description": "ID of Committee for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/renewal": {
"post": {
"summary": "Update PartyId in all LOS tables",
"description": "parties renewal will update the valid partyId in all LOS tables for the request",
"operationId": "partyRenewV1",
"tags": [
"PartyUpdate"
],
"parameters": [
{
"name": "nonVerifiedPartyId",
"in": "query",
"description": "ID before party was verified",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verifiedPartyId",
"in": "query",
"description": "ID after party was verified",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Id of the request",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"FailureMessage": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"StandardErrorResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailureMessage"
}
},
"ProcessedFacilityResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityCreateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "01",
"type": "string"
},
"facilityId": {
"description": "Temperory id of the facility from onboarding",
"example": "T1234567",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security coverage",
"example": "2356789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string",
"x-referencetype": "ApprovalStatus"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization unit Id",
"example": "20",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"extensionData": {
"type": "object"
}
}
},
"FacilityUpdateRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "03",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security Coverage",
"example": "2356789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "01",
"type": "string",
"x-referencetype": "AcceptanceStatus"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string",
"x-referencetype": "ApprovalStatus"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"extensionData": {
"type": "object"
}
}
},
"FacilityResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "Line of Credit",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "Working Capital",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "Awaiting Approval",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security Coverage",
"example": "3456789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "Approved",
"type": "string"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"extensionData": {
"type": "object"
}
}
},
"FacilityCreateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
}
}
},
"FacilityUpdateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityUpdateRequest"
}
}
}
},
"FacilityResponses": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"RelatedPartiesSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
},
"rowId": {
"description": "Specifies RowId of the request",
"example": "R1234,R1290",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRelatedPartiesRequest": {
"properties": {
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateRelatedPartiesRequest": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "D202012345678",
"type": "string"
},
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related Party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RelatedPartiesResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "12345678",
"type": "string"
},
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "Guarantor",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "Amount",
"type": "string"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
}
}
},
"UpdateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequest"
}
}
}
},
"RelatedPartiesResponses": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
}
}
},
"ProcessedTasksResponse": {
"properties": {
"taskId": {
"description": "Unique identifier for Task",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"NoteItem": {
"properties": {
"noteDescription": {
"description": "description notes",
"example": "task notes",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"TasksRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskProvider"
},
"taskPackage": {
"description": "Package of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPackage"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskCategory"
},
"taskType": {
"description": "Type of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskType"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPriority"
},
"extensionData": {
"type": "object"
}
}
},
"TasksResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "Moody's",
"type": "string"
},
"taskPackage": {
"description": "Package of the task",
"example": "Fraud-Check",
"type": "string"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "Prescreening",
"type": "string"
},
"taskType": {
"description": "Type of the task",
"example": "Auto",
"type": "string"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "In-Process",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "medium",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"TasksRequests": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksRequest"
}
}
}
},
"TasksResponses": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"CollateralOverview": {
"properties": {
"collateralId": {
"description": "unique Identifier of collateral",
"example": "C123",
"type": "string"
},
"collateralName": {
"description": "Name of the collateral",
"example": "property",
"type": "string"
},
"collateralType": {
"description": "type of collateral",
"example": "01",
"type": "string"
},
"collateralSubType": {
"description": "subtype of collateral",
"example": "001",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of collateral",
"example": "5",
"type": "string"
},
"collateralStatus": {
"description": "status of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralStatus"
},
"advancedRate": {
"description": "advanced rate of collateral",
"example": "30",
"type": "string"
},
"salvageCurrency": {
"description": "currency ofsalvage value",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"salvageValue": {
"description": "salvage value of collateral",
"example": "30",
"type": "string"
},
"owner": {
"description": "owner of collateral",
"example": "abc",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of collateral",
"example": "abc",
"type": "string"
},
"additionalOwners": {
"description": "additional owners of collateral",
"example": "abc",
"type": "string"
},
"adjustedCollateralCurrency": {
"description": "currency value of the adjusted collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedCollateralValue": {
"description": "adjusted value of the collateral",
"example": "property",
"type": "string"
},
"isInsuranceRequired": {
"description": "insurance required for the collateral",
"example": "yes",
"type": "string"
}
}
},
"CollateralDetail": {
"properties": {
"description": {
"description": "description of collateral",
"example": "vehicle",
"type": "string"
},
"usage": {
"description": "usage of the collateral",
"example": "01",
"type": "string"
},
"usageRestriction": {
"description": "usageRestriction of collateral",
"example": "01",
"type": "string"
},
"usageDetails": {
"description": "usageDetails of the collateral",
"example": "property",
"type": "string"
},
"propertyType": {
"description": "property Type of collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralPropertyType"
},
"propertyStatus": {
"description": "property status of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralPropertyStatus"
},
"yearsOfConstruction": {
"description": "years of construction for the collateral",
"example": "3",
"type": "string"
},
"size": {
"description": "size of the collateral",
"example": "30sqft",
"type": "string"
},
"builtUpArea": {
"description": "built up area of the collateral",
"example": "200sqft",
"type": "string"
},
"underLease": {
"description": "is the collateral under lease",
"example": "yes",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of the collateral",
"example": "xyz",
"type": "string"
},
"plan": {
"description": "plan of the collateral",
"example": "xyz",
"type": "string"
},
"section": {
"description": "section of the collateral",
"example": "abc",
"type": "string"
},
"plotNo": {
"description": "plot no of the collateral",
"example": "34",
"type": "string"
},
"registrationDate": {
"description": "registration date of the collateral",
"example": "04-04-2020",
"type": "string"
},
"landRegistryNumber": {
"description": "registration Number of the land",
"example": "12345",
"type": "string"
},
"landRegistryDistrict": {
"description": "registration Number of the land",
"example": "medak",
"type": "string"
},
"mortgageRegistrationNumber": {
"description": "registration number of mortgage",
"example": "1234",
"type": "string"
},
"mortgageRegistrationDate": {
"description": "registration date of mortgage",
"example": "04-04-2020",
"type": "string"
},
"mortgageRank": {
"description": "rank of mortgage",
"example": "first",
"type": "string"
},
"pariPassu": {
"description": "pariPassu detail of the collateral",
"example": "abc",
"type": "string"
},
"pariPassuPercentage": {
"description": "pariPassu detail of the collateral",
"example": "50",
"type": "string"
},
"occupancy": {
"description": "occupancy detail of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralOccupancy"
},
"country": {
"description": "country of the collateral",
"example": "India",
"type": "string"
},
"city": {
"description": "city of the collateral",
"example": "hyderabad",
"type": "string"
},
"state": {
"description": "state of the collateral",
"example": "Telangana",
"type": "string"
},
"address1": {
"description": "address1 of the collateral",
"example": "first street",
"type": "string"
},
"address2": {
"description": "address2 of the collateral",
"example": "second street",
"type": "string"
},
"postalCode": {
"description": "postalCode of the collateral",
"example": "200010",
"type": "string"
},
"newOrUsed": {
"description": "new or used collateral",
"example": "new",
"type": "string"
},
"year": {
"description": "year of manufacture",
"example": "3",
"type": "string"
},
"manufacturer": {
"description": "manufacturer of the collateral",
"example": "philips",
"type": "string"
},
"make": {
"description": "make of the collateral",
"example": "make",
"type": "string"
},
"usefulLife": {
"description": "usefulLife of the collateral",
"example": "3",
"type": "string"
},
"model": {
"description": "model of the collateral",
"example": "Z125",
"type": "string"
},
"issuerName": {
"description": "issuer name of the collateral",
"example": "200010",
"type": "string"
},
"documentNumber": {
"description": "document number of the collateral",
"example": "PAWD123",
"type": "string"
},
"dateOfIssue": {
"description": "date of issue of the collateral document",
"example": "02-02-2020",
"type": "string"
},
"placeOfIssue": {
"description": "place of Issue of the collateral",
"example": "hyderabad",
"type": "string"
},
"expiryDate": {
"description": "expiry date of the document of the collateral",
"example": "200010",
"type": "string"
},
"securityName": {
"description": "name of the security of the collateral",
"example": "abc",
"type": "string"
},
"securityId": {
"description": "security Id of the collateral",
"example": "Z125",
"type": "string"
},
"isincusip": {
"description": "isin/cusip of the collateral",
"example": "I234",
"type": "string"
},
"quantity": {
"description": "quantity of the collateral",
"example": "half",
"type": "string"
},
"costPriceCurrency": {
"description": "currency value of the costPrice collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"costPrice": {
"description": "cost Price of the collateral",
"example": "60000",
"type": "string"
},
"industry": {
"description": "industry of the collateral",
"example": "motor",
"type": "string"
},
"insuredCustomer": {
"description": "insured customer of the collateral",
"example": "abc",
"type": "string"
},
"chassisNumber": {
"description": "chassisNumber of the vehicle",
"example": "C123",
"type": "string"
},
"engineNumber": {
"description": "engineNumber of the vehicle",
"example": "E1234",
"type": "string"
},
"policyNumber": {
"description": "policy number of the collateral",
"example": "P1234",
"type": "string"
},
"insuredPremiumAmountCurrency": {
"description": "currency value of the insuredPremiumAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"insuredPremiumAmount": {
"description": "insured premium amount of the collateral",
"example": "60000",
"type": "string"
},
"accountNumber": {
"description": "account Number",
"example": "HDFC123",
"type": "string"
},
"bankName": {
"description": "bank name",
"example": "HDFC",
"type": "string"
},
"currentInterestRate": {
"description": "current interest rate",
"example": "10",
"type": "string"
},
"openingDate": {
"description": "opening date",
"example": "04-04-2020",
"type": "string"
},
"interestRateAsOf": {
"description": "interest rate as of",
"example": "10",
"type": "string"
},
"maturityDate": {
"description": "maturity date of the collateral",
"example": "04-04-2020",
"type": "string"
},
"contractStartDate": {
"description": "contract start date",
"example": "10-10-2020",
"type": "string"
},
"contractExpiryDate": {
"description": "contract expiry date",
"example": "04-04-2020",
"type": "string"
},
"stockType": {
"description": "type of stock",
"example": "new",
"type": "string"
},
"stockQuantity": {
"description": "quantity Of stock",
"example": "100 kg",
"type": "string"
},
"debtorOutstandingCurrency": {
"description": "currency value of the debtorOutstanding collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"debtorOutstanding": {
"description": "outStanding from debtors",
"example": "10000000",
"type": "string"
},
"creditorOutstandingCurrency": {
"description": "currency value of the creditorOutstanding collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"creditorOutstanding": {
"description": "outstanding from creditor",
"example": "049020",
"type": "string"
}
}
},
"CollateralDueDiligence": {
"properties": {
"nextValuationDate": {
"description": "next valuation date",
"example": "04-04-2020",
"type": "string"
},
"insuranceCompany": {
"description": "insurance company",
"example": "LIC",
"type": "string"
},
"requiredCoverage": {
"description": "required coverage",
"example": "02",
"type": "string",
"x-referencetype": "CollateralRequiredCoverage"
},
"agentName": {
"description": "name of the agent",
"example": "xyz",
"type": "string"
},
"policyNumber": {
"description": "policy number",
"example": "P1234",
"type": "string"
},
"coverageAmountCurrency": {
"description": "currency value of the coverageAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"coverageAmount": {
"description": "amount of coverage",
"example": "400000",
"type": "string"
},
"agentPhone": {
"description": "phone number of agent",
"example": "04042020",
"type": "string"
},
"policyType": {
"description": "policy type",
"example": "LIC",
"type": "string"
},
"deductableAmountCurrency": {
"description": "currency value of the coverageAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"deductableAmount": {
"description": "deductable amount",
"example": "5000000",
"type": "string"
},
"agentEmail": {
"description": "email of the agent",
"example": "xyz@temenos.com",
"type": "string"
},
"expirationDate": {
"description": "expiration date",
"example": "04-04-2020",
"type": "string"
},
"additionalInsured": {
"description": "additionalInsured",
"example": "yes",
"type": "string"
},
"registration": {
"description": "registration",
"example": "LIC",
"type": "string"
},
"registrationLocation": {
"description": "registration Location",
"example": "hyderabad",
"type": "string"
},
"registrationExpiryDate": {
"description": "registrationexpiryDate",
"example": "02-02-2020",
"type": "string"
},
"liabiltyCoverageAmount": {
"description": "coverage amount of liability",
"example": "04042020",
"type": "string"
},
"personalInjuryCoverageAmount": {
"description": "coverage amount of personal injury",
"example": "1000000",
"type": "string"
},
"collisionCoverageAmount": {
"description": "coverage amount of collision",
"example": "1000000",
"type": "string"
},
"valuations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueRequest"
}
},
"otherDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OtherDueDiligenceRequest"
}
}
}
},
"ValueRequest": {
"properties": {
"valuationDate": {
"description": "date of report",
"example": "04-04-2020",
"type": "string"
},
"valuationValueCurrency": {
"description": "currency value of the valuationValue collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"valuationValue": {
"description": "value",
"example": "100000",
"type": "string"
},
"valuationSource": {
"description": "source of report",
"example": "ABC corporation",
"type": "string"
},
"valuationDocumentId": {
"description": "Id of the report",
"example": "R1234",
"type": "string"
},
"valuationDocumentName": {
"description": "Name of the report",
"example": "Audit",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"OtherDueDiligenceRequest": {
"properties": {
"dueDelligencedate": {
"description": "date of report",
"example": "04-04-2020",
"type": "string"
},
"dueDelligenceType": {
"description": "type",
"example": "01",
"type": "string",
"x-referencetype": "CollateralTypeDueDiligence"
},
"dueDelligenceStatus": {
"description": "status of report",
"example": "ABC corporation",
"type": "string",
"x-referencetype": "CollateralStatusDueDiligence"
},
"dueDelligenceDocumentId": {
"description": "Id of the report",
"example": "R1234",
"type": "string"
},
"dueDelligenceDocumentName": {
"description": "Name of the report",
"example": "Audit",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRequest": {
"properties": {
"comments": {
"description": "comments on Collateral",
"example": "this property is shared",
"type": "string"
},
"partyId": {
"description": "partyId",
"example": "the party of the collateral",
"type": "string"
},
"externalReferenceId": {
"description": "external Reference Id",
"example": "CO21085YN701",
"type": "string"
},
"collateralOverview": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralOverview"
}
]
},
"collateralDetail": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDetail"
}
]
},
"collateralDueDiligence": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDueDiligence"
}
]
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the collateral",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the collateral was last changed",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralResponse": {
"properties": {
"comments": {
"description": "comments on Collateral",
"example": "this property is shared",
"type": "string"
},
"partyId": {
"description": "partyId",
"example": "the party of the collateral",
"type": "string"
},
"externalReferenceId": {
"description": "external Reference Id",
"example": "CO21085YN701",
"type": "string"
},
"collateralOverview": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralOverview"
}
]
},
"collateralDetail": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDetail"
}
]
},
"collateralDueDiligence": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDueDiligence"
}
]
},
"collateralRelationshipResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipsResponse"
}
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the collateral",
"example": "lata123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the collateral was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRequests": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
}
}
},
"CollateralResponses": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
}
}
},
"ProcessedCollateralResponse": {
"properties": {
"partyId": {
"description": "Unique identifier for party",
"example": "P202035269718",
"type": "string"
},
"collateralId": {
"description": "Collateral id",
"example": "C202035292905",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipRequest": {
"properties": {
"collateralId": {
"description": "Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"requestId": {
"description": "Identifier of Request",
"example": "R202104218237",
"type": "string"
},
"facilityId": {
"description": "Identifier of Facility",
"example": "F12345678623",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral Relationship",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Collateral Relationship was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipRequests": {
"properties": {
"collateralRelationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipRequest"
}
}
}
},
"CollateralRelationshipsResponse": {
"properties": {
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"requestId": {
"description": "Unique Identifier of Request",
"example": "R202035269718",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F200722894832",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral Relationship",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Collateral Relationship was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipsResponses": {
"properties": {
"collateralRelationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipsResponse"
}
}
}
},
"DocumentCreationRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentType"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategory"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDocumentsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D2020123456",
"type": "string"
},
"documentId": {
"description": "Unique identifier for Document",
"example": "123456789",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentUpdateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier for Document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentType"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategory"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "Terms Sheet",
"type": "string"
},
"documentCategory": {
"description": "Category of a document",
"example": "Entity",
"type": "string"
},
"documentStatus": {
"description": "Status of a document",
"example": "Approved",
"type": "string"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentCreationRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
}
}
},
"DocumentUpdateRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentUpdateRequest"
}
}
}
},
"DocumentResponses": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
}
},
"FacilityTerm": {
"properties": {
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateDealSchema": {
"properties": {
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"usageId": {
"description": "Usage of the deal",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"facilityList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
},
"relatedPartiesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
},
"documentsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
},
"collateralsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"lastChangeUserId": {
"description": "last Modification made by user on Requests",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a Request",
"example": "ABC Corp",
"type": "string"
},
"requestStatus": {
"description": "status of a Request",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"activeProcessId": {
"description": "Active Process for Request",
"example": "1",
"type": "string"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
}
}
},
"DealCreationResponse": {
"properties": {
"requestId": {
"description": "Request ID of the Deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "D487598",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "200722894",
"type": "string"
},
"collateralId": {
"description": "ID of the collateral created for this request",
"example": "200722894",
"type": "string"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"status": {
"description": "Status of the deal",
"example": "Created",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateDealSchema": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"requestStatus": {
"description": "Status of the deal",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"withdrawalReasonType": {
"description": "Withdrawl reason type of the deal",
"example": "01",
"type": "string",
"x-referencetype": "WithdrawalReasonType"
},
"withdrawalReason": {
"description": "Reason for withdrawl",
"example": "Free text",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"extensionData": {
"type": "object"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
}
}
},
"DealUpdatedResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"DealDetailsResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"requestStatus": {
"description": "Status of the deal",
"example": "Submitted",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"withdrawalReasonType": {
"description": "Type of reason for withdrawal ",
"example": "02",
"type": "string"
},
"withdrawalReason": {
"description": "Reason for withdrawal",
"example": "Free text enterd by customer as reason ",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"extensionData": {
"type": "object"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
}
}
},
"AllDealDetailsResponse": {
"properties": {
"allDealsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
}
}
},
"Liquidity": {
"properties": {
"currentRatio": {
"description": "Current ratio",
"example": "1234567.90",
"type": "string"
},
"quickRatio": {
"description": "quick ratio",
"example": "345678.90",
"type": "string"
}
}
},
"Leverage": {
"properties": {
"debtToEquity": {
"description": "Debt to equity",
"example": "12345.67",
"type": "string"
},
"debtToTotalAssets": {
"description": "Debt to Total Assets",
"example": "23456.98",
"type": "string"
},
"debtIntEarned": {
"description": "Debt interest earned",
"example": "12345.89",
"type": "string"
},
"fixedCoverageCharge": {
"description": "fixedCoverageCharge",
"example": "12345.89",
"type": "string"
},
"ebitda": {
"description": "ebitda",
"example": "1000000",
"type": "string"
},
"turnover": {
"description": "turnover ",
"example": "12345678.90",
"type": "string"
},
"equity": {
"description": "equity ",
"example": "1237.89",
"type": "string"
},
"dscr": {
"description": "dscr",
"example": "1234.78",
"type": "string"
}
}
},
"Profitability": {
"properties": {
"grossMargin": {
"description": "Gross Margin",
"example": "1234567.89",
"type": "string"
},
"operatingMargin": {
"description": "Operation Margin",
"example": "1234567.89",
"type": "string"
},
"netProfitMargin": {
"description": "Net Profit Margin",
"example": "12345.980",
"type": "string"
},
"roa": {
"description": "ROA",
"example": "100000000",
"type": "string"
},
"roe": {
"description": "ROE",
"example": "1000000",
"type": "string"
}
}
},
"Efficiency": {
"properties": {
"receivableTurnover": {
"description": "Receivable Turn Over",
"example": "1234.90",
"type": "string"
},
"daySaleOutstanding": {
"description": "Day sale outstanding",
"example": "100000000",
"type": "string"
},
"inventoryTurnover": {
"description": "Inventory turn over",
"example": "100000000000",
"type": "string"
},
"dayOfInventory": {
"description": "dayOf Inventory",
"example": "100000000",
"type": "string"
},
"accountPayableTurnover": {
"description": "account Payable Turnover",
"example": "1000000",
"type": "string"
},
"totalAssetTurnover": {
"description": "total Asset Turnover",
"example": "123456789000",
"type": "string"
}
}
},
"CreateFinancialResultRequest": {
"properties": {
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the restriction was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFinancialResultListRequest": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFinancialResultRequest"
}
}
}
},
"CreateFinancialResultResponse": {
"properties": {
"financialResultId": {
"description": "Specifies Id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"FinancialResultResponse": {
"properties": {
"financialResultId": {
"description": "Specifies id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Financial Result was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"FinancialResultsResponse": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialResultResponse"
}
}
}
},
"UpdateFinancialResultRequest": {
"properties": {
"financialResultId": {
"description": "Specifies id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the restriction was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateFinancialResultListRequest": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFinancialResultRequest"
}
}
}
},
"NarrativesCreateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"collateralId": {
"description": "ID of the Collateral created for this deal",
"example": "C1234567",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesUpdateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"collateralId": {
"description": "ID of the Collateral created for this deal",
"example": "C12345678",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesDocumentItem": {
"properties": {
"documentId": {
"description": "ID of the document uploaded in narrative",
"example": "D20201234",
"type": "string"
},
"documentName": {
"description": "Name of the document",
"example": "asset.txt",
"type": "string"
}
}
},
"ExternalServiceDocumentItem": {
"properties": {
"documentId": {
"description": "ID of the document uploaded in narrative",
"example": "D20201234",
"type": "string"
},
"documentName": {
"description": "Name of the document",
"example": "asset.txt",
"type": "string"
}
}
},
"ProcessedNarrativesResponse": {
"properties": {
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesResponse": {
"properties": {
"categoryId": {
"description": "ID of the category",
"example": "2",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "F123456",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F123456",
"type": "string"
},
"collateralId": {
"description": "Unique identifier for Collateral",
"example": "N20201234",
"type": "string"
},
"partyId": {
"description": "Unique identifier for Party",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesResponses": {
"properties": {
"Narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
}
}
},
"NarrativesCreateRequests": {
"properties": {
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesCreateRequest"
}
}
}
},
"NarrativesUpdateRequests": {
"properties": {
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesUpdateRequest"
}
}
}
},
"EnrichmentResponseItem": {
"properties": {
"value": {
"description": "Value of the reference record",
"type": "string"
},
"description": {
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DecisionStatusResponseItem": {
"properties": {
"value": {
"description": "Decision Status Id",
"example": "01",
"type": "string"
},
"description": {
"description": "Decision Status Value",
"example": "Approve",
"type": "string"
},
"allowedDecisionType": {
"description": "Decision Status: Applicable category",
"example": "Individual,Committee",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralSubTypesItem": {
"properties": {
"collateralSubTypeId": {
"description": "Collateral Sub Type Id",
"example": "001",
"type": "string"
},
"collateralSubTypeValue": {
"description": "Collateral Sub Type Value",
"example": "Car",
"type": "string"
},
"t24ReferenceId": {
"description": "t24 Reference Id Collateral Sub Type",
"example": "200",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralTypesItem": {
"properties": {
"collateralTypeId": {
"description": "Collateral Type Id",
"example": "01",
"type": "string"
},
"collateralTypeValue": {
"description": "Collateral Type Value",
"example": "Vehicles",
"type": "string"
},
"collateralSubTypes": {
"description": "Collateral Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralSubTypesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"StageSignalTypesItems": {
"properties": {
"stage": {
"description": "Stage Value",
"example": "01",
"type": "string"
},
"signalName": {
"description": "Stage Name",
"example": "prescreeningSignal",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndustrialSubTypesItem": {
"properties": {
"industrialSubTypeId": {
"description": "industrial Sub Type Id",
"example": "001",
"type": "string"
},
"industrialSubTypeValue": {
"description": "Industrial Sub Type Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndustrialTypesItem": {
"properties": {
"industrialTypeId": {
"description": "Industrial Type Id",
"example": "01",
"type": "string"
},
"industrialTypeValue": {
"description": "Industrial Type Value",
"example": "Vehicles",
"type": "string"
},
"industrialSubTypes": {
"description": "Industrial Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialSubTypesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"FeeNamesItem": {
"properties": {
"feeNameId": {
"description": "Fee Name Id",
"example": "001",
"type": "string"
},
"feeNameValue": {
"description": "Fee Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypesItem": {
"properties": {
"feeTypesId": {
"description": "Fee Type Id",
"example": "01",
"type": "string"
},
"feeTypesValue": {
"description": "Fee Type Value",
"example": "Vehicles",
"type": "string"
},
"feeNames": {
"description": "Fee Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"StagesForLobItem": {
"properties": {
"stageId": {
"description": "stage id",
"example": "01",
"type": "string"
},
"stageValue": {
"description": "stage name",
"example": "Submitted",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RequestStagesLobItem": {
"properties": {
"lobValue": {
"description": "Line of business Id",
"example": "01",
"type": "string"
},
"description": {
"description": "lob description",
"example": "Corporate",
"type": "string"
},
"stages": {
"description": "stages for respective lob",
"type": "array",
"items": {
"$ref": "#/components/schemas/StagesForLobItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"FacilityStagesLobItem": {
"properties": {
"lobValue": {
"description": "Line of business Id",
"example": "01",
"type": "string"
},
"description": {
"description": "lob description",
"example": "Corporate",
"type": "string"
},
"stages": {
"description": "stages for respective lob",
"type": "array",
"items": {
"$ref": "#/components/schemas/StagesForLobItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ConditionNamesItem": {
"properties": {
"conditionNameId": {
"description": "Condition Name Id",
"example": "001",
"type": "string"
},
"conditionNameValue": {
"description": "Condition Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ConditionTypesItem": {
"properties": {
"conditionTypesId": {
"description": "Condition Type Id",
"example": "01",
"type": "string"
},
"conditionTypesValue": {
"description": "Condition Type Value",
"example": "Vehicles",
"type": "string"
},
"conditionNames": {
"description": "Condition Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"CovenantNamesItem": {
"properties": {
"covenantNameId": {
"description": "Covenant Name Id",
"example": "001",
"type": "string"
},
"covenantNameValue": {
"description": "Covenant Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantTypesItem": {
"properties": {
"covenantTypesId": {
"description": "Covenant Type Id",
"example": "01",
"type": "string"
},
"covenantTypesValue": {
"description": "Covenant Type Value",
"example": "Vehicles",
"type": "string"
},
"covenantNames": {
"description": "Covenant Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceNamesItem": {
"properties": {
"complianceNameId": {
"description": "Compliance Name Id",
"example": "001",
"type": "string"
},
"complianceNameValue": {
"description": "Compliance Name Value",
"example": "Car",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceTypesItem": {
"properties": {
"complianceTypesId": {
"description": "Compliance Type Id",
"example": "01",
"type": "string"
},
"complianceTypesValue": {
"description": "Compliance Type Value",
"example": "Vehicles",
"type": "string"
},
"complianceNames": {
"description": "Compliance Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativeCategoryItem": {
"properties": {
"type": {
"description": "Narrative Category Type",
"example": "financial",
"type": "string"
},
"value": {
"description": "Narrative Category Value",
"example": "01",
"type": "string"
},
"description": {
"description": "description of Narrative category",
"example": "financial",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RoleCategoryItem": {
"properties": {
"categoryId": {
"description": "Category Id",
"example": "01",
"type": "string"
},
"roles": {
"description": "Keycloak roles",
"example": "Relationship Manager,SME RM,Retail RM",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionTypesItem": {
"properties": {
"type": {
"description": "Policy Exception Type",
"example": "equity",
"type": "string"
},
"value": {
"description": "Policy Exception Value",
"example": "01",
"type": "string"
},
"description": {
"description": "description of Policy exception",
"example": "equity",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"StateInfo": {
"properties": {
"stateCode": {
"description": "code of the state",
"example": "AK",
"type": "string"
},
"stateName": {
"description": "State name",
"example": "Alaska",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CountryInfo": {
"properties": {
"countryCode": {
"description": "Code of the country",
"example": "US",
"type": "string"
},
"countryUniCode": {
"description": "Uni code of the country",
"example": "+840",
"type": "string"
},
"countryName": {
"description": "Name of the country",
"example": "United States",
"type": "string"
},
"countryPhoneCode": {
"description": "Phone code of the country",
"example": "+840",
"type": "string"
},
"states": {
"description": "List of states",
"type": "array",
"items": {
"$ref": "#/components/schemas/StateInfo"
}
},
"extensionData": {
"type": "object"
}
}
},
"TasksInfoItem": {
"properties": {
"taskId": {
"description": "Task Id",
"example": "01",
"type": "string"
},
"taskName": {
"description": "Task Name",
"example": "Borrower Info",
"type": "string"
},
"taskDescription": {
"description": "Task Description",
"example": "Borrower Info",
"type": "string"
},
"taskType": {
"description": "Task Type",
"example": "Manual",
"type": "string"
},
"defaultUserId": {
"description": "Default User Id",
"example": "1001",
"type": "string"
},
"ruleId": {
"description": "rule Id",
"example": "01",
"type": "string"
},
"taskPackage": {
"description": "task Package",
"example": "Fraud-check",
"type": "string"
},
"taskProvider": {
"description": "task Provider",
"example": "Borrower",
"type": "string"
},
"noOfDays": {
"description": "Task Lifetime for no of days",
"example": "5",
"type": "string"
},
"defaultUserEmail": {
"description": "Default User Email",
"example": "temenostestmail@gmail.com",
"type": "string"
},
"partyIndicator": {
"description": "Party Indicator",
"example": "00",
"type": "string"
},
"overview": {
"description": "overview screen",
"example": "Entity Overview",
"type": "string"
},
"section": {
"description": "Section Screen",
"example": "Documents",
"type": "string"
},
"processDefId": {
"description": "Id of process initiated by PAM",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"TasksCheckListItem": {
"properties": {
"taskCheckListId": {
"description": "Task Check List Id",
"example": "01",
"type": "string"
},
"taskCheckListName": {
"description": "Task Check List Name",
"example": "Fraud check",
"type": "string"
},
"tasksInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksInfoItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"TasksParamsItem": {
"properties": {
"taskStage": {
"description": "Task Stage",
"example": "Onboarding",
"type": "string"
},
"tasksCheckList": {
"description": "Task CheckList",
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"lastChangeUserId": {
"description": "Last Change User Id",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ReferenceDataItems": {
"properties": {
"documentType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"limitType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"relatedPartyRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"dealStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"lineOfBusiness": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"operator": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"interestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"month": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"restrictionType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"payType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"addressType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DecisionStatusResponseItem"
}
},
"complianceType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"currency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"noOfEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"portfolio": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"profitCenter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPriority": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"salutation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"partyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"fundingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingInterestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeBalanceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"basisTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collectionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPackage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingIndex": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityPurpose": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityUsage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"policyExceptionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"productReferenceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branchReferenceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"jobTitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskProvider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"acceptanceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"companyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"contactTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeFrequencyTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"riskRatingTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"beneficialOwnerDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rateTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"provider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"providerType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"repricingFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"paymentFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralTypesItem"
}
},
"stageSignalTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageSignalTypesItems"
}
},
"industryTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialTypesItem"
}
},
"conditionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionTypesItem"
}
},
"covenantTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantTypesItem"
}
},
"complianceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceTypesItem"
}
},
"narrativeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativeCategoryItem"
}
},
"policyExceptionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionTypesItem"
}
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryInfo"
}
},
"feeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeTypesItem"
}
},
"requestStagesLob": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestStagesLobItem"
}
},
"facilityStagesLob": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityStagesLobItem"
}
},
"UITasksCheckList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"withdrawalReasonType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralPropertyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralPropertyStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralOccupancy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralRequiredCoverage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypeDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralStatusDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"approvalStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"committeeRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"roleCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleCategoryItem"
}
}
}
},
"BasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"legalName": {
"description": "legalName of the Customer",
"example": "ABC Company",
"type": "string"
},
"registrationNumber": {
"description": "registration number of the Customer",
"example": "ABC Company",
"type": "string"
},
"companyType": {
"description": "company type",
"example": "Community Interest Company (CIC)",
"type": "string",
"x-referencetype": "CompanyType"
},
"industryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"subIndustryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"registrationDate": {
"description": "date of registration",
"example": "Telecom",
"type": "string"
},
"yearsInBusiness": {
"description": "years in business",
"example": "5",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedAnnualRevenue": {
"description": "estimated annual revenue",
"example": "10000000",
"type": "string"
},
"noOfEmployees": {
"description": "no of employees",
"example": "01",
"type": "string"
},
"websiteAddress": {
"description": "websire address",
"example": "www.abc.com",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"companyOverview": {
"description": "company overview",
"example": "Telecom company",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"jobTitle": {
"description": "jobTitle of the person",
"example": "MD",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phnNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddr": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PartyInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "12345",
"type": "string"
},
"partyName": {
"description": "Name of the party",
"example": "ABC corporation",
"type": "string"
},
"partyType": {
"description": "Type of the party",
"example": "Individual",
"type": "string"
}
}
},
"GroupInfo": {
"properties": {
"groupId": {
"description": "unique identifier of the group",
"example": "1234567",
"type": "string"
},
"groupName": {
"description": "Name of the Group",
"example": "ABC Group",
"type": "string"
},
"groupType": {
"description": "Type of the Group",
"example": "Borrowing",
"type": "string"
},
"overView": {
"description": "Overview of the Group",
"type": "string"
},
"partyInfoList": {
"description": "party infor of particular group",
"type": "array",
"items": {
"$ref": "#/components/schemas/PartyInfo"
}
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "+91",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndividualBasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"dateOfBirth": {
"description": "dob of the person",
"example": "1978-06-03",
"type": "string"
},
"identificationNumber": {
"description": "id proof of the person",
"example": "9876095404361276",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddress": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityInfo": {
"properties": {
"facilityId": {
"description": "unique identifier of the facility",
"example": "F20201234567",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P20201234567",
"type": "string"
},
"groupId": {
"description": "unique identifier of the group",
"example": "P20201234567",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "facility123",
"type": "string"
},
"purpose": {
"description": "purpose of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityPurpose"
},
"usageId": {
"description": "usage id of the facility",
"example": "01",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "line of credit",
"type": "string"
},
"currency": {
"description": "Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "amount of the facility",
"example": "10000000",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RelatedPartyInfo": {
"properties": {
"id": {
"description": "unique identifier",
"example": "12345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"groupId": {
"description": "unique identifier of the group",
"example": "P20201234567",
"type": "string"
},
"relatedGroupId": {
"description": "unique identifier of the related group",
"example": "P20201234567",
"type": "string"
},
"relatedPartyId": {
"description": "unique identifier of the related party",
"example": "P20201234567",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"partyName": {
"description": "name of the party",
"example": "abc",
"type": "string"
},
"relatedPartyName": {
"description": "name of the related party",
"example": "party1",
"type": "string"
},
"relatedGroupName": {
"description": "name of the relatedGroup",
"example": "group1",
"type": "string"
},
"relatedPartyType": {
"description": "type of the relatedparty",
"example": "abc",
"type": "string"
},
"role": {
"description": "role",
"example": "01",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "amount or percentage of limit",
"example": "percentage",
"type": "string"
},
"limitCurrency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"limitValue": {
"description": "value",
"example": "10000000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralInfo": {
"properties": {
"collateralId": {
"description": "unique identifier of the collateral",
"example": "C202012345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"name": {
"description": "name of the collateral",
"example": "building",
"type": "string"
},
"type": {
"description": "type of the collateral",
"example": "01",
"type": "string"
},
"subType": {
"description": "subtype of the collateral",
"example": "001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedValue": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
},
"collateralStatus": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string",
"x-referencetype": "CollateralStatus"
},
"externalReferenceId": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentInfo": {
"properties": {
"documentId": {
"description": "Id of the document",
"example": "123456",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"collateralId": {
"description": "unique identifier of the Collateral",
"example": "T202012345678",
"type": "string"
},
"requestId": {
"description": "unique identifier of the request",
"example": "T202012345",
"type": "string"
},
"documentName": {
"description": "name of the document",
"example": "agreement",
"type": "string"
},
"documentType": {
"description": "type of the document",
"example": "02",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"uploadOn": {
"description": "date of upload",
"example": "2020-06-03",
"type": "string"
},
"category": {
"description": "category",
"example": "",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerRequestInfo": {
"properties": {
"requestId": {
"description": "Id of the request",
"example": "654564",
"type": "string"
},
"userId": {
"description": "id of the user who created the request",
"example": "87654",
"type": "string"
},
"usageId": {
"description": "id of the usage who created the request",
"example": "U123",
"type": "string"
},
"currency": {
"description": "currency",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"status": {
"description": "current step of submission process",
"example": "Draft",
"type": "string"
},
"screenFlag": {
"description": "Specifies screen of the request",
"example": "Facility",
"type": "string"
},
"requestType": {
"description": "Specifies request type",
"example": "delete",
"type": "string"
},
"summary": {
"description": "summary of the request being raised",
"example": "test summary",
"type": "string"
},
"requestDate": {
"description": "Date of the request being raised",
"example": "2020-06-03",
"type": "string"
},
"customerInformation": {
"allOf": [
{
"$ref": "#/components/schemas/BasicInfo"
}
]
},
"groupInformation": {
"allOf": [
{
"$ref": "#/components/schemas/GroupInfo"
}
]
},
"facilityItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityInfo"
}
},
"relatedPartyItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyInfo"
}
},
"newRelatedPartyIndividualItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndividualBasicInfo"
}
},
"newRelatedPartyBusinessItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicInfo"
}
},
"collateralItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"documentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentInfo"
}
},
"extensionData": {
"type": "object"
}
}
},
"CustomerRequestsInfo": {
"properties": {
"customerRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"CreateCustomerProcessedResponse": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "TEMP-12345678",
"type": "string"
},
"customerPartyId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"customerGroupId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"facilityId": {
"description": "unique id of the facility",
"example": "F202012345678",
"type": "string"
},
"Ids": {
"description": "unique id of the relatedParties",
"example": "P202012345678",
"type": "string"
},
"individualPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"businessPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"collateralIds": {
"description": "unique id of the collaterals",
"example": "C202012345678",
"type": "string"
},
"documentIds": {
"description": "unique id of the documents",
"example": "D202012345678",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionsRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"restrictionType": {
"description": "Restriction Type",
"example": "01",
"type": "string",
"x-referencetype": "RestrictionType"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyIdsArray"
}
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012586",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDrawRestrictionsResponse": {
"properties": {
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012566",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "Maximum Limit amount",
"type": "string"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyIdsArray"
}
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the restriction was last changed",
"type": "string",
"format": "date"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionsRequests": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionsRequest"
}
}
}
},
"DrawRestrictionResponses": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
}
}
},
"ComplianceRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "R2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateComplianceRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "COMP123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceRequest"
}
}
}
},
"UpdateComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateComplianceRequest"
}
}
}
},
"ComplianceResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "123456789",
"type": "string"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceResponses": {
"properties": {
"Compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
}
}
},
"PolicyExceptionResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P3456789",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"policyExceptionId": {
"description": "Unique Identifier of PolicyException",
"example": "123456789",
"type": "string"
},
"exceptionType": {
"description": "Type of Exception",
"type": "string"
},
"description": {
"description": "description of the exception",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"type": "string"
},
"comment": {
"description": "policyException comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a policyException",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionResponses": {
"properties": {
"policyExceptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionResponse"
}
}
}
},
"ProcessedComplianceResponse": {
"properties": {
"RequestId": {
"description": "Unique identifier for Deal",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"complianceId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedConditionResponse": {
"properties": {
"conditionId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"ProcessedDecisionResponse": {
"properties": {
"creditDecisionId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"ProcessedPolicyResponse": {
"properties": {
"policyExceptionId": {
"description": "Unique identifier for PolicyExceptions",
"example": "PE123456",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"AddressDetails": {
"properties": {
"addressLine1": {
"description": "address Line1",
"example": "1-2-33/4/5, Baker Street",
"type": "string"
},
"addressLine2": {
"description": "address Line2",
"example": "Opp. White House",
"type": "string"
},
"city": {
"description": "city",
"example": "Los Angeles",
"type": "string"
},
"countryId": {
"description": "country id",
"example": "0",
"type": "string"
},
"state": {
"description": "state",
"example": "ca",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "10011",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsCreateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressRefrence": {
"description": "Refrence of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsUpdateRequest": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"fundingId": {
"description": "ID of the funding created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressRefrence": {
"description": "Refrence of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedFundingDetailsResponse": {
"properties": {
"fundingId": {
"type": "string",
"description": "Specifies the ID of the funding",
"example": "F123"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"FundingDetailsResponse": {
"properties": {
"dealId": {
"description": "ID of the deal",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"fundingId": {
"description": "ID of the funding created for this deal",
"example": "F200722894",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2020-06-03",
"type": "string"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "ABC",
"type": "string"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "ABC",
"type": "string"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "FUND1",
"type": "string"
},
"payType": {
"description": "How the payment was to be done",
"example": "Cheque",
"type": "string"
},
"accountNumber": {
"description": "Accound Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"payeeName": {
"description": "Name of the payee",
"example": "Antony",
"type": "string"
},
"addressRefrence": {
"description": "Refrence of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeUserid": {
"description": "ID of the lastchange user",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date and Time of the lastchange",
"example": "2020-09-05 10:08 08 800",
"type": "string",
"format": "date"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsResponses": {
"properties": {
"Funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
}
}
},
"LimitThings": {
"properties": {
"unadvisedLimit": {
"description": "Limit that unadvised",
"example": "$10000",
"type": "string"
},
"advisedLimit": {
"description": "Limit that advised",
"example": "$5000",
"type": "string"
},
"utilisedLimit": {
"description": "Already used limit",
"example": "$5000",
"type": "string"
},
"availableLimit": {
"description": "Limit that available",
"example": "$5000",
"type": "string"
},
"requestedAmount": {
"description": "Amount that requested",
"example": "$10000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"LimitsRequest": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": "Specifies the outstanding debt",
"example": "$5000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"LimitsResponse": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": " Specifies the outstanding debt",
"example": "$50000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"previousLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"modifiedDate": {
"description": "The date modify the Limit",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Limit",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedLimitResponse": {
"properties": {
"limitId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"FeeTypeOnGoing": {
"properties": {
"balanceType": {
"description": "DD field,Visible only If Percentage is selected in Percentage/Amount",
"example": "01",
"type": "string",
"x-referencetype": "FeeBalanceTypes"
},
"frequency": {
"description": "Fee Frequency",
"example": "05",
"type": "string",
"x-referencetype": "FeeFrequencyTypes"
},
"rateBasis": {
"description": "DD field, Visible only If Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"rateType": {
"description": "Default to Fixed, Visible only if Percentage is selected in Percentage/Amount",
"example": "fixed",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypeEvent": {
"properties": {
"feeBasis": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypeClosing": {
"properties": {
"feeBasis": {
"description": "feeBasisId",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "percentage",
"example": "48",
"type": "string"
},
"collection": {
"description": "DD field, collection",
"example": "12345678",
"type": "string"
},
"status": {
"description": "DD field, status",
"example": "01",
"type": "string",
"x-referencetype": "FeeStatus"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFeeRequest": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateFeeRequest": {
"properties": {
"feeId": {
"description": "unique id of the fee",
"example": "FEE202035269718",
"type": "string"
},
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeResponse": {
"properties": {
"feeId": {
"description": "Specifies id of the fees",
"example": "12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFeeRequest"
}
}
}
},
"UpdateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFeeRequest"
}
}
}
},
"FeesResponse": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
}
}
},
"ProcessedFeesResponse": {
"properties": {
"feesId": {
"description": "Unique identifier for fees",
"example": "FEE202035292905",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"StandardSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"FixedInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingIndex"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "12345",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "20",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "20",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "20",
"type": "string"
},
"rateLockDate": {
"description": "The rateLockDate",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "01",
"type": "string",
"x-referencetype": "PaymentFrequency"
},
"period": {
"description": "The period",
"example": "01",
"type": "string"
},
"currencyId": {
"description": "The currencyId",
"example": "INR",
"type": "string"
},
"instalmentAmount": {
"description": "Installment Amount",
"example": "10000000",
"type": "string"
},
"instalmentDate": {
"description": "Installment Date",
"example": "05-07-2021",
"type": "string"
},
"aprRate": {
"description": "The APR rate",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"currencyIdsArray": {
"properties": {
"currency": {
"description": "The restricted currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
}
}
},
"ExternalRefDetails": {
"properties": {
"type": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"id": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
}
}
},
"FeaturesDetails": {
"properties": {
"type": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"id": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
},
"name": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"value": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
}
}
},
"repricingFrequencyArray": {
"properties": {
"frequencyId": {
"description": "The repricingFrequency",
"example": "01",
"type": "string",
"x-referencetype": "RepricingFrequency"
}
}
},
"PeriodicInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingIndex"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "01",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "20",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "20",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "20",
"type": "string"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "01",
"type": "string",
"x-referencetype": "PaymentFrequency"
},
"period": {
"description": "The period",
"example": "Daily",
"type": "string"
},
"repricingPeriod": {
"description": "The repricing Frequency period",
"example": "Weekly",
"type": "string"
},
"rateIndex": {
"description": "The rateIndex",
"example": "01",
"type": "string"
},
"repricingFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/repricingFrequencyArray"
}
},
"interestCap": {
"description": "The interestCap",
"example": "30",
"type": "string"
},
"interestFloor": {
"description": "The interestFloor",
"example": "30",
"type": "string"
},
"capBasis": {
"description": "The capBasis",
"example": "Base rate",
"type": "string"
},
"floorBasis": {
"description": "The Floor basis",
"example": "Base rate",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "01",
"type": "string"
},
"roundingRule": {
"description": "The roundingRule",
"example": "01",
"type": "string"
},
"currencyId": {
"description": "The currencyId",
"example": "INR",
"type": "string"
},
"instalmentAmount": {
"description": "Installment Amount",
"example": "10000000",
"type": "string"
},
"instalmentDate": {
"description": "Installment Date",
"example": "05-07-2021",
"type": "string"
},
"aprRate": {
"description": "The APR rate",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FloatingInterestRate": {
"properties": {
"pricingType": {
"description": "The pricing type",
"example": "01",
"type": "string",
"x-referencetype": "PricingIndex"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "01",
"type": "string"
},
"interestSpread": {
"description": "The interest spread",
"example": "20",
"type": "string"
},
"indicativeBaseRate": {
"description": "The indicative base rate",
"example": "20",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicativeBorrowerRate",
"example": "20",
"type": "string"
},
"paymentFrequency": {
"description": "The paymentFrequency",
"example": "01",
"type": "string",
"x-referencetype": "PaymentFrequency"
},
"lagPeriod": {
"description": "The lagPeriod",
"example": "01",
"type": "string"
},
"freezePeriod": {
"description": "The freezePeriod",
"example": "01",
"type": "string"
},
"rateIndex": {
"description": "The rateIndex",
"example": "01",
"type": "string"
},
"rateChangeMethod": {
"description": "The rateChangeMethod",
"example": "01",
"type": "string"
},
"interestCap": {
"description": "The interestCap",
"example": "30",
"type": "string"
},
"interestFloor": {
"description": "The interestFloor",
"example": "30",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "01",
"type": "string"
},
"roundingRule": {
"description": "The roundingRule",
"example": "01",
"type": "string"
},
"capBasis": {
"description": "The capBasis",
"example": "Base rate",
"type": "string"
},
"floorBasis": {
"description": "The capBasis",
"example": "Base rate",
"type": "string"
},
"currencyId": {
"description": "The currencyId",
"example": "INR",
"type": "string"
},
"instalmentAmount": {
"description": "Installment Amount",
"example": "10000000",
"type": "string"
},
"instalmentDate": {
"description": "Installment Date",
"example": "05-07-2021",
"type": "string"
},
"aprRate": {
"description": "The APR rate",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PricingRequest": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"interestRateType": {
"description": "The type of interest",
"example": "01",
"type": "string",
"x-referencetype": "InterestType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"fixedInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestRate"
}
]
},
"periodicInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/PeriodicInterestRate"
}
]
},
"floatingInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FloatingInterestRate"
}
]
},
"status": {
"description": "The status",
"example": "01",
"type": "string",
"x-referencetype": "PricingStatus"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"PricingResponse": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"interestRateType": {
"description": "The type of interest",
"example": "Fixed",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"fixedInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestRate"
}
]
},
"periodicInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/PeriodicInterestRate"
}
]
},
"floatingInterestRate": {
"allOf": [
{
"$ref": "#/components/schemas/FloatingInterestRate"
}
]
},
"status": {
"description": "The status",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"PricingRequests": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingRequest"
}
}
}
},
"PricingResponses": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
}
}
},
"ProcessedPricingResponse": {
"properties": {
"pricingId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedCreditDecisionResponse": {
"properties": {
"creditDecisionId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"conditionId": {
"description": "Unique Identifier",
"example": "CON12345",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedCovenantsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"covenantId": {
"description": "Unique identifier for covenant",
"example": "COV2345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"CovenantsRequest": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "C12345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string",
"x-referencetype": "CovenantType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string",
"x-referencetype": "CovenantFrequency"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "CovenantStatus"
},
"operator": {
"description": "Operator of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "Operator"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "requirement",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "COV202012345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string"
},
"operator": {
"description": "Operator of the Covenant",
"example": "==",
"type": "string"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantsRequests": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsRequest"
}
}
}
},
"CovenantsResponses": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
}
}
},
"ConditionsInfo": {
"properties": {
"conditionId": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateConditionRequest": {
"properties": {
"conditionId": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"creditDecisionId": {
"description": "id of credit decision",
"example": "12345678",
"type": "string"
},
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditDecisionInfo": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"creditDecisionId": {
"description": "Unique identifier of the Credit decision",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"committeeId": {
"description": "Unique identifier of the committee",
"example": "12345678",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"approvedAmount": {
"description": "Amount utilised in the committee",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"finalDecision": {
"description": "finalDecision of committee",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateCreditDecisionRequest": {
"properties": {
"creditDecisionId": {
"description": "Unique identifier of the CreditDecision",
"example": "123456",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"committeeId": {
"description": "Unique identifier of the committee",
"example": "12345678",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"approvedAmount": {
"description": "Amount utilised in the committee",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"finalDecision": {
"description": "finalDecision of committee",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionsRequest": {
"properties": {
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"exceptionType": {
"description": "type of the exception",
"type": "string"
},
"description": {
"description": "Description of the exception",
"type": "string"
},
"status": {
"description": "The status of the exception",
"type": "string",
"x-referencetype": "PolicyExceptionStatus"
},
"comment": {
"description": "Policy exceptions comment",
"example": "comment",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdatePolicyExceptionsRequest": {
"properties": {
"policyExceptionId": {
"description": "Unique identifier of the PolicyExceptions",
"example": "PE123456",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"exceptionType": {
"description": "type of the exception",
"type": "string"
},
"description": {
"description": "exception description",
"type": "string"
},
"status": {
"description": "The status of the exception",
"type": "string",
"x-referencetype": "PolicyExceptionStatus"
},
"comment": {
"description": "exception comment",
"example": "comment",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
}
}
},
"UpdateCreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateCreditDecisionRequest"
}
}
}
},
"PolicyExceptionsList": {
"properties": {
"policyExceptionsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionsRequest"
}
}
}
},
"UpdatePolicyExceptionsList": {
"properties": {
"policyExceptionsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdatePolicyExceptionsRequest"
}
}
}
},
"UpdateConditionList": {
"properties": {
"conditionItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateConditionRequest"
}
}
}
},
"RequestOverViewResponse": {
"properties": {
"parentProcessId": {
"description": "Parent Process for Deal",
"example": "1",
"type": "string"
},
"requestOverView": {
"allOf": [
{
"$ref": "#/components/schemas/DealDetailsResponse"
}
]
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"borrowerFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"policyException": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionResponse"
}
},
"IntegrationService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
},
"ExternalServiceHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
},
"checklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialResultResponse"
}
},
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
}
}
},
"AdjustmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"facilityName": {
"description": "Name of the facility",
"example": "ABC ltd",
"type": "string"
},
"adjustedAmount": {
"description": "Adjusted Amount",
"example": "2 million",
"type": "string"
},
"adjustedCurrency": {
"description": "Adjusted Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedComment": {
"description": "adjusted comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalCommitmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"lenderName": {
"description": "Name of the lender",
"example": "Jhon",
"type": "string"
},
"commitmentAmount": {
"description": "commitment Amount",
"example": "2 million",
"type": "string"
},
"maturitydate": {
"description": "maturity Date",
"example": "2020-06-03",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureCommentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"comment": {
"description": "comment",
"example": "this exposure is pending",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureInfo": {
"properties": {
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"exposureUniqueId": {
"description": "Unique identifier of the Exposure",
"example": "P202035292905",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsInfo"
}
},
"externalCommitments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalCommitmentsInfo"
}
},
"exposureComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureCommentsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"exposureDate": {
"description": "Exposure Date",
"example": "2020-06-03",
"type": "string"
},
"exposureTime": {
"description": "Exposure Time",
"example": "02:22",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureList": {
"properties": {
"exposureItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
}
}
},
"FacilityOverViewResponse": {
"properties": {
"parentProcessId": {
"description": "Parent Process for Deal",
"example": "1",
"type": "string"
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"fees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"drawRestriction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
},
"compliance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
}
}
},
"TasksParamsReferenceDataItems": {
"properties": {
"tasksParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksParamsItem"
}
},
"tasksInfo": {
"$ref": "#/components/schemas/TasksInfoItem"
}
}
},
"EntityOverViewResponse": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"Exposures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
},
"IntegrationService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
},
"ExternalServiceHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
}
}
},
"MessageList": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"MessagesList": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageList"
}
}
}
},
"CreateMessagesResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"GetMessageResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"userId": {
"description": "user Id",
"example": "12345",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeDateTime": {
"description": "read flag",
"example": "true",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"GetMessagesResponse": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetMessageResponse"
}
}
}
},
"IntegrationServicesRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"integrationServicesId": {
"description": "Unique Identifier of IntegrationServices",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "01",
"type": "string",
"x-referencetype": "Provider"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "01",
"type": "string",
"x-referencetype": "ProviderType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"accountNumber": {
"description": "Account Number",
"example": "abcd",
"type": "string"
},
"package1": {
"description": "Name of the first Package",
"example": "weekly package",
"type": "string"
},
"package2": {
"description": "Name of the second Package",
"example": "monthly package",
"type": "string"
},
"package3": {
"description": "Name of the third Package",
"example": "yearly package",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the Integration Service",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Integration Service was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"IntegrationServicesRequests": {
"properties": {
"integrationServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesRequest"
}
}
}
},
"IntegrationServicesResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"integrationServicesId": {
"description": "Unique Identifier of IntegrationServices",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "Airtel",
"type": "string"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "3g",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"accountNumber": {
"description": "Account Number",
"example": "abcd",
"type": "string"
},
"package1": {
"description": "Name of the first Package",
"example": "weekly package",
"type": "string"
},
"package2": {
"description": "Name of the second Package",
"example": "monthly package",
"type": "string"
},
"package3": {
"description": "Name of the third Package",
"example": "yearly package",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the Integration Service",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Integration Service was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"IntegrationServicesResponses": {
"properties": {
"integrationServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
}
}
},
"ProcessedIntegrationServicesResponse": {
"properties": {
"integrationServicesId": {
"description": "Unique identifier for integrationServices",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"externalServicesHistoryId": {
"description": "Unique Identifier of externalServicesHistory",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "01",
"type": "string",
"x-referencetype": "Provider"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "01",
"type": "string",
"x-referencetype": "ProviderType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"package1": {
"description": "Package of service",
"example": "monthly",
"type": "string"
},
"result": {
"description": "Link of external result",
"example": "www.result.com",
"type": "string"
},
"status": {
"description": "The status of ExternalServiceHistory",
"example": "Pending",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the externalServicesHistory",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the externalServicesHistoryId was last changed",
"type": "string",
"format": "date"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServiceDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryRequests": {
"properties": {
"externalServicesHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequest"
}
}
}
},
"ExternalServicesHistoryRespose": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"externalServicesHistoryId": {
"description": "Unique Identifier of externalServicesHistory",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "Airtel",
"type": "string"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "3g",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"package1": {
"description": "Package of service",
"example": "monthly",
"type": "string"
},
"result": {
"description": "Link of external result",
"example": "www.result.com",
"type": "string"
},
"status": {
"description": "The status of ExternalServiceHistory",
"example": "Pending",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the externalServicesHistory ",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the externalServicesHistory was last changed",
"type": "string",
"format": "date"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServiceDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryResposes": {
"properties": {
"externalServicesHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
}
}
},
"ProcessedExternalServicesHistoryResponse": {
"properties": {
"externalServicesHistoryId": {
"description": "Unique identifier for externalServicesHistory",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRequestProcessRelation": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R123456",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F123456",
"type": "string"
},
"parentProcessId": {
"description": "unique identifier of parentProcess",
"example": "P123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRequestProcessRelations": {
"properties": {
"requestProcessRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRequestProcessRelation"
}
}
}
},
"RequestProcessRelationResponse": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R123456",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F123456",
"type": "string"
},
"parentProcessId": {
"description": "unique identifier of parentProcess",
"example": "P123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RequestProcessRelationResponses": {
"properties": {
"requestProcessRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestProcessRelationResponse"
}
}
}
},
"CreateFacilityApproverInfo": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F20217632573",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "C2021754566",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "7645756",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "7645756",
"type": "string"
},
"riskOfficerUserId": {
"description": "userId of the riskOfficer",
"example": "01",
"type": "string"
},
"riskOfficerDecisionId": {
"description": "decisionId of the riskOfficer",
"example": "7645756",
"type": "string"
},
"mom": {
"description": "MOM",
"example": "MOM123",
"type": "string"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFacilityApproversInfo": {
"properties": {
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFacilityApproverInfo"
}
}
}
},
"ProcessedFacilityApproverInfoResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for facilityApprover",
"example": "2007228945674",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityApproverInfo": {
"properties": {
"rowId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F20217632573",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "C2021754566",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "7645756",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "01",
"type": "string"
},
"riskOfficerUserId": {
"description": "userId of the riskOfficer",
"example": "01",
"type": "string"
},
"riskOfficerDecisionId": {
"description": "decisionId of the riskOfficer",
"example": "7645756",
"type": "string"
},
"mom": {
"description": "MOM",
"example": "MOM123",
"type": "string"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "7645756",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the facilityApproverInfo was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityApproversInfo": {
"properties": {
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
}
}
},
"MemberInfo": {
"properties": {
"memberId": {
"description": "Member Id",
"example": "bfleck",
"type": "string"
},
"memberRole": {
"description": "Member Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
}
}
},
"CreditCommitteeRequest": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Committee",
"example": "CR1726789239",
"type": "string"
},
"committeeName": {
"description": "Name of a Committeee",
"example": "CC1",
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberInfo"
}
},
"noOfDecisions": {
"description": "Number of Decisions needed for the commitee to carry on with the decision",
"example": "4",
"type": "string"
},
"secretaryId": {
"description": "Secretary Id",
"example": "gregory",
"type": "string"
},
"secretaryRole": {
"description": "Secretary Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date of a committee",
"type": "string",
"format": "date"
},
"hierarchy": {
"description": "Hierarchy of a committee",
"example": "10",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeRequests": {
"properties": {
"creditCommitteeRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditCommitteeRequest"
}
}
}
},
"ProcessedCreditCommitteeResponse": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Credit Committee",
"example": "CR7628390",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeResponse": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Committee",
"example": "CR1726789239",
"type": "string"
},
"committeeName": {
"description": "Name of a Committeee",
"example": "CC1",
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberInfo"
}
},
"noOfDecisions": {
"description": "Number of Decisions needed for the commitee to carry on with the decision",
"example": "4",
"type": "string"
},
"secretaryId": {
"description": "secretary ID",
"example": "01",
"type": "string"
},
"secretaryRole": {
"description": "secretary Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the credit commitee was last changed",
"type": "string",
"format": "date"
},
"hierarchy": {
"description": "Hierarchy of a committee",
"example": "10",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeResponses": {
"properties": {
"creditCommitteeResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditCommitteeResponse"
}
}
}
}
}
}
}
,
dom_id: "#swagger-ui3",
presets: [
SwaggerUIBundle.presets.apis,
]
})
</script>
|
|
<html>
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui.css" />
<div id="swagger-ui4"> </div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-bundle.js" type="text/javascript">
</script>
<script type="text/javascript">
const ui4 = SwaggerUIBundle({
spec:
{
"openapi": "3.0.0",
"servers": [
{
"description": "Locally Deployed Environment",
"url": "http://localhost:8600/ms-corporatelos-api/api/v1.0.0"
}
],
"info": {
"title": "Corporate LOS API",
"description": "This API enables you to programmatically access all data related to Corporate LOS that users has granted access.",
"version": "1.0.0",
"contact": {
"email": "mprasadambati@temenos.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/origination/corporate/deals": {
"post": {
"summary": "Creates a new Corporate Request",
"description": "Creates new Corporate Request record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "createCorporateDealV1",
"tags": [
"Request"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Creation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreationResponse"
}
}
}
},
"400": {
"description": "Deal Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the corporate requests record",
"description": "Retrieves corporate requests record based on the request Id, Deal Name, User Id, externalReference Id.",
"operationId": "getCorporateDealsV1",
"tags": [
"Request"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestName",
"in": "query",
"description": "Request Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "count of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stageId",
"in": "query",
"description": "stage of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "orderOfRequest",
"in": "query",
"description": "order of requests to be displayed",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lineOfBusiness",
"in": "query",
"description": "lob of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "externalReferenceId",
"in": "query",
"description": "External Reference Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "All Deal Details Retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllDealDetailsResponse"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{requestId}": {
"put": {
"summary": "Updates an existing Corporate Request",
"description": "Update Corporate Deal record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "updateCorporateDealV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Request"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealUpdatedResponse"
}
}
}
},
"400": {
"description": "Deal Update Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete the record of corporate request",
"description": "Delete Corporate Request record for given requestId .",
"operationId": "deleteCorporateDealV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Request"
],
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Deal Delete Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}/facilities": {
"post": {
"summary": "Creates new facilities for a Deal",
"description": "Create Facility record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "createFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates already existing facilities for a Request",
"description": "Update Facility record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "updateFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/{facilityId}": {
"delete": {
"summary": "Delete facilities",
"description": "Delete Facility record based on facilityId.",
"operationId": "deleteFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility": {
"get": {
"summary": "Retrieves the Facility record",
"description": "Retrieves the Facility record based on the Request Id, Facility Id, Party Id and Facility Name .",
"operationId": "getFacilityV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityName",
"in": "query",
"description": "Facility Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Facility"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/financialResult": {
"post": {
"summary": "Create Financial Result",
"description": "Create the Financial Result with the provided data.",
"operationId": "createFinancialResultV1",
"tags": [
"FinancialResult"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultListRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Financial Result with the given financialResultId",
"description": "Update the Financial Result with the provided data.",
"operationId": "updateFinancialResultV1",
"tags": [
"FinancialResult"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFinancialResultListRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Financial Result details to the given financialResultId/partyId",
"description": "Retrieve the Financial Result records based on financialResultId/partyId.",
"operationId": "getFinancialResultV1",
"tags": [
"FinancialResult"
],
"parameters": [
{
"name": "financialResultId",
"in": "query",
"description": "Financial Result Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialResultsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/financialResult/{financialResultId}": {
"delete": {
"tags": [
"FinancialResult"
],
"summary": "soft delete the Financial Result",
"description": "Financial Result record with the provided financialResultId, will be deleted softly.",
"operationId": "deleteFinancialResultV1",
"parameters": [
{
"name": "financialResultId",
"in": "path",
"description": "ID of Financial Result to be deleted",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties": {
"post": {
"summary": "Create a relationship to the given Party id with the facility owner",
"description": "Create RelatedPartie record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "createRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the relationship to the given party id with the facilty owner",
"description": "Update RelatedPartie record with the provided data such as requestId, facilityId and partyId etc.",
"operationId": "updateRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the relatedParty record",
"description": "Retrieves the relatedParty record based on facilityId, relatedPartyId, partyId and requestId.",
"operationId": "getRelatedPartiesV1",
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatedPartyId",
"in": "query",
"description": "Related Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/connectedParties": {
"get": {
"summary": "Retrieves the connected Parties",
"description": "Retrieves the relatedParty record based on partyIds if they are related.",
"operationId": "getDealRelatedPartiesV1",
"parameters": [
{
"name": "party1",
"in": "query",
"description": "first party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "party2",
"in": "query",
"description": "second Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties/{rowId}": {
"delete": {
"tags": [
"Related Parties"
],
"summary": "soft delete the related parties",
"description": "related partyies record with the provided rowId, will be deleted softly.",
"operationId": "deleteRelatedPartiesV1",
"parameters": [
{
"name": "rowId",
"in": "path",
"description": "ID of row for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks/{indicator}": {
"post": {
"summary": "Creates tasks for a Deal",
"description": "Create Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "createTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "indicator",
"in": "path",
"description": "indicator",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks": {
"put": {
"summary": "Updates the Task record",
"description": "Update Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "updateTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks": {
"get": {
"summary": "Retrieves the details of tasks for the provided criteria",
"description": "Retrieves Task record based on dealId, partyId and Facility Id etc.",
"operationId": "getTasksV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "assignUserId",
"in": "query",
"description": "Assigned User Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "task status",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"in": "query",
"description": "task stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks/{taskId}": {
"delete": {
"summary": "Delete the task record",
"description": "Delete Task record based on taskId.",
"operationId": "deleteTasksV1",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "task Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "partyId",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals": {
"post": {
"tags": [
"Collateral"
],
"summary": "Add a new collateral to the party",
"description": "Create collateral record with the provided data",
"operationId": "createCollateralV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Collateral"
],
"summary": "Update the collateral associated to the Party",
"description": "Update collateral record with the provided data for a Party",
"operationId": "updateCollateralV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Collateral"
],
"summary": "Fetch the collaterals associated to the Request/Facility/Party/Collateral",
"description": "Retrieves the collateral records based on RequestId, facilityId, partyId and collateralId.",
"operationId": "getCollateralV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "DealId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "PartyId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals/{collateralId}": {
"delete": {
"tags": [
"Collateral"
],
"summary": "soft delete the collateral",
"description": "collateral record with the provided collateralId, will be deleted softly.",
"operationId": "deleteCollateralV1",
"parameters": [
{
"name": "collateralId",
"in": "path",
"description": "unique ID of collateral for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collateralRelationships": {
"put": {
"tags": [
"Collateral"
],
"summary": "Map a collateral to the Request/Facility",
"description": "Delete existing collateral relationship and create new record with the provided data such as collateralId,requestId, facilityId.",
"operationId": "updateCollateralRelationshipV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRelationshipRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Collateral"
],
"summary": "Fetch the collateral Relationships associated to the Request/Facility/Collateral",
"description": "Delete the collateral Relationship records based on requestId, facilityId and collateralId.",
"operationId": "deleteCollateralRelationshipsV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "RequestId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/collateralRelationships": {
"put": {
"tags": [
"Collateral"
],
"summary": "Map a collateral to the Facility",
"description": "Create new record with the provided data such as collateralId,requestId, facilityId.",
"operationId": "updateCollateralRelationshipForFacilityV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRelationshipRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents": {
"post": {
"summary": "creates new documents and adds them to deal",
"description": "Create document records with the provided data such as requestId, facilityId and document name etc.",
"operationId": "createDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCreationRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "updates the existing documents data",
"description": "Update document records with the provided data such as requestId, facilityId and document name etc.",
"operationId": "updateDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of documents for the provided criteria",
"description": "Retrieve the document records based on dealId, facilityId and partyId.",
"operationId": "getDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "Collateral Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "documentId",
"in": "query",
"description": "Document Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents/{documentId}": {
"delete": {
"tags": [
"Documents"
],
"summary": "soft delete the document",
"description": "Document record with the provided documentId,requestId,facilityId will be deleted softly.",
"operationId": "deletedocumentV1",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "ID of Document for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives": {
"post": {
"summary": "Create narrative and add to deal",
"description": "Create narrative records with the provided data such as dealId, facilityId , partyId and categoryId etc.",
"operationId": "createNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update narrative",
"description": "Update narrative records with the provided data such as dealId, facilityId, partyId and categoryId etc.",
"operationId": "updateNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Narrative records",
"description": "Retrieves the Narrative records based on dealId, facilityId and partyId.",
"operationId": "getNarrativesV1",
"tags": [
"Narratives"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "Collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives/{narrativeId}": {
"delete": {
"tags": [
"Narratives"
],
"summary": "soft delete the narrative",
"description": "narrative record with the provided narrativeId, will be deleted softly.",
"operationId": "deleteNarrativeV1",
"parameters": [
{
"name": "narrativeId",
"in": "path",
"description": "ID of narrative for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "ID of Request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of Facility",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "ID of Drawing",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/narratives": {
"put": {
"tags": [
"Narratives"
],
"summary": "Update narratives from Facility Overview",
"description": "Update narrative records with the provided data such as facilityId, category,userId etc.",
"operationId": "updateNarrativesFromFOV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/reference/{referenceId}": {
"get": {
"summary": "gets the reference data from reference tables",
"description": "Retrieves the reference data based on the referenceId.",
"operationId": "getRefData",
"tags": [
"Reference Data"
],
"parameters": [
{
"name": "referenceId",
"in": "path",
"description": "Reference Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerRequest": {
"post": {
"summary": "Stores the captured information of the request submission form",
"description": "Create customerRequest records with the provided data such as userId, requestId and customerInformation etc.",
"operationId": "createCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete the captured information of the request submission form",
"description": "Delete customerRequest records with the provided data such as userId, requestId etc.",
"operationId": "deleteCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get all the information associated to the userid and requestid",
"description": "Retrieves customerRequest records based on userId, requestId and status.",
"operationId": "getCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "status",
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "count",
"schema": {
"type": "string"
}
},
{
"name": "orderOfRequest",
"in": "query",
"description": "orderOfRequest",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestsInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerRequest/facilityId": {
"get": {
"summary": "Get the information of inFlightFacilityId from given facilityId",
"description": "Retrieves inFlightFacilityId records based on facilityId.",
"operationId": "getModifiedFacilityInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InFlightFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions": {
"post": {
"summary": "Creates draw restrictions for a particular deal",
"description": "Create drawRestriction records with the provided data such as requestId, facilityId and restrictionType etc.",
"operationId": "createDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Draw restrictions against a deal",
"description": "Update drawRestriction records with the provided data such as requestId, facilityId and restrictionType etc.",
"operationId": "updateDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of draw restrictions against request or facility",
"description": "Retrieves drawRestriction records based on requestId, facilityId.",
"operationId": "getDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions/{drawRestrictionId}": {
"delete": {
"tags": [
"Draw Restrictions"
],
"summary": "soft delete the Draw Restrictions",
"description": "Draw Restrictions record with the provided drawRestrictionId, will be deleted softly.",
"operationId": "deleteDrawRestrictionV1",
"parameters": [
{
"name": "drawRestrictionId",
"in": "path",
"description": "ID of Draw Restrictions for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of Facility",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance": {
"get": {
"summary": "Retrieves the details of the compliance for the provided criteria",
"description": "Retrieves the compliance records based on requestId, facilityId,partyId and complianceId.",
"operationId": "getComplianceV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "complianceId",
"in": "query",
"description": "complaince Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Compliance"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Compliance"
],
"summary": "Add a new compliance to the Deal",
"description": "Create the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "createComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Compliance"
],
"summary": "Update compliance to the Deal",
"description": "Update the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "updateComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance/{complianceId}": {
"delete": {
"tags": [
"Compliance"
],
"summary": "soft delete the compliance",
"description": "Compliance record with the provided complianceId, will be deleted softly.",
"operationId": "deleteComplianceV1",
"parameters": [
{
"name": "complianceId",
"in": "path",
"description": "ID of Compliance for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails": {
"post": {
"summary": "Create funding details",
"description": "Create the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "createFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update fundings Details",
"description": "Update the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "updateFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Funding details",
"description": "Retrieves the funding records based on dealId, facilityId and fundingId.",
"operationId": "getFundingDetailsV1",
"tags": [
"Funding"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fundingId",
"in": "query",
"description": "Funding Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "addressRefrence",
"in": "query",
"description": "reference of address",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails/{fundingId}": {
"delete": {
"tags": [
"Funding"
],
"summary": "soft delete the fundings",
"description": "Fundings record with the provided fundingId, will be deleted softly.",
"operationId": "deleteFundingV1",
"parameters": [
{
"name": "fundingId",
"in": "path",
"description": "ID of funding for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits": {
"post": {
"summary": "Create limit records",
"description": "Create the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "createLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Limit details to the given limit id",
"description": "Update the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "updateLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieve the Limit record",
"description": "Retrieve the Limit record based on limitId.",
"operationId": "getLimitsV1",
"tags": [
"Limits"
],
"parameters": [
{
"name": "limitId",
"in": "query",
"description": "limit Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits/{limitId}": {
"delete": {
"tags": [
"Limits"
],
"summary": "soft delete the limits",
"description": "Limits record with the provided limitId, will be deleted softly.",
"operationId": "deleteLimitsV1",
"parameters": [
{
"name": "limitId",
"in": "path",
"description": "ID of limit for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees": {
"post": {
"summary": "create Fee details to the given facility/deal",
"description": "Create the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "createFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Fee details to the given id",
"description": "Update the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "updateFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Fee details to the given facility id/deal id",
"description": "Retrieve the Fee records based on dealId, facilityId, feeType.",
"operationId": "getFeesV1",
"tags": [
"Fees"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees/{feeId}": {
"delete": {
"tags": [
"Fees"
],
"summary": "soft delete the fees",
"description": "fees record with the provided feeId, will be deleted softly.",
"operationId": "deleteFeesV1",
"parameters": [
{
"name": "feeId",
"in": "path",
"description": "ID of fees for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings": {
"post": {
"summary": "create Pricing details to the given deal/facility",
"description": "Create the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "createPricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Pricing details to the given Pricing id",
"description": "Update the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "updatePricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Pricing details to the given facility id",
"description": "Retrieve the Pricing records based on dealId, facilityId.",
"operationId": "getPricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings/{pricingId}": {
"delete": {
"summary": "delete Pricing details to the given pricing id",
"description": "Delete the Pricing records based on pricing Id.",
"operationId": "deletePricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "pricingId",
"in": "path",
"description": "pricing Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants": {
"post": {
"summary": "Creates covenants for a Deal",
"description": "Create the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "createCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Covenants for a Deal",
"description": "Update the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the details of covenants for the provided criteria",
"description": "Retrieve the Covenant records based on dealId, facilityId, partyId and covenantId.",
"operationId": "getCovenantsV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "covenantId",
"in": "query",
"description": "covenant Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants/{covenantId}": {
"delete": {
"summary": "Delete the covenant record.",
"description": "Delete the covenant record based on covenantId.",
"operationId": "deleteCovenantsV1",
"parameters": [
{
"name": "covenantId",
"in": "path",
"description": "covenant Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/covenants": {
"put": {
"summary": "Update the covenant record from Facility overview.",
"description": "Update the Covenant records From FO with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsFromFOV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions": {
"post": {
"summary": "create credit decisions to the given facility",
"description": "Create the creditDecision records with the provided data such as requestId, facilityId and decisionDate etc.",
"operationId": "createCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditDecisionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update credit decisions to the given creditDecision id",
"description": "Update the creditDecision records with the provided data such as requestId, facilityId and decisionDate etc.",
"operationId": "updateCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDecisionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given facility",
"description": "Retrieve the creditDecision records based on requestId,facilityId and decisionId.",
"operationId": "getCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "decisionId",
"in": "query",
"description": "decision Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/scoreCard": {
"post": {
"summary": "create scorecard to the given facility",
"description": "Create the scorecard record with the provided data such as requestId, facilityId and scores etc.",
"operationId": "createScoreCardV1",
"tags": [
"ScoreCard"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScoreCardList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedScoreCardResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update scorecard to the given scorecard id",
"description": "Update the scorecard records with the provided data such as requestId, facilityId and scorecardId etc.",
"operationId": "updateScoreCardV1",
"tags": [
"ScoreCard"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateScoreCardList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedScoreCardResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the scorecard to the given facility",
"description": "Retrieve the ScoreCard records based on requestId,facilityId and scoreCardId.",
"operationId": "getScoreCardV1",
"tags": [
"ScoreCard"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "scoreCardId",
"in": "query",
"description": "scoreCard Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScoreCardList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/scoreCard/{scoreCardId}": {
"delete": {
"summary": "Delete scorecard to the given scorecard id",
"description": "Delete the scorecard record to given scorecard id.",
"operationId": "deleteScoreCardV1",
"tags": [
"ScoreCard"
],
"parameters": [
{
"name": "scoreCardId",
"in": "path",
"description": "scoreCard Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/riskScoreCard": {
"post": {
"summary": "create riskscorecard to the given entity",
"description": "Create the riskscorecard record with the provided data such as requestId, facilityId and scores etc.",
"operationId": "createRiskScoreCardV1",
"tags": [
"RiskScoreCard"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RiskScoreCardList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedRiskScoreCardResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the scorecard to the given entity",
"description": "Retrieve the ScoreCard records based on requestId,facilityId,partyId and riskScoreCardId.",
"operationId": "getRiskScoreCardV1",
"tags": [
"RiskScoreCard"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lineOfBusiness",
"in": "query",
"description": "lob",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "riskScoreCardId",
"in": "query",
"description": "risk scoreCard Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RiskScoreCardList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions/{creditDecisionId}": {
"delete": {
"summary": "Delete credit decisions to the given creditDecision id",
"description": "Delete the creditDecision record to given creditDecision id.",
"operationId": "deleteCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "creditDecisionId",
"in": "path",
"description": "creditDecision Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/policyExceptions": {
"post": {
"summary": "create policy exceptions to the given facility",
"description": "Create the policyExceptions records with the provided data such as requestId, facilityId and exceptionType etc.",
"operationId": "createPolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExceptionsList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPolicyResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the policy exception to the given facility",
"description": "Retrieve the policy exception records based on facilityId and policyExceptionId.",
"operationId": "getPolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExceptionResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update policy exceptions to the given policyException id",
"description": "Update the PolicyExceptions records with the provided data such as requestId, facilityId and exceptionType etc.",
"operationId": "updatePolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePolicyExceptionsList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPolicyResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/policyExceptions/{policyExceptionId}": {
"delete": {
"summary": "Delete policy exceptions to the given policy id",
"description": "Delete the policy exceptions record to given policy id.",
"operationId": "deletePolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"parameters": [
{
"name": "policyExceptionId",
"in": "path",
"description": "policyException Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/conditions": {
"put": {
"summary": "update condition the given condition id",
"description": "Update the condition records with the provided data such as conditionId, creditDecisionId and etc.",
"operationId": "updateConditionV1",
"tags": [
"Conditions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConditionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedConditionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/conditions/{conditionId}": {
"delete": {
"summary": "Delete the condition for given condition id",
"description": "Delete the condition records with the provided conditionId.",
"operationId": "deleteConditionV1",
"tags": [
"Conditions"
],
"parameters": [
{
"name": "conditionId",
"in": "path",
"description": "Condition Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}": {
"get": {
"summary": "Retrieves the requestOverview details",
"description": "Retrieves the requestOverview details based on requestId.",
"operationId": "getRequestOverviewV1",
"tags": [
"RequestOverView"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure": {
"post": {
"summary": "Create Exposure records",
"description": "Create the Exposure records with the provided data such as partyId, exposureType and exposureUniqueId etc.",
"operationId": "createExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureType",
"in": "query",
"description": "exposureType",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given party",
"description": "Retrieve the exposure records based on partyId and exposureUniqueId.",
"operationId": "getExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "exposureUniqueId",
"in": "query",
"description": "exposureUniqueId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/{facilityId}": {
"get": {
"summary": "Retrieves FacilityOverview details",
"description": "Retrieves FacilityOverview details based on facilityId.",
"operationId": "getFacilityOverviewV1",
"tags": [
"FacilityOverview"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawings/{drawingId}": {
"get": {
"summary": "Retrieves DrawingOverview details",
"description": "Retrieves DrawingOverview details based on drawingId.",
"operationId": "getDrawingOverviewV1",
"tags": [
"DrawingOverview"
],
"parameters": [
{
"name": "drawingId",
"in": "path",
"description": "Drawing Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawingOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasksparams": {
"get": {
"summary": "Retrieves the data related to tasks params",
"description": "Retrieves the task records based on taskStage and taskId.",
"operationId": "getTasksParamsV1",
"tags": [
"TasksParams"
],
"parameters": [
{
"name": "taskStage",
"in": "query",
"description": "Task Stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task ID",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksParamsReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/{partyId}": {
"get": {
"summary": "Retrieves PartyOverview details",
"description": "Retrieves PartyOverview details based on partyId.",
"operationId": "getEntityOverviewV1",
"tags": [
"EntityOverview"
],
"parameters": [
{
"name": "partyId",
"in": "path",
"description": "party Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message/{userId}": {
"post": {
"summary": "creates the messages to the dealId",
"description": "Create the messages records with the provided data such as userId, dealId and messagedescription etc.",
"operationId": "createMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessagesList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message": {
"get": {
"summary": "Retrieve the message records",
"description": "Retrieve the message records based on userId and messageId.",
"operationId": "getMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "messageId",
"in": "query",
"description": "message Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/integrationServices": {
"get": {
"summary": "Retrieves the details of the integrationServices for the provided criteria",
"description": "Retrieves the integrationServices records based on requestId, facilityId,partyId and integrationServicesId.",
"operationId": "getIntegrationServicesV1",
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "integrationServicesId",
"in": "query",
"description": "integrationServices Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"IntegrationServices"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"IntegrationServices"
],
"summary": "Add a new integrationServices to the facility or party",
"description": "Create the integrationService records with the provided data.",
"operationId": "createIntegrationServicesV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedIntegrationServicesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"IntegrationServices"
],
"summary": "Update IntegrationServices to the facility or party",
"description": "Update the integrationService records with the provided data.",
"operationId": "updateIntegrationServicesV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedIntegrationServicesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/integrationServices/{integrationServicesId}": {
"delete": {
"tags": [
"IntegrationServices"
],
"summary": "soft delete the integrationServices",
"description": "IntegrationServices record with the provided integrationServicesId, will be deleted softly.",
"operationId": "deleteIntegrationServicesV1",
"parameters": [
{
"name": "integrationServicesId",
"in": "path",
"description": "ID of IntegrationServices for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/externalServicesHistory": {
"get": {
"summary": "Retrieves the details of the externalServicesHistory for the provided criteria",
"description": "Retrieves the externalServicesHistory records based on requestId, facilityId,partyId and externalServicesHistoryId.",
"operationId": "getExternalServicesHistoryV1",
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "externalServicesHistoryId",
"in": "query",
"description": "externalServicesHistory Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"ExternalServicesHistory"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryResposes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"ExternalServicesHistory"
],
"summary": "Add a new externalServicesHistory to the request",
"description": "Create the externalServicesHistory records with the provided data.",
"operationId": "createExternalServicesHistoryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedExternalServicesHistoryResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"ExternalServicesHistory"
],
"summary": "Update externalServicesHistory to the facility or party",
"description": "Update the externalServicesHistory records with the provided data.",
"operationId": "updateExternalServicesHistoryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedExternalServicesHistoryResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/externalServicesHistory/{externalServicesHistoryId}": {
"delete": {
"tags": [
"ExternalServicesHistory"
],
"summary": "soft delete the externalServicesHistory",
"description": "ExternalServicesHistory record with the provided externalServicesHistoryId, will be deleted softly.",
"operationId": "deleteExternalServicesHistoryV1",
"parameters": [
{
"name": "externalServicesHistoryId",
"in": "path",
"description": "ID of externalServicesHistory for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requestProcessRelation": {
"post": {
"summary": "Creates a new Request Process relationship",
"description": "Creates new requestProcessRelation record with the provided data such as facilityId, parenProcessId and requestId etc.",
"operationId": "createRequestProcessRelationV1",
"tags": [
"RequestProcessRelationship"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestProcessRelations"
}
}
}
},
"responses": {
"200": {
"description": "Create RequestProcessRelation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "RequestProcessRelation Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Request Process relationship",
"description": "Retrieves Request Process relationship record based on the request Id,facility Id, parenProcess Id.",
"operationId": "getRequestProcessRelationV1",
"tags": [
"RequestProcessRelationship"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "parenProcessId",
"in": "query",
"description": "parenProcess Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "RequestProcessRelation retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestProcessRelationResponses"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilityApproverInfo": {
"post": {
"summary": "Creates the Facility Approver Info",
"description": "Creates facility approver info with the provided data such as requestId, facilityId, committeeId and approverUserId etc.",
"operationId": "createFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFacilityApproversInfo"
}
}
}
},
"responses": {
"200": {
"description": "Create FacilityApproverInfo Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityApproverInfoResponse"
}
}
}
},
"400": {
"description": "FacilityApproverInfo Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Facility Approver Info",
"description": "Retrieves facility approver info based on the requestId,facilityId, committeeId",
"operationId": "getFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "FacilityApproverInfo retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityApproversInfo"
}
}
}
},
"400": {
"description": "FacilityApproverInfo Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Facility Approver Info",
"description": "Update the Facility Approver Info with the provided data",
"operationId": "updateFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityApproversInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityApproverInfoResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilityApproverInfo/{rowId}": {
"delete": {
"summary": "Delete the Facility Approver Info",
"description": "facilityApproverInfo will be deleted with the provided rowId",
"operationId": "deleteFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"parameters": [
{
"name": "rowId",
"in": "path",
"description": "ID of row for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/momInfo": {
"post": {
"summary": "Creates the MOM Info",
"description": "Creates minutes of meeting info with the provided data such as requestId, committeeId and approverUserId etc.",
"operationId": "createMomInfoV1",
"tags": [
"MomInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMomInfos"
}
}
}
},
"responses": {
"200": {
"description": "Create MomInfo Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedMomInfoResponse"
}
}
}
},
"400": {
"description": "MomInfo Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Mom Info",
"description": "Retrieves minutes of meeting info based on the requestId and committeeId",
"operationId": "getMomInfoV1",
"tags": [
"MomInfo"
],
"parameters": [
{
"name": "rowId",
"in": "query",
"description": "Row Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "committeeId",
"in": "query",
"description": "Committee Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "MomInfo retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MomInfos"
}
}
}
},
"400": {
"description": "MomInfo Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditCommitteeInfo": {
"post": {
"summary": "Creates the Credit Committee Info",
"description": "Creates credit Committee info with the provided data",
"operationId": "createCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeRequests"
}
}
}
},
"responses": {
"200": {
"description": "Create CreditCommitteeInfo Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditCommitteeResponse"
}
}
}
},
"400": {
"description": "Credit Committee Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Credit Committee Info",
"description": "Retrieves credit Committee info",
"operationId": "getCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"parameters": [
{
"name": "committeeId",
"in": "query",
"description": "Committee Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "committeeName",
"in": "query",
"description": "Committee Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "CreditCommiteeInfo retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeResponses"
}
}
}
},
"400": {
"description": "CreditCommitteeInfo Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Credit Committee Info",
"description": "Update the Credit Committee Info with the provided data",
"operationId": "updateCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditCommitteeResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditCommitteeInfo/{committeeId}": {
"delete": {
"summary": "Delete the Credit Committee Info",
"description": "creditCommittee will be deleted with the provided committeeId",
"operationId": "deleteCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"parameters": [
{
"name": "committeeId",
"in": "path",
"description": "ID of Committee for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/recentViewedRequestInfo": {
"post": {
"summary": "Create Recently Viewed Request",
"description": "Recently Viewed Requests by a user added",
"operationId": "createRecentViewedRequestInfoV1",
"tags": [
"RecentlyViewedRequest"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecentViewedInputRequest"
}
}
}
},
"responses": {
"200": {
"description": "Recently Viewed Request Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecentViewedRequestSuccessResponse"
}
}
}
},
"400": {
"description": "Recently Viewed Request Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get Recently Viewed Request",
"description": "Retrieves Recently viewed Request info",
"operationId": "getRecentViewedRequestInfoV1",
"tags": [
"RecentlyViewedRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "User Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "noOfDays",
"in": "query",
"description": "Duration of records to be retrived",
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "count of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "orderOfRequest",
"in": "query",
"description": "order of requests to be displayed",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Recent Review Request retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecentViewedRequestResponses"
}
}
}
},
"400": {
"description": "RecentReviewRequest Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/renewal": {
"post": {
"summary": "Update PartyId in all LOS tables",
"description": "parties renewal will update the valid partyId in all LOS tables for the request",
"operationId": "partyRenewV1",
"tags": [
"PartyUpdate"
],
"parameters": [
{
"name": "nonVerifiedPartyId",
"in": "query",
"description": "ID before party was verified",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verifiedPartyId",
"in": "query",
"description": "ID after party was verified",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Id of the request",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerActions": {
"post": {
"summary": "Creates Customer Action",
"description": "creates customer actions with provided details such as customerActionName, customerActionType",
"operationId": "createCustomerActionsV1",
"tags": [
"CustomerActions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Customer Action for the given CustomerActionIds",
"description": "Updates customer actions with provided details such as customerActionStatus, responseValues",
"operationId": "updateCustomerActionsV1",
"tags": [
"CustomerActions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerActions/task/{taskId}": {
"get": {
"summary": "Gets the customer action",
"description": "Gets the customer actions data based on the taskId and customerActionStatus",
"operationId": "getCustomerActionsByTaskV1",
"tags": [
"CustomerActions"
],
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "Task Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "customerActionStatus",
"in": "query",
"description": "Status of the customer action",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsByTaskResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerActions/request/{requestId}": {
"get": {
"summary": "Gets the customer action",
"description": "Gets the customer actions data based on the taskId and customerActionStatus",
"operationId": "getCustomerActionsByRequestV1",
"tags": [
"CustomerActions"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "customerActionName",
"in": "query",
"description": "CustomerAction Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appliesToId",
"in": "query",
"description": "appliesToId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "customerActionStatus",
"in": "query",
"description": "Status of the Customer Action",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsByRequestResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerActions/{customerActionId}": {
"delete": {
"summary": "soft delete the customer action",
"description": "customer action record for the provided customerActionId will be deleted softly.",
"operationId": "deleteCustomerActionsV1",
"tags": [
"CustomerActions"
],
"parameters": [
{
"name": "customerActionId",
"in": "path",
"description": "Customer Action Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/AdditionalInstructions": {
"post": {
"summary": "Creates Additional Instruction",
"description": "creates Additional Instructions with provided details such as instructionDate, instructionType",
"operationId": "createAdditionalInstructionsV1",
"tags": [
"AdditionalInstructions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInstructionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedAdditionalInstructionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Additional Instructions for the given additionalInstructionIds",
"description": "Updates Additional Instructions with provided details such as instructionType, bank details",
"operationId": "updateAdditionalInstructionsV1",
"tags": [
"AdditionalInstructions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInstructionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedAdditionalInstructionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Additional Instruction details",
"description": "Retrieves the Additional Instruction records based on facilityId and additionalInstructionId.",
"operationId": "getAdditionalInstructionsV1",
"tags": [
"AdditionalInstructions"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "additionalInstructionId",
"in": "query",
"description": "Additional Instruction Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInstructionsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/AdditionalInstructions/{additionalInstructionId}": {
"delete": {
"tags": [
"AdditionalInstructions"
],
"summary": "soft delete the Additional Instructions",
"description": "Additional Instructions record with the provided additionalInstructionId, will be deleted softly.",
"operationId": "deleteAdditionalInstructionsV1",
"parameters": [
{
"name": "additionalInstructionId",
"in": "path",
"description": "ID of Additional Instruction for the delete request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingPosition": {
"post": {
"summary": "Create a funding position for the given facility",
"description": "Create a funding position record with the source of funds and use of funds for the given facility",
"operationId": "createFundingPositionV1",
"tags": [
"FundingPosition"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingPositionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update a funding position for the given facility",
"description": "Update a funding position record with the source of funds and use of funds for the given facility",
"operationId": "updateFundingPositionV1",
"tags": [
"FundingPosition"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingPositionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the funding position record",
"description": "Retrieves funding position record based on the request Id or facility Id",
"operationId": "getFundingPositionV1",
"tags": [
"FundingPosition"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingPositionResponse"
}
}
}
},
"400": {
"description": "Failure response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingPosition/{facilityId}": {
"delete": {
"summary": "Delete funding position record belonging to a facility",
"description": "Delete funding position record based on facilityId.",
"operationId": "deleteFundingPositionV1",
"tags": [
"FundingPosition"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawings": {
"post": {
"summary": "Create drawing for the given facility",
"description": "Create drawing records with the provided data such as facilityId, drawingId , drawingName and drawingType etc.",
"operationId": "createDrawingsV1",
"tags": [
"Drawings"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawingsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawingsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update drawing details of the facility",
"description": "Update drawing records with the provided data such as facilityId, drawingId , drawingName and drawingType etc.",
"operationId": "updateDrawingsV1",
"tags": [
"Drawings"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawingsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawingsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Drawing records of a facility",
"description": "Retrieves the Drawing records based on facilityId and drawingId.",
"operationId": "getDrawingsV1",
"tags": [
"Drawings"
],
"parameters": [
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawingsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/paymentSchedule": {
"post": {
"summary": "Create paymentSchedule for the given drawing",
"description": "Create paymentSchedule records with the provided data such as facilityId, drawingId , simulations etc.",
"operationId": "createPaymentScheduleV1",
"tags": [
"PaymentSchedule"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentScheduleRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPaymentScheduleResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update paymentSchedule details of the drawing",
"description": "Update drawing records with the provided data such as facilityId, drawingId , simulations etc.",
"operationId": "updatePaymentScheduleV1",
"tags": [
"PaymentSchedule"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentScheduleRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPaymentScheduleResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the PaymentScheduleRequests records of a Drawing",
"description": "Retrieves the Drawing records based on facilityId,requestId,scheduleId drawingId.",
"operationId": "getPaymentScheduleV1",
"tags": [
"PaymentSchedule"
],
"parameters": [
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "scheduleId",
"in": "query",
"description": "Schedule Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentScheduleResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/paymentSchedule/{scheduleId}": {
"delete": {
"summary": "Delete payment schedule record belonging to a scheduleId",
"description": "Delete payment schedule record based on scheduleId.",
"operationId": "deletePaymentScheduleV1",
"tags": [
"PaymentSchedule"
],
"parameters": [
{
"name": "scheduleId",
"in": "path",
"description": "schedule Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/notary": {
"post": {
"summary": "creates the Notary to the facilityId",
"description": "Create the Notary records with the provided data such as facilityId,requestId,Notary Name,Date of Deed,Comment,Status of Deed etc.",
"operationId": "createNotaryV1",
"tags": [
"Notarys"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotarysRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotarysResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieve the Notary records",
"description": "Retrieve the Notary records based on RequestId,facilityId and notaryId.",
"operationId": "getNotaryV1",
"tags": [
"Notarys"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notaryId",
"in": "query",
"description": "notary Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetNotarysResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Notarys"
],
"summary": "Update Notary to the facility",
"description": "Update the compliance records with the provided data such as facilityId,requestId,Notary Name,Date of Deed,Comment,Status of Deed etc.",
"operationId": "updateNotaryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNotarysRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotarysResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/notary/{notaryId}": {
"delete": {
"tags": [
"Notarys"
],
"summary": "soft delete the Notary",
"description": "Notary record with the provided notaryId, will be deleted softly.",
"operationId": "deleteNotaryV1",
"parameters": [
{
"name": "notaryId",
"in": "path",
"description": "ID of Notary for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/consent": {
"post": {
"summary": "Create a consent for given request",
"description": "Create a consent record with provided data for the given request",
"operationId": "createConsentV1",
"tags": [
"Consent"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentData"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the consent record",
"description": "Retrieves consent record based on the request Id or party Id",
"operationId": "getConsentV1",
"tags": [
"Consent"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "consentId",
"in": "query",
"description": "Consent Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentData"
}
}
}
},
"400": {
"description": "Failure response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update a consent for the given request",
"description": "Update a consent record with provided data for the given request",
"operationId": "updateConsentV1",
"tags": [
"Consent"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentData"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/consent/{consentId}": {
"delete": {
"summary": "soft delete the consent",
"description": "consent record for the provided consentId will be deleted softly.",
"operationId": "deleteConsentV1",
"tags": [
"Consent"
],
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Consent Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/consent/{expiryDate}": {
"get": {
"summary": "Retrieves the expired consent records",
"description": "Retrieves consent record based on the expiryDate",
"operationId": "getExpiredConsentsV1",
"tags": [
"Consent"
],
"parameters": [
{
"name": "expiryDate",
"in": "path",
"description": "Expiry Date",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentData"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"UpdateNotaryRequest": {
"properties": {
"notaryId": {
"description": "Notary Id",
"example": "NTY202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"requestId": {
"description": "Request Id",
"example": "R202012345678",
"type": "string"
},
"notaryName": {
"description": "Notary Name",
"example": "desc 123",
"type": "string"
},
"dateOfDeed": {
"description": "Date of Deed",
"example": "desc 123",
"type": "string"
},
"comments": {
"description": "Comments",
"example": "desc 123",
"type": "string"
},
"status": {
"description": "Status",
"example": "desc 123",
"type": "string",
"x-referencetype": "MortgageNotaryStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateNotarysRequest": {
"properties": {
"notarys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateNotaryRequest"
}
}
}
},
"CreateNotaryRequest": {
"properties": {
"requestId": {
"description": "Request Id",
"example": "R202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"dateOfDeed": {
"description": "Date of Deed",
"example": "desc 123",
"type": "string"
},
"comments": {
"description": "Comments",
"example": "desc 123",
"type": "string"
},
"status": {
"description": "Status",
"example": "desc 123",
"type": "string",
"x-referencetype": "MortgageNotaryStatus"
},
"notaryName": {
"description": "Notary Name",
"example": "desc 123",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateNotarysRequest": {
"properties": {
"notarys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateNotaryRequest"
}
}
}
},
"CreateNotarysResponse": {
"properties": {
"notaryId": {
"description": "notary Id",
"example": "NTY202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"GetNotaryResponse": {
"properties": {
"notaryId": {
"description": "Notary Id",
"example": "NTY202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"dateOfDeed": {
"description": "Date of Deed",
"example": "desc 123",
"type": "string"
},
"requestId": {
"description": "Request Id",
"example": "R202012345678",
"type": "string"
},
"notaryName": {
"description": "Notary Name",
"example": "desc 123",
"type": "string"
},
"comments": {
"description": "Comments",
"example": "desc 123",
"type": "string"
},
"status": {
"description": "Status",
"example": "desc 123",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangedTime": {
"description": "Last Change Time",
"example": "true",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"GetNotarysResponse": {
"properties": {
"notarys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetNotaryResponse"
}
}
}
},
"FailureMessage": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"StandardErrorResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailureMessage"
}
},
"ProcessedFacilityResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityCreateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "01",
"type": "string"
},
"facilityId": {
"description": "Temperory id of the facility from onboarding",
"example": "T1234567",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"availableAmount": {
"description": "amount available for restriction",
"example": "5000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security coverage",
"example": "2356789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string",
"x-referencetype": "ApprovalStatus"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization unit Id",
"example": "20",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"approvedAmount": {
"description": "Approved Amount of Facility",
"example": "20000.00",
"type": "string",
"format": "decimal"
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"previousFacilityId": {
"description": "Previous id of the facility from onboarding",
"example": "T1234567909",
"type": "string"
},
"previousLoanAmount": {
"description": "Total amount of the Previous Loan",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"previousMaturityDate": {
"description": "Previous maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"approvedMaturityDate": {
"description": "Approved maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"paidAmount": {
"description": "Amount Paid",
"example": 10250022,
"type": "integer",
"format": "decimal"
},
"amendmentTypes": {
"description": "amendment Types Id",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityUpdateRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "03",
"type": "string"
},
"availableAmount": {
"description": "amount available for restriction",
"example": "5000",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security Coverage",
"example": "2356789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "01",
"type": "string",
"x-referencetype": "AcceptanceStatus"
},
"accountNumber": {
"description": "Account Number",
"example": "12345656565",
"type": "string"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string",
"x-referencetype": "ApprovalStatus"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"approvedAmount": {
"description": "Approved Amount of Facility",
"example": "20000.00",
"type": "string",
"format": "decimal"
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"previousFacilityId": {
"description": "Previous id of the facility from onboarding",
"example": "T1234567909",
"type": "string"
},
"previousLoanAmount": {
"description": "Total amount of the Previous Loan",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"previousMaturityDate": {
"description": "Previous maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"approvedMaturityDate": {
"description": "Approved maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"paidAmount": {
"description": "Amount Paid",
"example": 10250022,
"type": "integer",
"format": "decimal"
},
"amendmentTypes": {
"description": "Amendment Types ",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "Line of Credit",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"availableAmount": {
"description": "amount available for restriction",
"example": "5000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "Working Capital",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "Awaiting Approval",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security Coverage",
"example": "3456789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"accountNumber": {
"description": "Account Number",
"example": "2232323322",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "Approved",
"type": "string"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"previousFacilityId": {
"description": "Previous id of the facility from onboarding",
"example": "T1234567909",
"type": "string"
},
"previousLoanAmount": {
"description": "Total amount of the Previous Loan",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"paidAmount": {
"description": "Amount Paid",
"example": 10250022,
"type": "integer",
"format": "decimal"
},
"previousMaturityDate": {
"description": "Previous maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"approvedMaturityDate": {
"description": "Approved maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"amendmentTypes": {
"description": "Amendment Types ",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
},
"approvedAmount": {
"description": "Approved Amount of Facility",
"example": "20000.00",
"type": "string",
"format": "decimal"
}
}
},
"FacilityCreateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
}
}
},
"FacilityUpdateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityUpdateRequest"
}
}
}
},
"FacilityResponses": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"RelatedPartiesSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
},
"rowId": {
"description": "Specifies RowId of the request",
"example": "R1234,R1290",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRelatedPartiesRequest": {
"properties": {
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateRelatedPartiesRequest": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "D202012345678",
"type": "string"
},
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related Party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RelatedPartiesResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "12345678",
"type": "string"
},
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "Guarantor",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "Amount",
"type": "string"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
}
}
},
"UpdateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequest"
}
}
}
},
"RelatedPartiesResponses": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
}
}
},
"ProcessedTasksResponse": {
"properties": {
"taskId": {
"description": "Unique identifier for Task",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"NoteItem": {
"properties": {
"noteDescription": {
"description": "description notes",
"example": "task notes",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"TasksRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskProvider"
},
"taskPackage": {
"description": "Package of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPackage"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskCategory"
},
"taskType": {
"description": "Type of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskType"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPriority"
},
"extensionData": {
"type": "object"
}
}
},
"TasksResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "Moody's",
"type": "string"
},
"taskPackage": {
"description": "Package of the task",
"example": "Fraud-Check",
"type": "string"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "Prescreening",
"type": "string"
},
"taskType": {
"description": "Type of the task",
"example": "Auto",
"type": "string"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "In-Process",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "medium",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"TasksRequests": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksRequest"
}
}
}
},
"TasksResponses": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"CollateralOverview": {
"properties": {
"collateralId": {
"description": "unique Identifier of collateral",
"example": "C123",
"type": "string"
},
"collateralName": {
"description": "Name of the collateral",
"example": "property",
"type": "string"
},
"collateralType": {
"description": "type of collateral",
"example": "01",
"type": "string"
},
"collateralSubType": {
"description": "subtype of collateral",
"example": "001",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of collateral",
"example": "5",
"type": "string"
},
"collateralStatus": {
"description": "status of the collateral",
"example": "02",
"type": "string",
"x-referencetype": "CollateralStatus"
},
"advancedRate": {
"description": "advanced rate of collateral",
"example": "30",
"type": "string"
},
"salvageCurrency": {
"description": "currency ofsalvage value",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"salvageValue": {
"description": "salvage value of collateral",
"example": "30",
"type": "string"
},
"owner": {
"description": "owner of collateral",
"example": "abc",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of collateral",
"example": "abc",
"type": "string"
},
"additionalOwners": {
"description": "additional owners of collateral",
"example": "abc",
"type": "string"
},
"adjustedCollateralCurrency": {
"description": "currency value of the adjusted collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedCollateralValue": {
"description": "adjusted value of the collateral",
"example": "property",
"type": "string"
},
"isInsuranceRequired": {
"description": "insurance required for the collateral",
"example": "yes",
"type": "string"
},
"collateralSource": {
"description": "source of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralSource"
},
"propertyCostCurrency": {
"description": "currency of the Property Cost",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"propertyCost": {
"description": "Property Cost",
"example": "10000",
"type": "integer",
"format": "decimal"
}
}
},
"CollateralDetail": {
"properties": {
"description": {
"description": "description of collateral",
"example": "vehicle",
"type": "string"
},
"usage": {
"description": "usage of the collateral",
"example": "01",
"type": "string"
},
"usageRestriction": {
"description": "usageRestriction of collateral",
"example": "01",
"type": "string"
},
"usageDetails": {
"description": "usageDetails of the collateral",
"example": "property",
"type": "string"
},
"propertyType": {
"description": "property Type of collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralPropertyType"
},
"propertyStatus": {
"description": "property status of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralPropertyStatus"
},
"yearsOfConstruction": {
"description": "years of construction for the collateral",
"example": "3",
"type": "string"
},
"size": {
"description": "size of the collateral",
"example": "30sqft",
"type": "string"
},
"builtUpArea": {
"description": "built up area of the collateral",
"example": "200sqft",
"type": "string"
},
"underLease": {
"description": "is the collateral under lease",
"example": "yes",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of the collateral",
"example": "xyz",
"type": "string"
},
"plan": {
"description": "plan of the collateral",
"example": "xyz",
"type": "string"
},
"section": {
"description": "section of the collateral",
"example": "abc",
"type": "string"
},
"plotNo": {
"description": "plot no of the collateral",
"example": "34",
"type": "string"
},
"registrationDate": {
"description": "registration date of the collateral",
"example": "04-04-2020",
"type": "string"
},
"landRegistryNumber": {
"description": "registration Number of the land",
"example": "12345",
"type": "string"
},
"landRegistryDistrict": {
"description": "registration Number of the land",
"example": "medak",
"type": "string"
},
"mortgageRegistrationNumber": {
"description": "registration number of mortgage",
"example": "1234",
"type": "string"
},
"mortgageRegistrationDate": {
"description": "registration date of mortgage",
"example": "04-04-2020",
"type": "string"
},
"mortgageRank": {
"description": "rank of mortgage",
"example": "first",
"type": "string"
},
"pariPassu": {
"description": "pariPassu detail of the collateral",
"example": "abc",
"type": "string"
},
"pariPassuPercentage": {
"description": "pariPassu detail of the collateral",
"example": "50",
"type": "string"
},
"occupancy": {
"description": "occupancy detail of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralOccupancy"
},
"country": {
"description": "country of the collateral",
"example": "India",
"type": "string"
},
"city": {
"description": "city of the collateral",
"example": "hyderabad",
"type": "string"
},
"state": {
"description": "state of the collateral",
"example": "Telangana",
"type": "string"
},
"address1": {
"description": "address1 of the collateral",
"example": "first street",
"type": "string"
},
"address2": {
"description": "address2 of the collateral",
"example": "second street",
"type": "string"
},
"postalCode": {
"description": "postalCode of the collateral",
"example": "200010",
"type": "string"
},
"newOrUsed": {
"description": "new or used collateral",
"example": "new",
"type": "string"
},
"year": {
"description": "year of manufacture",
"example": "3",
"type": "string"
},
"manufacturer": {
"description": "manufacturer of the collateral",
"example": "philips",
"type": "string"
},
"make": {
"description": "make of the collateral",
"example": "make",
"type": "string"
},
"usefulLife": {
"description": "usefulLife of the collateral",
"example": "3",
"type": "string"
},
"model": {
"description": "model of the collateral",
"example": "Z125",
"type": "string"
},
"issuerName": {
"description": "issuer name of the collateral",
"example": "200010",
"type": "string"
},
"documentNumber": {
"description": "document number of the collateral",
"example": "PAWD123",
"type": "string"
},
"dateOfIssue": {
"description": "date of issue of the collateral document",
"example": "02-02-2020",
"type": "string"
},
"placeOfIssue": {
"description": "place of Issue of the collateral",
"example": "hyderabad",
"type": "string"
},
"expiryDate": {
"description": "expiry date of the document of the collateral",
"example": "200010",
"type": "string"
},
"securityName": {
"description": "name of the security of the collateral",
"example": "abc",
"type": "string"
},
"securityId": {
"description": "security Id of the collateral",
"example": "Z125",
"type": "string"
},
"isincusip": {
"description": "isin/cusip of the collateral",
"example": "I234",
"type": "string"
},
"quantity": {
"description": "quantity of the collateral",
"example": "half",
"type": "string"
},
"costPriceCurrency": {
"description": "currency value of the costPrice collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"costPrice": {
"description": "cost Price of the collateral",
"example": "60000",
"type": "string"
},
"industry": {
"description": "industry of the collateral",
"example": "motor",
"type": "string"
},
"insuredCustomer": {
"description": "insured customer of the collateral",
"example": "abc",
"type": "string"
},
"chassisNumber": {
"description": "chassisNumber of the vehicle",
"example": "C123",
"type": "string"
},
"engineNumber": {
"description": "engineNumber of the vehicle",
"example": "E1234",
"type": "string"
},
"policyNumber": {
"description": "policy number of the collateral",
"example": "P1234",
"type": "string"
},
"insuredPremiumAmountCurrency": {
"description": "currency value of the insuredPremiumAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"insuredPremiumAmount": {
"description": "insured premium amount of the collateral",
"example": "60000",
"type": "string"
},
"accountNumber": {
"description": "account Number",
"example": "HDFC123",
"type": "string"
},
"bankName": {
"description": "bank name",
"example": "HDFC",
"type": "string"
},
"currentInterestRate": {
"description": "current interest rate",
"example": "10",
"type": "string"
},
"openingDate": {
"description": "opening date",
"example": "04-04-2020",
"type": "string"
},
"interestRateAsOf": {
"description": "interest rate as of",
"example": "10",
"type": "string"
},
"maturityDate": {
"description": "maturity date of the collateral",
"example": "04-04-2020",
"type": "string"
},
"contractStartDate": {
"description": "contract start date",
"example": "10-10-2020",
"type": "string"
},
"contractExpiryDate": {
"description": "contract expiry date",
"example": "04-04-2020",
"type": "string"
},
"stockType": {
"description": "type of stock",
"example": "new",
"type": "string"
},
"stockQuantity": {
"description": "quantity Of stock",
"example": "100 kg",
"type": "string"
},
"debtorOutstandingCurrency": {
"description": "currency value of the debtorOutstanding collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"debtorOutstanding": {
"description": "outStanding from debtors",
"example": "10000000",
"type": "string"
},
"creditorOutstandingCurrency": {
"description": "currency value of the creditorOutstanding collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"creditorOutstanding": {
"description": "outstanding from creditor",
"example": "049020",
"type": "string"
},
"mortgagePropertyType": {
"description": "Property type of Mortgage collateral",
"example": "01",
"type": "string",
"x-referencetype": "MortgagePropertyType"
},
"propertySubType": {
"description": "Property subtype of Mortgage collateral",
"example": "01",
"type": "string",
"x-referencetype": "MortgagePropertySubType"
},
"furnishedType": {
"description": "Furnished type of Mortgage collateral",
"example": "01",
"type": "string",
"x-referencetype": "FurnishedType"
},
"propertyAge": {
"description": "Property age of Mortgage collateral",
"example": "10",
"type": "string"
},
"mortgagePropertyStatus": {
"description": "Property status of Mortgage collateral",
"example": "01",
"type": "string",
"x-referencetype": "MortgagePropertyStatus"
},
"constructionCompletionDate": {
"description": "Construction Completion Date of Mortgage collateral Property",
"example": "yyyy-mm-dd",
"type": "string",
"format": "date"
},
"numberOfFloors": {
"description": "Number Of Floors of Mortgage collateral Property",
"example": "5",
"type": "string"
},
"sellerName": {
"description": "Seller name of Mortgage collateral",
"example": "Andrew",
"type": "string"
},
"expectedConstructionCompletionDate": {
"description": "expected Construction Completion Date of Mortgage collateral Property",
"example": "yyyy-mm-dd",
"type": "string",
"format": "date"
},
"propertyUsage": {
"description": "Property usage of Mortgage collateral Property",
"example": "01",
"type": "string",
"x-referencetype": "PropertyUsage"
},
"doorNumber": {
"description": "Door Number of Mortgage collateral Property",
"example": "101",
"type": "string"
},
"floorNumber": {
"description": "Floor Number of Mortgage collateral Property",
"example": "2",
"type": "string"
}
}
},
"CollateralDueDiligence": {
"properties": {
"nextValuationDate": {
"description": "next valuation date",
"example": "04-04-2020",
"type": "string"
},
"insuranceCompany": {
"description": "insurance company",
"example": "LIC",
"type": "string"
},
"requiredCoverage": {
"description": "required coverage",
"example": "02",
"type": "string",
"x-referencetype": "CollateralRequiredCoverage"
},
"agentName": {
"description": "name of the agent",
"example": "xyz",
"type": "string"
},
"policyNumber": {
"description": "policy number",
"example": "P1234",
"type": "string"
},
"coverageAmountCurrency": {
"description": "currency value of the coverageAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"coverageAmount": {
"description": "amount of coverage",
"example": "400000",
"type": "string"
},
"agentPhone": {
"description": "phone number of agent",
"example": "04042020",
"type": "string"
},
"policyType": {
"description": "policy type",
"example": "LIC",
"type": "string"
},
"deductableAmountCurrency": {
"description": "currency value of the coverageAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"deductableAmount": {
"description": "deductable amount",
"example": "5000000",
"type": "string"
},
"agentEmail": {
"description": "email of the agent",
"example": "xyz@temenos.com",
"type": "string"
},
"expirationDate": {
"description": "expiration date",
"example": "04-04-2020",
"type": "string"
},
"additionalInsured": {
"description": "additionalInsured",
"example": "yes",
"type": "string"
},
"registration": {
"description": "registration",
"example": "LIC",
"type": "string"
},
"registrationLocation": {
"description": "registration Location",
"example": "hyderabad",
"type": "string"
},
"registrationExpiryDate": {
"description": "registrationexpiryDate",
"example": "02-02-2020",
"type": "string"
},
"liabiltyCoverageAmount": {
"description": "coverage amount of liability",
"example": "04042020",
"type": "string"
},
"personalInjuryCoverageAmount": {
"description": "coverage amount of personal injury",
"example": "1000000",
"type": "string"
},
"collisionCoverageAmount": {
"description": "coverage amount of collision",
"example": "1000000",
"type": "string"
},
"valuations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueRequest"
}
},
"otherDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OtherDueDiligenceRequest"
}
}
}
},
"ValueRequest": {
"properties": {
"valuationDate": {
"description": "date of report",
"example": "04-04-2020",
"type": "string"
},
"valuationValueCurrency": {
"description": "currency value of the valuationValue collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"valuationValue": {
"description": "value",
"example": "100000",
"type": "string"
},
"valuationSource": {
"description": "source of report",
"example": "ABC corporation",
"type": "string"
},
"valuationDocumentId": {
"description": "Id of the report",
"example": "R1234",
"type": "string"
},
"valuationDocumentName": {
"description": "Name of the report",
"example": "Audit",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"OtherDueDiligenceRequest": {
"properties": {
"dueDelligencedate": {
"description": "date of report",
"example": "04-04-2020",
"type": "string"
},
"dueDelligenceType": {
"description": "type",
"example": "01",
"type": "string",
"x-referencetype": "CollateralTypeDueDiligence"
},
"dueDelligenceStatus": {
"description": "status of report",
"example": "ABC corporation",
"type": "string",
"x-referencetype": "CollateralStatusDueDiligence"
},
"dueDelligenceDocumentId": {
"description": "Id of the report",
"example": "R1234",
"type": "string"
},
"dueDelligenceDocumentName": {
"description": "Name of the report",
"example": "Audit",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRequest": {
"properties": {
"comments": {
"description": "comments on Collateral",
"example": "this property is shared",
"type": "string"
},
"partyId": {
"description": "partyId",
"example": "the party of the collateral",
"type": "string"
},
"externalReferenceId": {
"description": "external Reference Id",
"example": "CO21085YN701",
"type": "string"
},
"collateralOverview": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralOverview"
}
]
},
"collateralDetail": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDetail"
}
]
},
"collateralDueDiligence": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDueDiligence"
}
]
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the collateral",
"example": "lata123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralResponse": {
"properties": {
"comments": {
"description": "comments on Collateral",
"example": "this property is shared",
"type": "string"
},
"partyId": {
"description": "partyId",
"example": "the party of the collateral",
"type": "string"
},
"externalReferenceId": {
"description": "external Reference Id",
"example": "CO21085YN701",
"type": "string"
},
"collateralOverview": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralOverview"
}
]
},
"collateralDetail": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDetail"
}
]
},
"collateralDueDiligence": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDueDiligence"
}
]
},
"collateralRelationshipResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipsResponse"
}
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the collateral",
"example": "lata123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the collateral was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRequests": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
}
}
},
"CollateralResponses": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
}
}
},
"ProcessedCollateralResponse": {
"properties": {
"partyId": {
"description": "Unique identifier for party",
"example": "P202035269718",
"type": "string"
},
"collateralId": {
"description": "Collateral id",
"example": "C202035292905",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipRequest": {
"properties": {
"collateralId": {
"description": "Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"requestId": {
"description": "Identifier of Request",
"example": "R202104218237",
"type": "string"
},
"facilityId": {
"description": "Identifier of Facility",
"example": "F12345678623",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral Relationship",
"example": "1001",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipRequests": {
"properties": {
"collateralRelationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipRequest"
}
}
}
},
"CollateralRelationshipsResponse": {
"properties": {
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"requestId": {
"description": "Unique Identifier of Request",
"example": "R202035269718",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F200722894832",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral Relationship",
"example": "1001",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeDateTime": {
"description": "Date when the Collateral Relationship was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipsResponses": {
"properties": {
"collateralRelationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipsResponse"
}
}
}
},
"DocumentCreationRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentTypeList"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategoryList"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"isSystemGenerated": {
"description": "System generated documents identifier",
"example": "true",
"type": "string"
},
"appliesTo": {
"description": "Applies To Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentAppliesToCategory"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDocumentsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D2020123456",
"type": "string"
},
"documentId": {
"description": "Unique identifier for Document",
"example": "123456789",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentUpdateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier for Document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentTypeList"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategoryList"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"isSystemGenerated": {
"description": "System generated documents identifier",
"example": "true",
"type": "string"
},
"appliesTo": {
"description": "Applies To Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentAppliesToCategory"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "Terms Sheet",
"type": "string"
},
"documentCategory": {
"description": "Category of a document",
"example": "Entity",
"type": "string"
},
"documentStatus": {
"description": "Status of a document",
"example": "Approved",
"type": "string"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"isSystemGenerated": {
"description": "System generated documents identifier",
"example": "true",
"type": "string"
},
"appliesTo": {
"description": "Applies To Category of a document",
"example": "03",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentCreationRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
}
}
},
"DocumentUpdateRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentUpdateRequest"
}
}
}
},
"DocumentResponses": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
}
},
"FacilityTerm": {
"properties": {
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateDealSchema": {
"properties": {
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string"
},
"usageId": {
"description": "Usage of the deal",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"sourceOfApplication": {
"description": "The channel application is sourced",
"example": "Internal - Origination",
"type": "string",
"x-referencetype": "ApplicationSource"
},
"facilityList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
},
"relatedPartiesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
},
"documentsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
},
"collateralsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"lastChangeUserId": {
"description": "last Modification made by user on Requests",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a Request",
"example": "ABC Corp",
"type": "string"
},
"requestStatus": {
"description": "status of a Request",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"activeProcessId": {
"description": "Active Process for Request",
"example": "1",
"type": "string"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
},
"approvedAmount": {
"description": "Approved Amount of Request",
"example": "20000.00",
"type": "string",
"format": "decimal"
}
}
},
"DealCreationResponse": {
"properties": {
"requestId": {
"description": "Request ID of the Deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "D487598",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "200722894",
"type": "string"
},
"collateralId": {
"description": "ID of the collateral created for this request",
"example": "200722894",
"type": "string"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"status": {
"description": "Status of the deal",
"example": "Created",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateDealSchema": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"requestStatus": {
"description": "Status of the deal",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"withdrawalReasonType": {
"description": "Withdrawl reason type of the deal",
"example": "01",
"type": "string",
"x-referencetype": "WithdrawalReasonType"
},
"withdrawalReason": {
"description": "Reason for withdrawl",
"example": "Free text",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"extensionData": {
"type": "object"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"sourceOfApplication": {
"description": "The channel application is sourced",
"example": "Internal - Origination",
"type": "string",
"x-referencetype": "ApplicationSource"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
},
"approvedAmount": {
"description": "Approved Amount of Request",
"example": "20000.00",
"type": "string",
"format": "decimal"
}
}
},
"DealUpdatedResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"DealDetailsResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"requestStatus": {
"description": "Status of the deal",
"example": "Submitted",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"withdrawalReasonType": {
"description": "Type of reason for withdrawal ",
"example": "02",
"type": "string"
},
"withdrawalReason": {
"description": "Reason for withdrawal",
"example": "Free text enterd by customer as reason ",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"extensionData": {
"type": "object"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"sourceOfApplication": {
"description": "The channel application is sourced",
"example": "Internal - Origination",
"type": "string",
"x-referencetype": "ApplicationSource"
},
"facilitiesInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilitiesInfoResponse"
}
},
"approvedAmount": {
"description": "Approved Amount of Request",
"example": "30000.00",
"type": "string",
"format": "decimal"
}
}
},
"AllDealDetailsResponse": {
"properties": {
"allDealsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
}
}
},
"Liquidity": {
"properties": {
"currentRatio": {
"description": "Current ratio",
"example": "1234567.90",
"type": "string"
},
"quickRatio": {
"description": "quick ratio",
"example": "345678.90",
"type": "string"
}
}
},
"IncomeRatio": {
"properties": {
"debtToIncomeRatio": {
"description": "Debt to Income Ratio",
"example": "12345.98",
"type": "string"
}
}
},
"Leverage": {
"properties": {
"debtToEquity": {
"description": "Debt to equity",
"example": "12345.67",
"type": "string"
},
"debtToTotalAssets": {
"description": "Debt to Total Assets",
"example": "23456.98",
"type": "string"
},
"debtIntEarned": {
"description": "Debt interest earned",
"example": "12345.89",
"type": "string"
},
"fixedCoverageCharge": {
"description": "fixedCoverageCharge",
"example": "12345.89",
"type": "string"
},
"ebitda": {
"description": "ebitda",
"example": "1000000",
"type": "string"
},
"turnover": {
"description": "turnover ",
"example": "12345678.90",
"type": "string"
},
"equity": {
"description": "equity ",
"example": "1237.89",
"type": "string"
},
"dscr": {
"description": "dscr",
"example": "1234.78",
"type": "string"
}
}
},
"Profitability": {
"properties": {
"grossMargin": {
"description": "Gross Margin",
"example": "1234567.89",
"type": "string"
},
"operatingMargin": {
"description": "Operation Margin",
"example": "1234567.89",
"type": "string"
},
"netProfitMargin": {
"description": "Net Profit Margin",
"example": "12345.980",
"type": "string"
},
"roa": {
"description": "ROA",
"example": "100000000",
"type": "string"
},
"roe": {
"description": "ROE",
"example": "1000000",
"type": "string"
}
}
},
"Efficiency": {
"properties": {
"receivableTurnover": {
"description": "Receivable Turn Over",
"example": "1234.90",
"type": "string"
},
"daySaleOutstanding": {
"description": "Day sale outstanding",
"example": "100000000",
"type": "string"
},
"inventoryTurnover": {
"description": "Inventory turn over",
"example": "100000000000",
"type": "string"
},
"dayOfInventory": {
"description": "dayOf Inventory",
"example": "100000000",
"type": "string"
},
"accountPayableTurnover": {
"description": "account Payable Turnover",
"example": "1000000",
"type": "string"
},
"totalAssetTurnover": {
"description": "total Asset Turnover",
"example": "123456789000",
"type": "string"
}
}
},
"CreateFinancialResultRequest": {
"properties": {
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"incomeRatio": {
"allOf": [
{
"$ref": "#/components/schemas/IncomeRatio"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFinancialResultListRequest": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFinancialResultRequest"
}
}
}
},
"CreateFinancialResultResponse": {
"properties": {
"financialResultId": {
"description": "Specifies Id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"FinancialResultResponse": {
"properties": {
"financialResultId": {
"description": "Specifies id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"incomeRatio": {
"allOf": [
{
"$ref": "#/components/schemas/IncomeRatio"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Financial Result was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"FinancialResultsResponse": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialResultResponse"
}
}
}
},
"UpdateFinancialResultRequest": {
"properties": {
"financialResultId": {
"description": "Specifies id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"incomeRatio": {
"allOf": [
{
"$ref": "#/components/schemas/IncomeRatio"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateFinancialResultListRequest": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFinancialResultRequest"
}
}
}
},
"NarrativesCreateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"collateralId": {
"description": "ID of the Collateral created for this deal",
"example": "C1234567",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesUpdateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"collateralId": {
"description": "ID of the Collateral created for this deal",
"example": "C12345678",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesDocumentItem": {
"properties": {
"documentId": {
"description": "ID of the document uploaded in narrative",
"example": "D20201234",
"type": "string"
},
"documentName": {
"description": "Name of the document",
"example": "asset.txt",
"type": "string"
}
}
},
"ExternalServiceDocumentItem": {
"properties": {
"documentId": {
"description": "ID of the document uploaded in narrative",
"example": "D20201234",
"type": "string"
},
"documentName": {
"description": "Name of the document",
"example": "asset.txt",
"type": "string"
}
}
},
"ProcessedNarrativesResponse": {
"properties": {
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesResponse": {
"properties": {
"categoryId": {
"description": "ID of the category",
"example": "2",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "F123456",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F123456",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"collateralId": {
"description": "Unique identifier for Collateral",
"example": "N20201234",
"type": "string"
},
"partyId": {
"description": "Unique identifier for Party",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesResponses": {
"properties": {
"Narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
}
}
},
"NarrativesCreateRequests": {
"properties": {
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesCreateRequest"
}
}
}
},
"NarrativesUpdateRequests": {
"properties": {
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesUpdateRequest"
}
}
}
},
"EnrichmentResponseItem": {
"properties": {
"value": {
"description": "Value of the reference record",
"type": "string"
},
"description": {
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DecisionStatusResponseItem": {
"properties": {
"value": {
"description": "Decision Status Id",
"example": "01",
"type": "string"
},
"description": {
"description": "Decision Status Value",
"example": "Approve",
"type": "string"
},
"allowedDecisionType": {
"description": "Decision Status: Applicable category",
"example": "Individual,Committee",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralSubTypesItem": {
"properties": {
"collateralSubTypeId": {
"description": "Collateral Sub Type Id",
"example": "001",
"type": "string"
},
"collateralSubTypeValue": {
"description": "Collateral Sub Type Value",
"example": "Car",
"type": "string"
},
"t24ReferenceId": {
"description": "t24 Reference Id Collateral Sub Type",
"example": "200",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralTypesItem": {
"properties": {
"collateralTypeId": {
"description": "Collateral Type Id",
"example": "01",
"type": "string"
},
"collateralTypeValue": {
"description": "Collateral Type Value",
"example": "Vehicles",
"type": "string"
},
"collateralSubTypes": {
"description": "Collateral Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralSubTypesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"StageSignalTypesItems": {
"properties": {
"stage": {
"description": "Stage Value",
"example": "01",
"type": "string"
},
"signalName": {
"description": "Stage Name",
"example": "prescreeningSignal",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndustrialSubTypesItem": {
"properties": {
"industrialSubTypeId": {
"description": "industrial Sub Type Id",
"example": "001",
"type": "string"
},
"industrialSubTypeValue": {
"description": "Industrial Sub Type Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndustrialTypesItem": {
"properties": {
"industrialTypeId": {
"description": "Industrial Type Id",
"example": "01",
"type": "string"
},
"industrialTypeValue": {
"description": "Industrial Type Value",
"example": "Vehicles",
"type": "string"
},
"industrialSubTypes": {
"description": "Industrial Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialSubTypesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"FeeNamesItem": {
"properties": {
"feeNameId": {
"description": "Fee Name Id",
"example": "001",
"type": "string"
},
"feeNameValue": {
"description": "Fee Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypesItem": {
"properties": {
"feeTypesId": {
"description": "Fee Type Id",
"example": "01",
"type": "string"
},
"feeTypesValue": {
"description": "Fee Type Value",
"example": "Vehicles",
"type": "string"
},
"feeNames": {
"description": "Fee Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"StagesForLobItem": {
"properties": {
"stageId": {
"description": "stage id",
"example": "01",
"type": "string"
},
"stageValue": {
"description": "stage name",
"example": "Submitted",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RequestStagesLobItem": {
"properties": {
"lobValue": {
"description": "Line of business Id",
"example": "01",
"type": "string"
},
"description": {
"description": "lob description",
"example": "Corporate",
"type": "string"
},
"stages": {
"description": "stages for respective lob",
"type": "array",
"items": {
"$ref": "#/components/schemas/StagesForLobItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"FacilityStagesLobItem": {
"properties": {
"lobValue": {
"description": "Line of business Id",
"example": "01",
"type": "string"
},
"description": {
"description": "lob description",
"example": "Corporate",
"type": "string"
},
"purposeId": {
"description": "purposeId name",
"example": "01,02",
"type": "string"
},
"stages": {
"description": "stages for respective lob",
"type": "array",
"items": {
"$ref": "#/components/schemas/StagesForLobItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ConditionNamesItem": {
"properties": {
"conditionNameId": {
"description": "Condition Name Id",
"example": "001",
"type": "string"
},
"conditionNameValue": {
"description": "Condition Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ConditionTypesItem": {
"properties": {
"conditionTypesId": {
"description": "Condition Type Id",
"example": "01",
"type": "string"
},
"conditionTypesValue": {
"description": "Condition Type Value",
"example": "Vehicles",
"type": "string"
},
"conditionNames": {
"description": "Condition Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"CovenantNamesItem": {
"properties": {
"covenantNameId": {
"description": "Covenant Name Id",
"example": "001",
"type": "string"
},
"covenantNameValue": {
"description": "Covenant Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantTypesItem": {
"properties": {
"covenantTypesId": {
"description": "Covenant Type Id",
"example": "01",
"type": "string"
},
"covenantTypesValue": {
"description": "Covenant Type Value",
"example": "Vehicles",
"type": "string"
},
"covenantNames": {
"description": "Covenant Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceNamesItem": {
"properties": {
"complianceNameId": {
"description": "Compliance Name Id",
"example": "001",
"type": "string"
},
"complianceNameValue": {
"description": "Compliance Name Value",
"example": "Car",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceTypesItem": {
"properties": {
"complianceTypesId": {
"description": "Compliance Type Id",
"example": "01",
"type": "string"
},
"complianceTypesValue": {
"description": "Compliance Type Value",
"example": "Vehicles",
"type": "string"
},
"complianceNames": {
"description": "Compliance Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativeCategoryItem": {
"properties": {
"type": {
"description": "Narrative Category Type",
"example": "financial",
"type": "string"
},
"value": {
"description": "Narrative Category Value",
"example": "01",
"type": "string"
},
"description": {
"description": "description of Narrative category",
"example": "financial",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RoleCategoryItem": {
"properties": {
"categoryId": {
"description": "Category Id",
"example": "01",
"type": "string"
},
"roles": {
"description": "Keycloak roles",
"example": "Relationship Manager,SME RM,Retail RM",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionTypesItem": {
"properties": {
"type": {
"description": "Policy Exception Type",
"example": "equity",
"type": "string"
},
"value": {
"description": "Policy Exception Value",
"example": "01",
"type": "string"
},
"description": {
"description": "description of Policy exception",
"example": "equity",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"StateInfo": {
"properties": {
"stateCode": {
"description": "code of the state",
"example": "AK",
"type": "string"
},
"stateName": {
"description": "State name",
"example": "Alaska",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CountryInfo": {
"properties": {
"countryCode": {
"description": "Code of the country",
"example": "US",
"type": "string"
},
"countryUniCode": {
"description": "Uni code of the country",
"example": "+840",
"type": "string"
},
"countryName": {
"description": "Name of the country",
"example": "United States",
"type": "string"
},
"countryPhoneCode": {
"description": "Phone code of the country",
"example": "+840",
"type": "string"
},
"states": {
"description": "List of states",
"type": "array",
"items": {
"$ref": "#/components/schemas/StateInfo"
}
},
"extensionData": {
"type": "object"
}
}
},
"TasksInfoItem": {
"properties": {
"taskId": {
"description": "Task Id",
"example": "01",
"type": "string"
},
"taskName": {
"description": "Task Name",
"example": "Borrower Info",
"type": "string"
},
"waive": {
"description": "Waive",
"example": "Required",
"type": "string"
},
"taskDescription": {
"description": "Task Description",
"example": "Borrower Info",
"type": "string"
},
"taskType": {
"description": "Task Type",
"example": "Manual",
"type": "string"
},
"defaultUserId": {
"description": "Default User Id",
"example": "1001",
"type": "string"
},
"ruleId": {
"description": "rule Id",
"example": "01",
"type": "string"
},
"taskPackage": {
"description": "task Package",
"example": "Fraud-check",
"type": "string"
},
"taskProvider": {
"description": "task Provider",
"example": "Borrower",
"type": "string"
},
"noOfDays": {
"description": "Task Lifetime for no of days",
"example": "5",
"type": "string"
},
"defaultUserEmail": {
"description": "Default User Email",
"example": "temenostestmail@gmail.com",
"type": "string"
},
"partyIndicator": {
"description": "Party Indicator",
"example": "00",
"type": "string"
},
"overview": {
"description": "overview screen",
"example": "Entity Overview",
"type": "string"
},
"section": {
"description": "Section Screen",
"example": "Documents",
"type": "string"
},
"processDefId": {
"description": "Id of process initiated by PAM",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"TasksCheckListItem": {
"properties": {
"taskCheckListId": {
"description": "Task Check List Id",
"example": "01",
"type": "string"
},
"taskCheckListName": {
"description": "Task Check List Name",
"example": "Fraud check",
"type": "string"
},
"tasksInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksInfoItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"TasksParamsItem": {
"properties": {
"taskStage": {
"description": "Task Stage",
"example": "Onboarding",
"type": "string"
},
"tasksCheckList": {
"description": "Task CheckList",
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"lastChangeUserId": {
"description": "Last Change User Id",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"WorkflowtasksCheckListItem": {
"properties": {
"taskType": {
"description": "Task Type",
"example": "Retrigger",
"type": "string"
},
"serviceName": {
"description": "Name of the service to be invoked",
"example": "OriginationJavaServices",
"type": "string"
},
"operationName": {
"description": "Name of the operation in the service",
"example": "GetBlacklistResult",
"type": "string"
},
"taskId": {
"description": "Id for the Task",
"example": "T003",
"type": "string"
},
"provider": {
"description": "Provider for the Task",
"example": "Blacklist",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityPurposeItem": {
"properties": {
"purposeId": {
"description": "ID for facility purpose",
"example": "01",
"type": "string"
},
"value": {
"description": "Facility type",
"example": "New Facility",
"type": "string"
},
"description": {
"description": "Purpose of the Facility",
"example": "New Loan Creation",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ReferenceDataItems": {
"properties": {
"queueNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentAppliesToCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentCategoryList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentTypeList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"limitType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"relatedPartyRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"historyTables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"dealStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"lineOfBusiness": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"operator": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"interestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"month": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"restrictionType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"restrictionStartDate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"payType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"addressType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DecisionStatusResponseItem"
}
},
"complianceType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"currency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"noOfEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"portfolio": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"profitCenter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPriority": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"salutation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"partyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"fundingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingInterestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeBalanceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"basisTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collectionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPackage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingIndex": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityUsage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"policyExceptionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"productReferenceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branchReferenceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"jobTitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskProvider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"acceptanceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"companyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"contactTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeFrequencyTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"riskRatingTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"beneficialOwnerDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rateTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"provider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"providerType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"repricingFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"paymentFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralTypesItem"
}
},
"stageSignalTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageSignalTypesItems"
}
},
"industryTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialTypesItem"
}
},
"conditionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionTypesItem"
}
},
"covenantTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantTypesItem"
}
},
"complianceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceTypesItem"
}
},
"narrativeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativeCategoryItem"
}
},
"policyExceptionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionTypesItem"
}
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryInfo"
}
},
"feeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeTypesItem"
}
},
"requestStagesLob": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestStagesLobItem"
}
},
"facilityStagesLob": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityStagesLobItem"
}
},
"UITasksCheckList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"withdrawalReasonType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralPropertyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralPropertyStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralOccupancy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralRequiredCoverage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypeDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralStatusDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"approvalStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"committeeRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rateChangeMethod": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"capBasis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"floorBasis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"repaymentScheduleType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"installmentType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"roundingRule": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rounding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"interestSpreadType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"roleCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleCategoryItem"
}
},
"collateralSource": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"workflowTasksCheckList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowtasksCheckListItem"
}
},
"instructionType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"amendmentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"amendRequestTypeStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"amendRequestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityPurpose": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityPurposeItem"
}
},
"bankType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgagePropertyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgagePropertySubType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"furnishedType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgagePropertyStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"propertyUsage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"productType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"drawingType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgageType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgageNotaryStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"disbursementType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"repaymentPayType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
}
}
},
"BasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"partyType": {
"description": "type of the party",
"example": "Individual",
"type": "string"
},
"legalName": {
"description": "legalName of the Customer",
"example": "ABC Company",
"type": "string"
},
"registrationNumber": {
"description": "registration number of the Customer",
"example": "ABC Company",
"type": "string"
},
"companyType": {
"description": "company type",
"example": "Community Interest Company (CIC)",
"type": "string",
"x-referencetype": "CompanyType"
},
"industryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"subIndustryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"registrationDate": {
"description": "date of registration",
"example": "Telecom",
"type": "string"
},
"yearsInBusiness": {
"description": "years in business",
"example": "5",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedAnnualRevenue": {
"description": "estimated annual revenue",
"example": "10000000",
"type": "string"
},
"noOfEmployees": {
"description": "no of employees",
"example": "01",
"type": "string"
},
"websiteAddress": {
"description": "websire address",
"example": "www.abc.com",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"companyOverview": {
"description": "company overview",
"example": "Telecom company",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"jobTitle": {
"description": "jobTitle of the person",
"example": "MD",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phnNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddr": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PartyInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "12345",
"type": "string"
},
"partyName": {
"description": "Name of the party",
"example": "ABC corporation",
"type": "string"
},
"partyType": {
"description": "Type of the party",
"example": "Individual",
"type": "string"
}
}
},
"GroupInfo": {
"properties": {
"groupId": {
"description": "unique identifier of the group",
"example": "1234567",
"type": "string"
},
"groupName": {
"description": "Name of the Group",
"example": "ABC Group",
"type": "string"
},
"groupType": {
"description": "Type of the Group",
"example": "Borrowing",
"type": "string"
},
"overView": {
"description": "Overview of the Group",
"type": "string"
},
"partyInfoList": {
"description": "party infor of particular group",
"type": "array",
"items": {
"$ref": "#/components/schemas/PartyInfo"
}
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "+91",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndividualBasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"dateOfBirth": {
"description": "dob of the person",
"example": "1978-06-03",
"type": "string"
},
"identificationNumber": {
"description": "id proof of the person",
"example": "9876095404361276",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddress": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityInfo": {
"properties": {
"facilityId": {
"description": "unique identifier of the facility",
"example": "F20201234567",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P20201234567",
"type": "string"
},
"groupId": {
"description": "unique identifier of the group",
"example": "P20201234567",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "facility123",
"type": "string"
},
"purpose": {
"description": "purpose of the facility",
"example": "01",
"type": "string"
},
"usageId": {
"description": "usage id of the facility",
"example": "01",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "line of credit",
"type": "string"
},
"currency": {
"description": "Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "amount of the facility",
"example": "10000000",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ModifiedFacilityInfo": {
"properties": {
"facilityId": {
"description": "unique identifier of the facility",
"example": "M20211234567_02",
"type": "string"
},
"previousFacilityId": {
"description": "unique identifier of the facility",
"example": "F20201234567,M20211234567_01",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P20201234567",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "facility123",
"type": "string"
},
"purpose": {
"description": "purpose of the facility",
"example": "01",
"type": "string"
},
"usageId": {
"description": "usage id of the facility",
"example": "01",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "line of credit",
"type": "string"
},
"currency": {
"description": "Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"amendmentTypes": {
"description": "amendmentTypes of the facility",
"example": "01,02,04",
"type": "string"
},
"maturityDate": {
"description": "maturity date of the facility",
"example": "2020-06-03",
"type": "string"
},
"previousMaturityDate": {
"description": "previous Maturity Date of the facility",
"example": "2020-06-03",
"type": "string"
},
"loanAmount": {
"description": "Loan Amount of the facility",
"example": "10000000",
"type": "string"
},
"previousLoanAmount": {
"description": "Previous Loan Amount of the facility",
"example": "600000",
"type": "string"
},
"commencementDate": {
"description": "commencement date of the facility",
"example": "2020-06-03",
"type": "string"
},
"paidAmount": {
"description": "paid amount of the facility",
"example": "50000",
"type": "string"
},
"arrangementNo": {
"description": "arrangement number of the facility",
"example": "123456789",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RelatedPartyInfo": {
"properties": {
"id": {
"description": "unique identifier",
"example": "12345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"groupId": {
"description": "unique identifier of the group",
"example": "P20201234567",
"type": "string"
},
"relatedGroupId": {
"description": "unique identifier of the related group",
"example": "P20201234567",
"type": "string"
},
"relatedPartyId": {
"description": "unique identifier of the related party",
"example": "P20201234567",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"partyName": {
"description": "name of the party",
"example": "abc",
"type": "string"
},
"relatedPartyName": {
"description": "name of the related party",
"example": "party1",
"type": "string"
},
"relatedGroupName": {
"description": "name of the relatedGroup",
"example": "group1",
"type": "string"
},
"relatedPartyType": {
"description": "type of the relatedparty",
"example": "abc",
"type": "string"
},
"role": {
"description": "role",
"example": "01",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "amount or percentage of limit",
"example": "percentage",
"type": "string"
},
"limitCurrency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"limitValue": {
"description": "value",
"example": "10000000",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralInfo": {
"properties": {
"collateralId": {
"description": "unique identifier of the collateral",
"example": "C202012345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"name": {
"description": "name of the collateral",
"example": "building",
"type": "string"
},
"type": {
"description": "type of the collateral",
"example": "01",
"type": "string"
},
"subType": {
"description": "subtype of the collateral",
"example": "001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedValue": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
},
"collateralStatus": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string",
"x-referencetype": "CollateralStatus"
},
"collateralSource": {
"description": "source of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralSource"
},
"externalReferenceId": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentInfo": {
"properties": {
"documentId": {
"description": "Id of the document",
"example": "123456",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"collateralId": {
"description": "unique identifier of the Collateral",
"example": "T202012345678",
"type": "string"
},
"requestId": {
"description": "unique identifier of the request",
"example": "T202012345",
"type": "string"
},
"documentName": {
"description": "name of the document",
"example": "agreement",
"type": "string"
},
"documentType": {
"description": "type of the document",
"example": "02",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"uploadOn": {
"description": "date of upload",
"example": "2020-06-03",
"type": "string"
},
"category": {
"description": "category",
"example": "",
"type": "string"
},
"appliesTo": {
"description": "appliesTo",
"example": "01",
"type": "string"
},
"fileSize": {
"description": "fileSize of the document",
"example": "2000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerRequestInfo": {
"properties": {
"requestId": {
"description": "Id of the request",
"example": "654564",
"type": "string"
},
"userId": {
"description": "id of the user who created the request",
"example": "87654",
"type": "string"
},
"usageId": {
"description": "id of the usage who created the request",
"example": "U123",
"type": "string"
},
"currency": {
"description": "currency",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"status": {
"description": "current step of submission process",
"example": "Draft",
"type": "string"
},
"screenFlag": {
"description": "Specifies screen of the request",
"example": "Facility",
"type": "string"
},
"requestType": {
"description": "Specifies request type",
"example": "delete",
"type": "string"
},
"summary": {
"description": "summary of the request being raised",
"example": "test summary",
"type": "string"
},
"requestDate": {
"description": "Date of the request being raised",
"example": "2020-06-03",
"type": "string"
},
"purposeTypes": {
"description": "Purpose types of the request being raised",
"example": "01,02",
"type": "string"
},
"customerInformation": {
"allOf": [
{
"$ref": "#/components/schemas/BasicInfo"
}
]
},
"groupInformation": {
"allOf": [
{
"$ref": "#/components/schemas/GroupInfo"
}
]
},
"facilityItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityInfo"
}
},
"modifiedFacilityItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModifiedFacilityInfo"
}
},
"relatedPartyItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyInfo"
}
},
"newRelatedPartyIndividualItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndividualBasicInfo"
}
},
"newRelatedPartyBusinessItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicInfo"
}
},
"collateralItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"documentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentInfo"
}
},
"extensionData": {
"type": "object"
}
}
},
"CustomerRequestsInfo": {
"properties": {
"customerRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"CreateCustomerProcessedResponse": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "TEMP-12345678",
"type": "string"
},
"customerPartyId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"customerGroupId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"facilityId": {
"description": "unique id of the facility",
"example": "F202012345678",
"type": "string"
},
"Ids": {
"description": "unique id of the relatedParties",
"example": "P202012345678",
"type": "string"
},
"individualPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"businessPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"collateralIds": {
"description": "unique id of the collaterals",
"example": "C202012345678",
"type": "string"
},
"documentIds": {
"description": "unique id of the documents",
"example": "D202012345678",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"InFlightFacilitiesInfo": {
"properties": {
"facilityId": {
"description": "Specifies id of the inflight facilityId",
"example": "F20201234567,M20211234567_01",
"type": "string"
},
"requestId": {
"description": "Id of the request",
"example": "654564",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"InFlightFacilityResponse": {
"properties": {
"inFlightFacilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InFlightFacilitiesInfo"
}
}
}
},
"DrawRestrictionsRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"restrictionType": {
"description": "Restriction Type",
"example": "01",
"type": "string",
"x-referencetype": "RestrictionType"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyIdsArray"
}
},
"startsFrom": {
"description": "from which date the restriction starts",
"example": "01",
"type": "string",
"x-referencetype": "RestrictionStartDate"
},
"startDate": {
"description": "Date when the restriction will be applicable",
"example": "01/01/2021",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012586",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDrawRestrictionsResponse": {
"properties": {
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012566",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "Maximum Limit amount",
"type": "string"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"currencyId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyIdsArray"
}
},
"startsFrom": {
"description": "from which date the restriction starts",
"example": "01",
"type": "string"
},
"startDate": {
"description": "Date when the restriction will be applicable",
"example": "01/01/2021",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the restriction was last changed",
"type": "string",
"format": "date"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionsRequests": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionsRequest"
}
}
}
},
"DrawRestrictionResponses": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
}
}
},
"ComplianceRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "R2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateComplianceRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "COMP123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceRequest"
}
}
}
},
"UpdateComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateComplianceRequest"
}
}
}
},
"ComplianceResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "123456789",
"type": "string"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceResponses": {
"properties": {
"Compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
}
}
},
"PolicyExceptionResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P3456789",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"policyExceptionId": {
"description": "Unique Identifier of PolicyException",
"example": "123456789",
"type": "string"
},
"exceptionType": {
"description": "Type of Exception",
"type": "string"
},
"description": {
"description": "description of the exception",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"type": "string"
},
"comment": {
"description": "policyException comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a policyException",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionResponses": {
"properties": {
"policyExceptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionResponse"
}
}
}
},
"ProcessedComplianceResponse": {
"properties": {
"RequestId": {
"description": "Unique identifier for Deal",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"complianceId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedConditionResponse": {
"properties": {
"conditionId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"ProcessedDecisionResponse": {
"properties": {
"creditDecisionId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"ProcessedPolicyResponse": {
"properties": {
"policyExceptionId": {
"description": "Unique identifier for PolicyExceptions",
"example": "PE123456",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"AddressDetails": {
"properties": {
"addressLine1": {
"description": "address Line1",
"example": "1-2-33/4/5, Baker Street",
"type": "string"
},
"addressLine2": {
"description": "address Line2",
"example": "Opp. White House",
"type": "string"
},
"city": {
"description": "city",
"example": "Los Angeles",
"type": "string"
},
"countryId": {
"description": "country id",
"example": "0",
"type": "string"
},
"state": {
"description": "state",
"example": "ca",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "10011",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsCreateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disbursement Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disbursementPercentage": {
"description": "The disbursement percentage",
"example": "10",
"type": "string"
},
"disbursementDate": {
"description": "The date of the disbursement",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"payeeName": {
"description": "Name of the Payee",
"example": "Antony",
"type": "string"
},
"accountNumber": {
"description": "Account Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"bankName": {
"description": "Name of the Payee",
"example": "ABC bank",
"type": "string"
},
"swiftCode": {
"description": "Swift code",
"example": "SW9384",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"addressRefrence": {
"description": "Reference of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"disbursementType": {
"description": "Type of disbursement",
"example": "Full Disbursement",
"type": "string",
"x-referencetype": "DisbursementType"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsUpdateRequest": {
"properties": {
"fundingId": {
"description": "ID of the funding created for this Request",
"example": "F200722894",
"type": "string"
},
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disbursementPercentage": {
"description": "The disbursement percentage",
"example": "10",
"type": "string"
},
"disbursementDate": {
"description": "The date of the disbursement",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"payeeName": {
"description": "Name of the Payee",
"example": "Antony",
"type": "string"
},
"accountNumber": {
"description": "Account Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"bankName": {
"description": "Name of the Payee",
"example": "ABC bank",
"type": "string"
},
"swiftCode": {
"description": "Swift code",
"example": "SW9384",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"addressRefrence": {
"description": "Reference of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"disbursementType": {
"description": "Type of disbursement",
"example": "Full Disbursement",
"type": "string",
"x-referencetype": "DisbursementType"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedFundingDetailsResponse": {
"properties": {
"fundingId": {
"type": "string",
"description": "Specifies the ID of the funding",
"example": "F123"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"FundingDetailsResponse": {
"properties": {
"fundingId": {
"description": "ID of the funding created for this Request",
"example": "F200722894",
"type": "string"
},
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Id of the drawing created for a Facility",
"example": "F202012345678-01",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string"
},
"disbursementPercentage": {
"description": "The disbursement percentage",
"example": "10",
"type": "string"
},
"disbursementDate": {
"description": "The date of the disbursement",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string"
},
"payeeName": {
"description": "Name of the Payee",
"example": "Antony",
"type": "string"
},
"accountNumber": {
"description": "Account Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"bankName": {
"description": "Name of the payee",
"example": "ABC bank",
"type": "string"
},
"swiftCode": {
"description": "Swift code",
"example": "SW9384",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"addressRefrence": {
"description": "Reference of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date and Time of the lastchange",
"example": "2020-09-05 10:08 08 800",
"type": "string",
"format": "date"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"disbursementType": {
"description": "Type of disbursement",
"example": "Full Disbursement",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsResponses": {
"properties": {
"Funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
}
}
},
"LimitThings": {
"properties": {
"unadvisedLimit": {
"description": "Limit that unadvised",
"example": "$10000",
"type": "string"
},
"advisedLimit": {
"description": "Limit that advised",
"example": "$5000",
"type": "string"
},
"utilisedLimit": {
"description": "Already used limit",
"example": "$5000",
"type": "string"
},
"availableLimit": {
"description": "Limit that available",
"example": "$5000",
"type": "string"
},
"requestedAmount": {
"description": "Amount that requested",
"example": "$10000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"LimitsRequest": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": "Specifies the outstanding debt",
"example": "$5000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"LimitsResponse": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": " Specifies the outstanding debt",
"example": "$50000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"previousLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"modifiedDate": {
"description": "The date modify the Limit",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Limit",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedLimitResponse": {
"properties": {
"limitId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"FeeTypeOnGoing": {
"properties": {
"balanceType": {
"description": "DD field,Visible only If Percentage is selected in Percentage/Amount",
"example": "01",
"type": "string",
"x-referencetype": "FeeBalanceTypes"
},
"frequency": {
"description": "Fee Frequency",
"example": "05",
"type": "string",
"x-referencetype": "FeeFrequencyTypes"
},
"rateBasis": {
"description": "DD field, Visible only If Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"rateType": {
"description": "Default to Fixed, Visible only if Percentage is selected in Percentage/Amount",
"example": "fixed",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypeEvent": {
"properties": {
"feeBasis": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypeClosing": {
"properties": {
"feeBasis": {
"description": "feeBasisId",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "percentage",
"example": "48",
"type": "string"
},
"collection": {
"description": "DD field, collection",
"example": "12345678",
"type": "string"
},
"status": {
"description": "DD field, status",
"example": "01",
"type": "string",
"x-referencetype": "FeeStatus"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFeeRequest": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateFeeRequest": {
"properties": {
"feeId": {
"description": "unique id of the fee",
"example": "FEE202035269718",
"type": "string"
},
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeResponse": {
"properties": {
"feeId": {
"description": "Specifies id of the fees",
"example": "12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFeeRequest"
}
}
}
},
"UpdateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFeeRequest"
}
}
}
},
"FeesResponse": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
}
}
},
"ProcessedFeesResponse": {
"properties": {
"feesId": {
"description": "Unique identifier for fees",
"example": "FEE202035292905",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"StandardSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"Structure": {
"properties": {
"years": {
"description": "Number of Years",
"example": "2",
"type": "string"
},
"months": {
"description": "Number of Months",
"example": "12",
"type": "string"
},
"days": {
"description": "Number of Days",
"example": "31",
"type": "string"
},
"indexType": {
"description": "The index type",
"example": "01",
"type": "string",
"x-referencetype": "PricingIndex"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "01",
"type": "string",
"x-referencetype": "RateTypes"
},
"paymentFrequency": {
"description": "The Payment Frequency",
"example": "01",
"type": "string",
"x-referencetype": "PaymentFrequency"
},
"rateChangeMethod": {
"description": "The Rate Change Method",
"example": "01",
"type": "string",
"x-referencetype": "RateChangeMethod"
},
"repricingFrequency": {
"description": "The Repricing Frequency",
"example": "01",
"type": "string",
"x-referencetype": "RepricingFrequency"
},
"baseRate": {
"description": "The base rate percentage",
"example": "20",
"type": "string"
},
"indicativeBaseRate": {
"description": "The Indicative Base Rate percentage",
"example": "35",
"type": "string"
},
"freezePeriod": {
"description": "The number of days to freeze",
"example": "31",
"type": "string"
},
"rateLockDate": {
"description": "The rate lock date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"interestSpread": {
"description": "The interest Spread percentage",
"example": "15",
"type": "string"
},
"interestSpreadType": {
"description": "The interest Spread type",
"example": "01",
"type": "string",
"x-referencetype": "InterestSpreadType"
},
"rateLockExpiryDate": {
"description": "The Rate Lock Expiry Date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"borrowerRate": {
"description": "The borrowerRate percentage",
"example": "10",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicative Borrower Rate percentage",
"example": "25",
"type": "string"
},
"aprRate": {
"description": "The apr Rate percentage",
"example": "10",
"type": "string"
},
"interestCapBasis": {
"description": "The Cap Basis",
"example": "01",
"type": "string",
"x-referencetype": "CapBasis"
},
"interestCap": {
"description": "The Cap percentage",
"example": "12",
"type": "string"
},
"interestFloorBasis": {
"description": "The Floor Basis",
"example": "01",
"type": "string",
"x-referencetype": "FloorBasis"
},
"interestFloor": {
"description": "The Floor Basis percentage",
"example": "20",
"type": "string"
}
}
},
"Schedule": {
"properties": {
"installmentType": {
"description": "The installment type",
"example": "01",
"type": "string",
"x-referencetype": "InstallmentType"
},
"repaymentType": {
"description": "The repayment type",
"example": "Revolving",
"type": "string"
},
"repaymentScheduleType": {
"description": "The repayment Schedule type",
"example": "01",
"type": "string",
"x-referencetype": "RepaymentScheduleType"
},
"firstInstallmentDate": {
"description": "The first Installment Date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"reoccurringInstallmentDate": {
"description": "The reoccurring Installment Date",
"example": "21",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "01",
"type": "string",
"x-referencetype": "Rounding"
},
"roundingRule": {
"description": "The rounding Rule",
"example": "01",
"type": "string",
"x-referencetype": "RoundingRule"
},
"installmentCurrency": {
"description": "The installment Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"installmentAmount": {
"description": "The installmentAmount",
"example": "10000",
"type": "string"
},
"repaymentScheduleDocumentId": {
"description": "The repayment Schedule DocumentId",
"example": "d723-232-28de",
"type": "string"
},
"repaymentScheduleDocumentName": {
"description": "The repayment Schedule Document Name",
"example": "abc.pdf",
"type": "string"
},
"balloonCurrency": {
"description": "The balloon Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"balloonAmount": {
"description": "The balloon Amount",
"example": "100000",
"type": "string"
},
"minimumPaymentCurrency": {
"description": "The minimumPaymentCurrency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"minimumPaymentAmount": {
"description": "The minimum Payment Amount",
"example": "10000",
"type": "string"
},
"minimumPaymentPercentage": {
"description": "The minimum Payment Percentage",
"example": "40",
"type": "string"
}
}
},
"PricingComment": {
"properties": {
"commentText": {
"description": "The comment Text",
"example": "add pricing",
"type": "string"
},
"commentUser": {
"description": "The comment User",
"example": "bfleck",
"type": "string"
},
"commentDate": {
"description": "The comment date",
"example": "2020-06-03",
"type": "string",
"format": "date"
}
}
},
"currencyIdsArray": {
"properties": {
"currency": {
"description": "The restricted currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
}
}
},
"ExternalRefDetails": {
"properties": {
"type": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"id": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
}
}
},
"FeaturesDetails": {
"properties": {
"type": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"id": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
},
"name": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"value": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
},
"description": {
"description": "The external ref description",
"example": "Yes, I like to order a cheque book",
"type": "string"
}
}
},
"PricingRequest": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the deal",
"example": "R202135269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202112345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"pricingType": {
"description": "The type of interest",
"example": "01",
"type": "string",
"x-referencetype": "InterestType"
},
"product": {
"description": "The type of product",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"structure": {
"allOf": [
{
"$ref": "#/components/schemas/Structure"
}
]
},
"schedule": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
},
"pricingComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingComment"
}
},
"status": {
"description": "The status",
"example": "01",
"type": "string",
"x-referencetype": "PricingStatus"
},
"lastChangeUserId": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PricingResponse": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the deal",
"example": "R202135269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202112345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"pricingType": {
"description": "The type of interest",
"example": "01",
"type": "string"
},
"product": {
"description": "The type of product",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"structure": {
"allOf": [
{
"$ref": "#/components/schemas/Structure"
}
]
},
"schedule": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
},
"pricingComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingComment"
}
},
"status": {
"description": "The status",
"example": "01",
"type": "string"
},
"lastChangeUserId": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"PricingRequests": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingRequest"
}
}
}
},
"PricingResponses": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
}
}
},
"ProcessedPricingResponse": {
"properties": {
"pricingId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedCreditDecisionResponse": {
"properties": {
"creditDecisionId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"conditionId": {
"description": "Unique Identifier",
"example": "CON12345",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedScoreCardResponse": {
"properties": {
"scoreCardId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"scoreId": {
"description": "Unique Identifier",
"example": "CON12345",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedCovenantsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"covenantId": {
"description": "Unique identifier for covenant",
"example": "COV2345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"CovenantsRequest": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "C12345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string",
"x-referencetype": "CovenantType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string",
"x-referencetype": "CovenantFrequency"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "CovenantStatus"
},
"operator": {
"description": "Operator of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "Operator"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "requirement",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "COV202012345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string"
},
"operator": {
"description": "Operator of the Covenant",
"example": "==",
"type": "string"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantsRequests": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsRequest"
}
}
}
},
"CovenantsResponses": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
}
}
},
"ConditionsInfo": {
"properties": {
"conditionId": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ScoreInfo": {
"properties": {
"scoreType": {
"description": "Type of score",
"example": "Company Bureau Score",
"type": "string"
},
"value": {
"description": "Value of given type",
"example": 700,
"type": "integer",
"format": "decimal"
},
"score": {
"description": "Value of score",
"example": 10,
"type": "integer",
"format": "decimal"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateConditionRequest": {
"properties": {
"conditionId": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"creditDecisionId": {
"description": "id of credit decision",
"example": "12345678",
"type": "string"
},
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditDecisionInfo": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"creditDecisionId": {
"description": "Unique identifier of the Credit decision",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"committeeId": {
"description": "Unique identifier of the committee",
"example": "12345678",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"approvedAmount": {
"description": "Amount utilised in the committee",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"finalDecision": {
"description": "finalDecision of committee",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"totalScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"amendmentType": {
"description": "Amendment type selected for facility",
"example": "01",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the Collateral",
"example": "C65675677",
"type": "string"
},
"approvedMaturityDate": {
"description": "Approved maturity date of facility",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ScoreCardInfo": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"scoreCardId": {
"description": "Unique identifier of the Score Card",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"totalScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"scores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoreInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateCreditDecisionRequest": {
"properties": {
"creditDecisionId": {
"description": "Unique identifier of the CreditDecision",
"example": "123456",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"committeeId": {
"description": "Unique identifier of the committee",
"example": "12345678",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"approvedAmount": {
"description": "Amount utilised in the committee",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"finalDecision": {
"description": "finalDecision of committee",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"totalScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"amendmentType": {
"description": "Amendment type selected for facility",
"example": "01",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the Collateral",
"example": "C65675677",
"type": "string"
},
"approvedMaturityDate": {
"description": "approved maturity date",
"example": "2021-12-30",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateScoreCardRequest": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"scoreCardId": {
"description": "Unique identifier of the Score Card",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"totalScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"scores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoreInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionsRequest": {
"properties": {
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"exceptionType": {
"description": "type of the exception",
"type": "string"
},
"description": {
"description": "Description of the exception",
"type": "string"
},
"status": {
"description": "The status of the exception",
"type": "string",
"x-referencetype": "PolicyExceptionStatus"
},
"comment": {
"description": "Policy exceptions comment",
"example": "comment",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"UpdatePolicyExceptionsRequest": {
"properties": {
"policyExceptionId": {
"description": "Unique identifier of the PolicyExceptions",
"example": "PE123456",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"exceptionType": {
"description": "type of the exception",
"type": "string"
},
"description": {
"description": "exception description",
"type": "string"
},
"status": {
"description": "The status of the exception",
"type": "string",
"x-referencetype": "PolicyExceptionStatus"
},
"comment": {
"description": "exception comment",
"example": "comment",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"CreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
}
}
},
"UpdateCreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateCreditDecisionRequest"
}
}
}
},
"UpdateScoreCardList": {
"properties": {
"ScoreCardItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateScoreCardRequest"
}
}
}
},
"ScoreCardList": {
"properties": {
"scorecardItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoreCardInfo"
}
}
}
},
"RiskScoreCardList": {
"properties": {
"riskscorecardItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskScoreCardInfo"
}
}
}
},
"PolicyExceptionsList": {
"properties": {
"policyExceptionsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionsRequest"
}
}
}
},
"UpdatePolicyExceptionsList": {
"properties": {
"policyExceptionsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdatePolicyExceptionsRequest"
}
}
}
},
"UpdateConditionList": {
"properties": {
"conditionItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateConditionRequest"
}
}
}
},
"RequestOverViewResponse": {
"properties": {
"parentProcessId": {
"description": "Parent Process for Deal",
"example": "1",
"type": "string"
},
"requestOverView": {
"allOf": [
{
"$ref": "#/components/schemas/DealDetailsResponse"
}
]
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsResponse"
}
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"borrowerFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"policyException": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionResponse"
}
},
"IntegrationService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
},
"ExternalServiceHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
},
"checklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialResultResponse"
}
},
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
},
"momInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MomInfo"
}
},
"consents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsentItem"
}
}
}
},
"AdjustmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"facilityName": {
"description": "Name of the facility",
"example": "ABC ltd",
"type": "string"
},
"adjustedAmount": {
"description": "Adjusted Amount",
"example": "2 million",
"type": "string"
},
"adjustedCurrency": {
"description": "Adjusted Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedComment": {
"description": "adjusted comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalCommitmentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"lenderName": {
"description": "Name of the lender",
"example": "Jhon",
"type": "string"
},
"commitmentAmount": {
"description": "commitment Amount",
"example": "2 million",
"type": "string"
},
"maturitydate": {
"description": "maturity Date",
"example": "2020-06-03",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureCommentsInfo": {
"properties": {
"adjustedUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"adjustedDate": {
"description": "adjusted Date",
"example": "2020-06-03",
"type": "string"
},
"adjustedTime": {
"description": "adjusted Time",
"example": "1 year",
"type": "string"
},
"comment": {
"description": "comment",
"example": "this exposure is pending",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureInfo": {
"properties": {
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"exposureUniqueId": {
"description": "Unique identifier of the Exposure",
"example": "P202035292905",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsInfo"
}
},
"externalCommitments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalCommitmentsInfo"
}
},
"exposureComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureCommentsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"exposureDate": {
"description": "Exposure Date",
"example": "2020-06-03",
"type": "string"
},
"exposureTime": {
"description": "Exposure Time",
"example": "02:22",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureList": {
"properties": {
"exposureItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
}
}
},
"FacilityOverViewResponse": {
"properties": {
"parentProcessId": {
"description": "Parent Process for Deal",
"example": "1",
"type": "string"
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"fees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"drawRestriction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
},
"compliance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsResponse"
}
},
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
},
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInstructionsResponse"
}
},
"notarys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetNotaryResponse"
}
}
}
},
"DrawingOverViewResponse": {
"properties": {
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsResponse"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"fees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
},
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInstructionsResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
}
}
},
"TasksParamsReferenceDataItems": {
"properties": {
"tasksParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksParamsItem"
}
},
"tasksInfo": {
"$ref": "#/components/schemas/TasksInfoItem"
}
}
},
"EntityOverViewResponse": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"Exposures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
},
"IntegrationService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
},
"ExternalServiceHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
}
}
},
"MessageList": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"MessagesList": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageList"
}
}
}
},
"CreateMessagesResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"GetMessageResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"userId": {
"description": "user Id",
"example": "12345",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeDateTime": {
"description": "read flag",
"example": "true",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"GetMessagesResponse": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetMessageResponse"
}
}
}
},
"IntegrationServicesRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"integrationServicesId": {
"description": "Unique Identifier of IntegrationServices",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "01",
"type": "string",
"x-referencetype": "Provider"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "01",
"type": "string",
"x-referencetype": "ProviderType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"accountNumber": {
"description": "Account Number",
"example": "abcd",
"type": "string"
},
"package1": {
"description": "Name of the first Package",
"example": "weekly package",
"type": "string"
},
"package2": {
"description": "Name of the second Package",
"example": "monthly package",
"type": "string"
},
"package3": {
"description": "Name of the third Package",
"example": "yearly package",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the Integration Service",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IntegrationServicesRequests": {
"properties": {
"integrationServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesRequest"
}
}
}
},
"IntegrationServicesResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"integrationServicesId": {
"description": "Unique Identifier of IntegrationServices",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "Airtel",
"type": "string"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "3g",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"accountNumber": {
"description": "Account Number",
"example": "abcd",
"type": "string"
},
"package1": {
"description": "Name of the first Package",
"example": "weekly package",
"type": "string"
},
"package2": {
"description": "Name of the second Package",
"example": "monthly package",
"type": "string"
},
"package3": {
"description": "Name of the third Package",
"example": "yearly package",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the Integration Service",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Integration Service was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"IntegrationServicesResponses": {
"properties": {
"integrationServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
}
}
},
"ProcessedIntegrationServicesResponse": {
"properties": {
"integrationServicesId": {
"description": "Unique identifier for integrationServices",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"externalServicesHistoryId": {
"description": "Unique Identifier of externalServicesHistory",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "01",
"type": "string",
"x-referencetype": "Provider"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "01",
"type": "string",
"x-referencetype": "ProviderType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"package1": {
"description": "Package of service",
"example": "monthly",
"type": "string"
},
"result": {
"description": "Link of external result",
"example": "www.result.com",
"type": "string"
},
"status": {
"description": "The status of ExternalServiceHistory",
"example": "Pending",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the externalServicesHistory",
"example": "lata123",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServiceDocumentItem"
}
},
"comments": {
"description": "Comments",
"example": "Comments",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryRequests": {
"properties": {
"externalServicesHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequest"
}
}
}
},
"ExternalServicesHistoryRespose": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"externalServicesHistoryId": {
"description": "Unique Identifier of externalServicesHistory",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "Airtel",
"type": "string"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "3g",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"package1": {
"description": "Package of service",
"example": "monthly",
"type": "string"
},
"result": {
"description": "Link of external result",
"example": "www.result.com",
"type": "string"
},
"status": {
"description": "The status of ExternalServiceHistory",
"example": "Pending",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the externalServicesHistory ",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the externalServicesHistory was last changed",
"type": "string",
"format": "date"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServiceDocumentItem"
}
},
"comments": {
"description": "Comments",
"example": "Comments",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryResposes": {
"properties": {
"externalServicesHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
}
}
},
"ProcessedExternalServicesHistoryResponse": {
"properties": {
"externalServicesHistoryId": {
"description": "Unique identifier for externalServicesHistory",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRequestProcessRelation": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R123456",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F123456",
"type": "string"
},
"parentProcessId": {
"description": "unique identifier of parentProcess",
"example": "P123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRequestProcessRelations": {
"properties": {
"requestProcessRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRequestProcessRelation"
}
}
}
},
"RequestProcessRelationResponse": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R123456",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F123456",
"type": "string"
},
"parentProcessId": {
"description": "unique identifier of parentProcess",
"example": "P123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RequestProcessRelationResponses": {
"properties": {
"requestProcessRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestProcessRelationResponse"
}
}
}
},
"CreateFacilityApproverInfo": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F20217632573",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "C2021754566",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "7645756",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "7645756",
"type": "string"
},
"riskOfficerUserId": {
"description": "userId of the riskOfficer",
"example": "01",
"type": "string"
},
"riskOfficerDecisionId": {
"description": "decisionId of the riskOfficer",
"example": "7645756",
"type": "string"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFacilityApproversInfo": {
"properties": {
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFacilityApproverInfo"
}
}
}
},
"ProcessedFacilityApproverInfoResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for facilityApprover",
"example": "2007228945674",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityApproverInfo": {
"properties": {
"rowId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F20217632573",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "C2021754566",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "7645756",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "01",
"type": "string"
},
"riskOfficerUserId": {
"description": "userId of the riskOfficer",
"example": "01",
"type": "string"
},
"riskOfficerDecisionId": {
"description": "decisionId of the riskOfficer",
"example": "7645756",
"type": "string"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "7645756",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the facilityApproverInfo was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityApproversInfo": {
"properties": {
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
}
}
},
"MemberInfo": {
"properties": {
"memberId": {
"description": "Member Id",
"example": "bfleck",
"type": "string"
},
"memberRole": {
"description": "Member Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
}
}
},
"CreateMomInfo": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "CC3",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "gregory",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "secretary",
"type": "string"
},
"mom": {
"description": "MOM",
"example": "mom Details Added",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MomDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"MomDocumentItem": {
"properties": {
"documentId": {
"description": "ID of the document uploaded in mom",
"example": "D20201234",
"type": "string"
},
"documentName": {
"description": "Name of the document",
"example": "asset.txt",
"type": "string"
}
}
},
"MomInfo": {
"properties": {
"rowId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "CC3",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "gregory",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "secretary",
"type": "string"
},
"mom": {
"description": "MOM",
"example": "MOM123",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MomDocumentItem"
}
},
"lastChangeDateTime": {
"description": "Date when the facilityApproverInfo was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateMomInfos": {
"properties": {
"momInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateMomInfo"
}
}
}
},
"ProcessedMomInfoResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for facilityApprover",
"example": "2007228945674",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"MomInfos": {
"properties": {
"momInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MomInfo"
}
}
}
},
"CreditCommitteeRequest": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Committee",
"example": "CR1726789239",
"type": "string"
},
"committeeName": {
"description": "Name of a Committeee",
"example": "CC1",
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberInfo"
}
},
"noOfDecisions": {
"description": "Number of Decisions needed for the commitee to carry on with the decision",
"example": "4",
"type": "string"
},
"secretaryId": {
"description": "Secretary Id",
"example": "gregory",
"type": "string"
},
"secretaryRole": {
"description": "Secretary Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"hierarchy": {
"description": "Hierarchy of a committee",
"example": "10",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeRequests": {
"properties": {
"creditCommitteeRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditCommitteeRequest"
}
}
}
},
"ProcessedCreditCommitteeResponse": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Credit Committee",
"example": "CR7628390",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeResponse": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Committee",
"example": "CR1726789239",
"type": "string"
},
"committeeName": {
"description": "Name of a Committeee",
"example": "CC1",
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberInfo"
}
},
"noOfDecisions": {
"description": "Number of Decisions needed for the commitee to carry on with the decision",
"example": "4",
"type": "string"
},
"secretaryId": {
"description": "secretary ID",
"example": "01",
"type": "string"
},
"secretaryRole": {
"description": "secretary Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the credit commitee was last changed",
"type": "string",
"format": "date"
},
"hierarchy": {
"description": "Hierarchy of a committee",
"example": "10",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeResponses": {
"properties": {
"creditCommitteeResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditCommitteeResponse"
}
}
}
},
"FacilitiesInfoResponse": {
"properties": {
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "Line of Credit",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"facilityName": {
"description": "Name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "Awaiting Approval",
"type": "string"
}
}
},
"RecentViewedRequestSuccessResponse": {
"properties": {
"userId": {
"description": "Unique identifier for user",
"example": "bfleck",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"RecentViewedInputRequest": {
"properties": {
"userId": {
"description": "Unique Identifier of User",
"example": "bfleck",
"type": "string"
},
"requestId": {
"description": "Unique Identifier of Request",
"example": "D48759833",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RecentViewedRequestResponse": {
"properties": {
"userId": {
"description": "Unique Identifier of User",
"example": "bfleck",
"type": "string"
},
"requestId": {
"description": "Unique Identifier of Request",
"example": "D48759833",
"type": "string"
},
"timeStamp": {
"description": "Date when the Recent review request was last changed",
"example": "2021-08-11 08:36:02.697",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"RecentViewedRequestResponses": {
"properties": {
"recentViewedResponses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecentViewedRequestResponse"
}
}
}
},
"CustomerActionRequest": {
"properties": {
"customerActionId": {
"description": "Uniquely generated uuid Customer Action Instance",
"example": "95a138d2-1c8b-11ec-9621-0242ac130002",
"type": "string"
},
"customerActionName": {
"description": "Unique Idenitifier of a customer action type",
"example": "IncomeDocument,EmploymentStatus",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"customerActionType": {
"description": "Type Of User Action",
"example": "Currency, Date",
"type": "string"
},
"group": {
"description": "User Action Group",
"example": "Personal Information",
"type": "string"
},
"actionLevel": {
"description": "Entity or Facility",
"example": "Entity",
"type": "string"
},
"createdBy": {
"description": "User Name of the creator",
"example": "ABC",
"type": "string"
},
"createdTime": {
"description": "Date when the Customer Action was created",
"type": "string",
"format": "date"
},
"title": {
"description": "Heading of the user action card",
"example": "Please Enter your First Name",
"type": "string"
},
"titleKey": {
"description": "Unique key to support internalization",
"example": "TIN01234",
"type": "string"
},
"appliesToId": {
"description": "Facility Id/Drawing Id if the action level is facility or Entity Id if the action levele is entity",
"example": "F0123456,F0123456-01,E012345",
"type": "string"
},
"appliesToName": {
"description": "Full name of the entity if level is entity",
"example": "false",
"type": "string"
},
"responseValues": {
"description": "Response values provided by customer",
"example": "Accepted",
"type": "string"
},
"responseTimeStamp": {
"description": "Date when Customer gave the response",
"type": "string",
"format": "date"
},
"responseChannel": {
"description": "Channel from where the response comes",
"example": "Origination",
"type": "string"
},
"customerActionStatus": {
"description": "Status of the user action",
"example": "Pending with Customer/Submitted/Waived/Skipped",
"type": "string"
},
"taskId": {
"description": "Id of the associated task",
"example": "123456789",
"type": "string"
},
"processId": {
"description": "Process ID",
"example": "P1234567",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerActionsResponse": {
"properties": {
"customerActionId": {
"description": "Unique identifier for Customer Actions",
"example": "95a138d2-1c8b-11ec-9621-0242ac130002",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Any further details"
}
}
},
"CustomerActionsByTaskResponse": {
"properties": {
"customerActionId": {
"description": "Uniquely generated uuid Customer Action Instance",
"example": "95a138d2-1c8b-11ec-9621-0242ac130002",
"type": "string"
},
"customerActionName": {
"description": "Unique Idenitifier of a customer action type",
"example": "IncomeDocument,EmploymentStatus",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"customerActionType": {
"description": "Type Of User Action",
"example": "Currency, Date",
"type": "string"
},
"group": {
"description": "User Action Group",
"example": "Personal Information",
"type": "string"
},
"actionLevel": {
"description": "Entity or Facility",
"example": "Entity",
"type": "string"
},
"createdBy": {
"description": "User Name of the creator",
"example": "ABC",
"type": "string"
},
"createdTime": {
"description": "Date when the Customer Action was created",
"type": "string",
"format": "date"
},
"title": {
"description": "Heading of the user action card",
"example": "Please Enter your First Name",
"type": "string"
},
"titleKey": {
"description": "Unique key to support internalization",
"example": "TIN01234",
"type": "string"
},
"appliesToId": {
"description": "Facility Id/Drawing Id if the action level is facility or Entity Id if the action levele is entity",
"example": "FF0123456,F0123456-01,E012345",
"type": "string"
},
"appliesToName": {
"description": "Full name of the entity if level is entity",
"example": "false",
"type": "string"
},
"responseValues": {
"description": "Response values provided by customer",
"example": "Accepted",
"type": "string"
},
"responseTimeStamp": {
"description": "Date when Customer gave the response",
"type": "string",
"format": "date"
},
"responseChannel": {
"description": "Channel from where the response comes",
"example": "Origination",
"type": "string"
},
"customerActionStatus": {
"description": "Status of the user action",
"example": "Pending with Customer/Submitted/Waived/Skipped",
"type": "string"
},
"taskId": {
"description": "Id of the associated task",
"example": "123456789",
"type": "string"
},
"processId": {
"description": "Process ID",
"example": "P1234567",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerActionsByRequestResponse": {
"properties": {
"customerActionId": {
"description": "Uniquely generated uuid Customer Action Instance",
"example": "95a138d2-1c8b-11ec-9621-0242ac130002",
"type": "string"
},
"customerActionName": {
"description": "Unique Idenitifier of a customer action type",
"example": "IncomeDocument,EmploymentStatus",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"customerActionType": {
"description": "Type Of User Action",
"example": "Currency, Date",
"type": "string"
},
"group": {
"description": "User Action Group",
"example": "Personal Information",
"type": "string"
},
"actionLevel": {
"description": "Entity or Facility",
"example": "Entity",
"type": "string"
},
"createdBy": {
"description": "User Name of the creator",
"example": "ABC",
"type": "string"
},
"createdTime": {
"description": "Date when the Customer Action was created",
"type": "string",
"format": "date"
},
"title": {
"description": "Heading of the user action card",
"example": "Please Enter your First Name",
"type": "string"
},
"titleKey": {
"description": "Unique key to support internalization",
"example": "TIN01234",
"type": "string"
},
"appliesToId": {
"description": "Facility Id/Drawing Id if the action level is facility or Entity Id if the action levele is entity",
"example": "F0123456,F0123456-01,E012345",
"type": "string"
},
"appliesToName": {
"description": "Full name of the entity if level is entity",
"example": "false",
"type": "string"
},
"responseValues": {
"description": "Response values provided by customer",
"example": "Accepted",
"type": "string"
},
"responseTimeStamp": {
"description": "Date when Customer gave the response",
"type": "string",
"format": "date"
},
"responseChannel": {
"description": "Channel from where the response comes",
"example": "Origination",
"type": "string"
},
"customerActionStatus": {
"description": "Status of the user action",
"example": "Pending with Customer/Submitted/Waived/Skipped",
"type": "string"
},
"taskId": {
"description": "Id of the associated task",
"example": "123456789",
"type": "string"
},
"processId": {
"description": "Process ID",
"example": "P1234567",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerActionsRequests": {
"properties": {
"customerActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerActionRequest"
}
}
}
},
"CustomerActionsByTaskResponses": {
"properties": {
"customerActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerActionsByTaskResponse"
}
}
}
},
"CustomerActionsByRequestResponses": {
"properties": {
"customerActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerActionsByRequestResponse"
}
}
}
},
"ProcessedRiskScoreCardResponse": {
"properties": {
"riskScoreCardId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RiskScoreCardInfo": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"riskScoreCardId": {
"description": "Unique identifier of the Score Card",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"lineOfBusiness": {
"description": "Unique identifier of the line of business",
"example": "02",
"type": "string"
},
"totalRiskScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"riskScores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskScoreInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"RiskScoreInfo": {
"properties": {
"riskScoreType": {
"description": "Type of score",
"example": "Company Bureau Score",
"type": "string"
},
"value": {
"description": "Value of given type",
"example": 700,
"type": "integer",
"format": "decimal"
},
"riskScore": {
"description": "Value of score",
"example": 10,
"type": "integer",
"format": "decimal"
},
"extensionData": {
"type": "object"
}
}
},
"BankDetails": {
"properties": {
"bankType": {
"description": "Type of the Bank",
"example": "01",
"type": "string",
"x-referencetype": "BankType"
},
"accountNumber": {
"description": "Account Number",
"example": "AC2129222",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A12",
"type": "string"
},
"bankName": {
"description": "Bank Name",
"example": "ABC Bank",
"type": "string"
}
}
},
"AdditionalInstructionsRequest": {
"properties": {
"additionalInstructionId": {
"description": "ID of the Additional Instructions",
"example": "AI983495385",
"type": "string"
},
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Id of the drawing created for a Facility",
"example": "F202012345678-01",
"type": "string"
},
"facilityType": {
"description": "Facility Type",
"example": "2",
"type": "string"
},
"authorizedUserId": {
"description": "The ID of authorized user",
"example": "A123",
"type": "string"
},
"instructionDate": {
"description": "Date of the Instruction",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"instructionType": {
"description": "The instruction Type",
"example": "10",
"type": "string",
"x-referencetype": "InstructionType"
},
"bankDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BankDetails"
}
]
},
"autoPay": {
"description": "Auto Pay",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"payType": {
"description": "Pay Type",
"example": "SWIFT",
"type": "string",
"x-referencetype": "RepaymentPayType"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Additional Instruction was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"AdditionalInstructionsRequests": {
"properties": {
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInstructionsRequest"
}
}
}
},
"AdditionalInstructionsResponse": {
"properties": {
"additionalInstructionId": {
"description": "ID of the Additional Instructions",
"example": "AI983495385",
"type": "string"
},
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Id of the drawing created for a Facility",
"example": "F202012345678-01",
"type": "string"
},
"facilityType": {
"description": "Facility Type",
"example": "2",
"type": "string"
},
"authorizedUserId": {
"description": "The ID of authorized user",
"example": "A123",
"type": "string"
},
"instructionDate": {
"description": "Date of the Instruction",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"instructionType": {
"description": "The instruction Type",
"example": "10",
"type": "string"
},
"bankDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BankDetails"
}
]
},
"autoPay": {
"description": "Auto Pay",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"payType": {
"description": "Pay Type",
"example": "SWIFT",
"type": "string",
"x-referencetype": "RepaymentPayType"
},
"lastChangeDateTime": {
"description": "Date when the Additional Instruction was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"AdditionalInstructionsResponses": {
"properties": {
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInstructionsResponse"
}
}
}
},
"ProcessedAdditionalInstructionsResponse": {
"properties": {
"additionalInstructionId": {
"description": "ID of the Additional Instructions",
"example": "AI8374823543",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"SourceOfFunds": {
"properties": {
"requestedAmount": {
"description": "Requested loan amount",
"example": 50000,
"type": "integer",
"format": "decimal"
},
"customerContribution": {
"description": "Customer contribution towards source of funds",
"example": 50000,
"type": "integer",
"format": "decimal"
},
"coApplicantContribution": {
"description": "Co-applicant's contribution towards source of funds",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"otherSource": {
"description": "Contribution from other sources towards source of funds",
"example": 12500,
"type": "integer",
"format": "decimal"
}
}
},
"SourceOfFundsResponse": {
"properties": {
"requestedAmount": {
"description": "Requested amount",
"example": 50000,
"type": "integer",
"format": "decimal"
},
"customerContribution": {
"description": "Customer contribution towards source of funds",
"example": 50000,
"type": "integer",
"format": "decimal"
},
"coApplicantContribution": {
"description": "Co-applicant's contribution towards source of funds",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"otherSource": {
"description": "Contribution from other sources towards source of funds",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"totalSourceOfFunds": {
"description": "Sum of all sources of fund",
"example": 87500,
"type": "integer",
"format": "decimal"
}
}
},
"UseOfFunds": {
"properties": {
"purchaseCost": {
"description": "Cost of property",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"governmentCharges": {
"description": "Government charges for purchase of property",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"bankCharges": {
"description": "Bank charges for purchase of property",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"insuranceCharges": {
"description": "Insurance charges for purchase of property",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"miscellaneousCharges": {
"description": "Miscellaneous charges for purchase of property",
"example": 6250.5,
"type": "integer",
"format": "decimal"
}
}
},
"UseOfFundsResponse": {
"properties": {
"purchaseCost": {
"description": "Cost of property",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"governmentCharges": {
"description": "Government charges for purchase of property",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"bankCharges": {
"description": "Bank charges for purchase of property",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"insuranceCharges": {
"description": "Insurance charges for purchase of property",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"miscellaneousCharges": {
"description": "Miscellaneous charges for purchase of property",
"example": 6250.5,
"type": "integer",
"format": "decimal"
},
"totalUseOfFunds": {
"description": "Sum of all uses of funds",
"example": 6250.5,
"type": "integer",
"format": "decimal"
}
}
},
"FundingPositionRequest": {
"properties": {
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"sourceOfFunds": {
"allOf": [
{
"$ref": "#/components/schemas/SourceOfFunds"
}
]
},
"useOfFunds": {
"allOf": [
{
"$ref": "#/components/schemas/UseOfFunds"
}
]
},
"lastChangeUserId": {
"description": "last Modification made by user on funding position",
"example": "rmuser",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FundingPositionResponseItem": {
"properties": {
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"currencyId": {
"description": "Currency for the funding position amounts",
"example": "USD",
"type": "string"
},
"sourceOfFunds": {
"allOf": [
{
"$ref": "#/components/schemas/SourceOfFundsResponse"
}
]
},
"useOfFunds": {
"allOf": [
{
"$ref": "#/components/schemas/UseOfFundsResponse"
}
]
},
"surplusOrDeficitAmount": {
"description": "Sum of all uses of funds",
"example": 6250.5,
"type": "integer",
"format": "decimal"
},
"lastChangeUserId": {
"description": "last Modification made by user on funding position",
"example": "rmuser",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the funding position was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"FundingPositionResponse": {
"properties": {
"fundingPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingPositionResponseItem"
}
}
}
},
"DrawingsTerm": {
"properties": {
"years": {
"description": "Number of Years",
"example": "2",
"type": "string"
},
"months": {
"description": "Number of Months",
"example": "12",
"type": "string"
},
"days": {
"description": "Number of Days",
"example": "31",
"type": "string"
}
}
},
"FixedInterestTerm": {
"properties": {
"interestYears": {
"description": "Number of Years",
"example": "4",
"type": "string"
},
"interestMonths": {
"description": "Number of Months",
"example": "12",
"type": "string"
},
"interestDays": {
"description": "Number of Days",
"example": "31",
"type": "string"
}
}
},
"DrawingsRequests": {
"properties": {
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsRequest"
}
}
}
},
"DrawingsRequest": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"drawingId": {
"description": "Unique Identifier of drawing",
"example": "F20221234567-01",
"type": "string"
},
"productId": {
"description": "productType of drawing",
"example": "Mortgage Facilities",
"type": "string"
},
"drawingName": {
"description": "Name of the drawing created for the facility",
"example": "First Installment",
"type": "string"
},
"drawingType": {
"description": "Drawing Type",
"example": "01",
"type": "string",
"x-referencetype": "DrawingType"
},
"mortgageType": {
"description": "Mortgage Type",
"example": "01",
"type": "string",
"x-referencetype": "MortgageType"
},
"requestAmount": {
"description": "Request Amount",
"example": "50000",
"type": "string"
},
"term": {
"allOf": [
{
"$ref": "#/components/schemas/DrawingsTerm"
}
]
},
"fixedInterestTerm": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestTerm"
}
]
},
"approvedAmount": {
"description": "Approved Amount",
"example": "12",
"type": "string"
},
"currencyId": {
"description": "Currency in which the Drawing is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"startDate": {
"description": "Date from which the drawing is effective",
"type": "string",
"format": "date"
},
"maturityDate": {
"description": "Maturity of the drawing",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDrawingsResponse": {
"properties": {
"drawingId": {
"description": "Id of the drawing created for a Facility",
"example": "F202012345678-01",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"DrawingsResponses": {
"properties": {
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsResponse"
}
}
}
},
"DrawingsResponse": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"drawingId": {
"description": "Unique Identifier of drawing",
"example": "F20221234567-01",
"type": "string"
},
"productId": {
"description": "productType of drawing",
"example": "Mortgage Facilities",
"type": "string"
},
"drawingName": {
"description": "Name of the drawing created for the facility",
"example": "First Installment",
"type": "string"
},
"drawingType": {
"description": "Drawing Type",
"example": "Initial",
"type": "string"
},
"mortgageType": {
"description": "Mortgage Type",
"example": "01",
"type": "string"
},
"requestAmount": {
"description": "Request Amount",
"example": "50000",
"type": "string"
},
"term": {
"allOf": [
{
"$ref": "#/components/schemas/DrawingsTerm"
}
]
},
"fixedInterestTerm": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestTerm"
}
]
},
"approvedAmount": {
"description": "Approved Amount",
"example": "50000",
"type": "string"
},
"currencyId": {
"description": "Currency in which the drawing is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"startDate": {
"description": "Date from which the drawing is effective",
"type": "string",
"format": "date"
},
"maturityDate": {
"description": "Maturity of the drawing",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ScheduleDetail": {
"properties": {
"dueAmount": {
"description": "Amount due for the schedule",
"example": "666.67",
"type": "string"
},
"paymentTypeName": {
"description": "Payment Type Name",
"example": "Linear Principal",
"type": "string"
},
"property": {
"description": "Property",
"example": "Account",
"type": "string"
},
"propertyAmount": {
"description": "Amount of the property",
"example": "666.67",
"type": "string"
}
}
},
"SimulationItem": {
"properties": {
"dueDate": {
"description": "Due date of the simulation",
"example": "15/04/21",
"type": "string"
},
"totalPayment": {
"description": "Total payment of the simulation",
"example": "1,513.15",
"type": "string"
},
"outstandingAmount": {
"description": "Outstanding Amount of the simulations",
"example": "1,666.66",
"type": "string"
},
"scheduleDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleDetail"
}
}
}
},
"PaymentScheduleRequests": {
"properties": {
"paymentSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleRequest"
}
}
}
},
"PaymentScheduleRequest": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"drawingId": {
"description": "Unique Identifier of drawing",
"example": "F20221234567-01",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the request",
"example": "F20221234567",
"type": "string"
},
"scheduleId": {
"description": "Unique identifier of the request",
"example": "SH20221234567",
"type": "string"
},
"simulationType": {
"description": "Simulation Type",
"example": "01",
"type": "string",
"x-referencetype": "SimulationType"
},
"simulations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimulationItem"
}
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedPaymentScheduleResponse": {
"properties": {
"scheduleId": {
"description": "Id of the paymentSchedule created for a Drawing",
"example": "SH202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"PaymentScheduleResponses": {
"properties": {
"paymentSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleResponse"
}
}
}
},
"PaymentScheduleResponse": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"drawingId": {
"description": "Unique Identifier of drawing",
"example": "F20221234567-01",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the request",
"example": "F20221234567",
"type": "string"
},
"scheduleId": {
"description": "Unique identifier of the request",
"example": "SH20221234567",
"type": "string"
},
"simulationType": {
"description": "Simulation Type",
"example": "01",
"type": "string"
},
"simulations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimulationItem"
}
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ConsentData": {
"properties": {
"consents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsentItem"
}
}
}
},
"ConsentItem": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "R02035292905",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"consentId": {
"description": "Unique Identifier of consentId",
"example": "CST2132129222",
"type": "string"
},
"consentIdentifier": {
"description": "Consent Code",
"example": "Onboarding_Disclaimer",
"type": "string"
},
"acceptanceStatus": {
"description": "Acceptance status of the consent",
"example": true,
"type": "boolean"
},
"createdDate": {
"description": "Date when the consent is accepted by the user",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "Expiry Date of the consent",
"type": "string",
"format": "date"
},
"externalReferenceId": {
"description": "External Reference Id",
"example": "QWERD32",
"type": "string"
},
"versionId": {
"description": "Version Id of the consent",
"example": "1.0",
"type": "string"
},
"termsNConditionContentId": {
"description": "termsNConditionContentId of the consent",
"example": "TCC12345",
"type": "string"
},
"termsNConditionCodeId": {
"description": "termNConditionCodeId of the consent",
"example": "TE7645",
"type": "string"
},
"consentProvider": {
"description": "Name of the party who accepted the consent",
"example": "ABC corporation",
"type": "string"
},
"appliesTo": {
"description": "consent applies to which category",
"example": "Application",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
}
}
}
}
,
dom_id: "#swagger-ui4",
presets: [
SwaggerUIBundle.presets.apis,
]
})
</script> |
|
<html>
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui.css" />
<div id="swagger-ui5"></div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-bundle.js" type="text/javascript">
</script>
<script type="text/javascript">
const ui5 = SwaggerUIBundle({
spec:
{
"openapi": "3.0.0",
"servers": [
{
"description": "Locally Deployed Environment",
"url": "http://localhost:8600/ms-corporatelos-api/api/v1.0.0"
}
],
"info": {
"title": "Corporate LOS API",
"description": "This API enables you to programmatically access all data related to Corporate LOS that users has granted access.",
"version": "1.0.0",
"contact": {
"email": "mprasadambati@temenos.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"paths": {
"/origination/corporate/deals": {
"post": {
"summary": "Creates a new Corporate Request",
"description": "Creates new Corporate Request record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "createCorporateDealV1",
"tags": [
"Request"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Creation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealCreationResponse"
}
}
}
},
"400": {
"description": "Deal Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the corporate requests record",
"description": "Retrieves corporate requests record based on the request Id, Deal Name, User Id, externalReference Id.",
"operationId": "getCorporateDealsV1",
"tags": [
"Request"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestName",
"in": "query",
"description": "Request Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "count of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stageId",
"in": "query",
"description": "stage of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "orderOfRequest",
"in": "query",
"description": "order of requests to be displayed",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lineOfBusiness",
"in": "query",
"description": "lob of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "externalReferenceId",
"in": "query",
"description": "External Reference Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "All Deal Details Retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllDealDetailsResponse"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{requestId}": {
"put": {
"summary": "Updates an existing Corporate Request",
"description": "Update Corporate Deal record with the provided data such as PartyId, RelationShipManager and Facilities etc.",
"operationId": "updateCorporateDealV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Request"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDealSchema"
}
}
}
},
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealUpdatedResponse"
}
}
}
},
"400": {
"description": "Deal Update Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete the record of corporate request",
"description": "Delete Corporate Request record for given requestId .",
"operationId": "deleteCorporateDealV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Request"
],
"responses": {
"200": {
"description": "Deal Update Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Deal Delete Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/pagination": {
"get": {
"summary": "Retrieves the corporate requests and facility records based on pagination",
"description": "Retrieves corporate requests record based on the request Id, Deal Name, User Id, externalReference Id.",
"operationId": "getCorporateDealsByPaginationV1",
"tags": [
"Request"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestName",
"in": "query",
"description": "Request Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fromDate",
"in": "query",
"description": "request creation date",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "toDate",
"in": "query",
"description": "request creation date",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "currencyId",
"in": "query",
"description": "currency of request amount",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "minAmount",
"in": "query",
"description": "request Amount",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "maxAmount",
"in": "query",
"description": "request Amount",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Number of page",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "size of the page",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "The partyId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "The facilityId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityName",
"in": "query",
"description": "The Facility name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestStage",
"in": "query",
"description": "The Request stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityStage",
"in": "query",
"description": "The Facility stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relationshipManager",
"in": "query",
"description": "The relationship manager",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lineOfBusiness",
"in": "query",
"description": "The lineofBusiness of request",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "All Deal and Facility Details Retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllDealDetailsResponse"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}/facilities": {
"post": {
"summary": "Creates new facilities for a Deal",
"description": "Create Facility record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "createFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates already existing facilities for a Request",
"description": "Update Facility record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "updateFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "request Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/{facilityId}": {
"delete": {
"summary": "Delete facilities",
"description": "Delete Facility record based on facilityId.",
"operationId": "deleteFacilityV1",
"tags": [
"Facility"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility": {
"get": {
"summary": "Retrieves the Facility record",
"description": "Retrieves the Facility record based on the Request Id, Facility Id, Party Id and Facility Name .",
"operationId": "getFacilityV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityName",
"in": "query",
"description": "Facility Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Facility"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/financialResult": {
"post": {
"summary": "Create Financial Result",
"description": "Create the Financial Result with the provided data.",
"operationId": "createFinancialResultV1",
"tags": [
"FinancialResult"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultListRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Financial Result with the given financialResultId",
"description": "Update the Financial Result with the provided data.",
"operationId": "updateFinancialResultV1",
"tags": [
"FinancialResult"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFinancialResultListRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFinancialResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Financial Result details to the given financialResultId/partyId",
"description": "Retrieve the Financial Result records based on financialResultId/partyId.",
"operationId": "getFinancialResultV1",
"tags": [
"FinancialResult"
],
"parameters": [
{
"name": "financialResultId",
"in": "query",
"description": "Financial Result Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialResultsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/financialResult/{financialResultId}": {
"delete": {
"tags": [
"FinancialResult"
],
"summary": "soft delete the Financial Result",
"description": "Financial Result record with the provided financialResultId, will be deleted softly.",
"operationId": "deleteFinancialResultV1",
"parameters": [
{
"name": "financialResultId",
"in": "path",
"description": "ID of Financial Result to be deleted",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties": {
"post": {
"summary": "Create a relationship to the given Party id with the facility owner",
"description": "Create RelatedPartie record with the provided data such as requestId, facilityType and partyId etc.",
"operationId": "createRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the relationship to the given party id with the facilty owner",
"description": "Update RelatedPartie record with the provided data such as requestId, facilityId and partyId etc.",
"operationId": "updateRelatedPartiesV1",
"tags": [
"Related Parties"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the relatedParty record",
"description": "Retrieves the relatedParty record based on facilityId, relatedPartyId, partyId and requestId.",
"operationId": "getRelatedPartiesV1",
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "relatedPartyId",
"in": "query",
"description": "Related Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/connectedParties": {
"get": {
"summary": "Retrieves the connected Parties",
"description": "Retrieves the relatedParty record based on partyIds if they are related.",
"operationId": "getDealRelatedPartiesV1",
"parameters": [
{
"name": "party1",
"in": "query",
"description": "first party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "party2",
"in": "query",
"description": "second Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Related Parties"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/relatedParties/{rowId}": {
"delete": {
"tags": [
"Related Parties"
],
"summary": "soft delete the related parties",
"description": "related partyies record with the provided rowId, will be deleted softly.",
"operationId": "deleteRelatedPartiesV1",
"parameters": [
{
"name": "rowId",
"in": "path",
"description": "ID of row for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelatedPartiesSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks/{indicator}": {
"post": {
"summary": "Creates tasks for a Deal",
"description": "Create Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "createTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "indicator",
"in": "path",
"description": "indicator",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/deals/{dealId}/tasks": {
"put": {
"summary": "Updates the Task record",
"description": "Update Task record with the provided data such as dealId, partyId and taskName etc.",
"operationId": "updateTasksV1",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "dealId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedTasksResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks": {
"get": {
"summary": "Retrieves the details of tasks for the provided criteria",
"description": "Retrieves Task record based on dealId, partyId and Facility Id etc.",
"operationId": "getTasksV1",
"parameters": [
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "assignUserId",
"in": "query",
"description": "Assigned User Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "task status",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "stage",
"in": "query",
"description": "task stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasks/{taskId}": {
"delete": {
"summary": "Delete the task record",
"description": "Delete Task record based on taskId.",
"operationId": "deleteTasksV1",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "task Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dealId",
"in": "query",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "partyId",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"Tasks"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals": {
"post": {
"tags": [
"Collateral"
],
"summary": "Add a new collateral to the party",
"description": "Create collateral record with the provided data",
"operationId": "createCollateralV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Collateral"
],
"summary": "Update the collateral associated to the Party",
"description": "Update collateral record with the provided data for a Party",
"operationId": "updateCollateralV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Collateral"
],
"summary": "Fetch the collaterals associated to the Request/Facility/Party/Collateral",
"description": "Retrieves the collateral records based on RequestId, facilityId, partyId and collateralId.",
"operationId": "getCollateralV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "DealId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "PartyId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collaterals/{collateralId}": {
"delete": {
"tags": [
"Collateral"
],
"summary": "soft delete the collateral",
"description": "collateral record with the provided collateralId, will be deleted softly.",
"operationId": "deleteCollateralV1",
"parameters": [
{
"name": "collateralId",
"in": "path",
"description": "unique ID of collateral for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/collateralRelationships": {
"put": {
"tags": [
"Collateral"
],
"summary": "Map a collateral to the Request/Facility",
"description": "Delete existing collateral relationship and create new record with the provided data such as collateralId,requestId, facilityId.",
"operationId": "updateCollateralRelationshipV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRelationshipRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Collateral"
],
"summary": "Fetch the collateral Relationships associated to the Request/Facility/Collateral",
"description": "Delete the collateral Relationship records based on requestId, facilityId and collateralId.",
"operationId": "deleteCollateralRelationshipsV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "RequestId",
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "FacilityId",
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateralId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/collateralRelationships": {
"put": {
"tags": [
"Collateral"
],
"summary": "Map a collateral to the Facility",
"description": "Create new record with the provided data such as collateralId,requestId, facilityId.",
"operationId": "updateCollateralRelationshipForFacilityV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollateralRelationshipRequests"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCollateralResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents": {
"post": {
"summary": "creates new documents and adds them to deal",
"description": "Create document records with the provided data such as requestId, facilityId and document name etc.",
"operationId": "createDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCreationRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "updates the existing documents data",
"description": "Update document records with the provided data such as requestId, facilityId and document name etc.",
"operationId": "updateDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDocumentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of documents for the provided criteria",
"description": "Retrieve the document records based on dealId, facilityId and partyId.",
"operationId": "getDocumentsV1",
"tags": [
"Documents"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "Collateral Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "documentId",
"in": "query",
"description": "Document Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/documents/{documentId}": {
"delete": {
"tags": [
"Documents"
],
"summary": "soft delete the document",
"description": "Document record with the provided documentId,requestId,facilityId will be deleted softly.",
"operationId": "deletedocumentV1",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "ID of Document for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives": {
"post": {
"summary": "Create narrative and add to deal",
"description": "Create narrative records with the provided data such as dealId, facilityId , partyId and categoryId etc.",
"operationId": "createNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesCreateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update narrative",
"description": "Update narrative records with the provided data such as dealId, facilityId, partyId and categoryId etc.",
"operationId": "updateNarrativesV1",
"tags": [
"Narratives"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Narrative records",
"description": "Retrieves the Narrative records based on dealId, facilityId and partyId.",
"operationId": "getNarrativesV1",
"tags": [
"Narratives"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collateralId",
"in": "query",
"description": "Collateral Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/narratives/{narrativeId}": {
"delete": {
"tags": [
"Narratives"
],
"summary": "soft delete the narrative",
"description": "narrative record with the provided narrativeId, will be deleted softly.",
"operationId": "deleteNarrativeV1",
"parameters": [
{
"name": "narrativeId",
"in": "path",
"description": "ID of narrative for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "ID of Request",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of Facility",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "ID of Drawing",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/narratives": {
"put": {
"tags": [
"Narratives"
],
"summary": "Update narratives from Facility Overview",
"description": "Update narrative records with the provided data such as facilityId, category,userId etc.",
"operationId": "updateNarrativesFromFOV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NarrativesUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedNarrativesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/reference/{referenceId}": {
"get": {
"summary": "gets the reference data from reference tables",
"description": "Retrieves the reference data based on the referenceId.",
"operationId": "getRefData",
"tags": [
"Reference Data"
],
"parameters": [
{
"name": "referenceId",
"in": "path",
"description": "Reference Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerRequest": {
"post": {
"summary": "Stores the captured information of the request submission form",
"description": "Create customerRequest records with the provided data such as userId, requestId and customerInformation etc.",
"operationId": "createCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete the captured information of the request submission form",
"description": "Delete customerRequest records with the provided data such as userId, requestId etc.",
"operationId": "deleteCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerProcessedResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get all the information associated to the userid and requestid",
"description": "Retrieves customerRequest records based on userId, requestId and status.",
"operationId": "getCustomerRequestInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "status",
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "count",
"schema": {
"type": "string"
}
},
{
"name": "orderOfRequest",
"in": "query",
"description": "orderOfRequest",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerRequestsInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerRequest/facilityId": {
"get": {
"summary": "Get the information of inFlightFacilityId from given facilityId",
"description": "Retrieves inFlightFacilityId records based on facilityId.",
"operationId": "getModifiedFacilityInfoV1",
"tags": [
"CustomerRequest"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InFlightFacilityResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions": {
"post": {
"summary": "Creates draw restrictions for a particular deal",
"description": "Create drawRestriction records with the provided data such as requestId, facilityId and restrictionType etc.",
"operationId": "createDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Draw restrictions against a deal",
"description": "Update drawRestriction records with the provided data such as requestId, facilityId and restrictionType etc.",
"operationId": "updateDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawRestrictionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the details of draw restrictions against request or facility",
"description": "Retrieves drawRestriction records based on requestId, facilityId.",
"operationId": "getDrawRestrictionsV1",
"tags": [
"Draw Restrictions"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawRestrictionResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawRestrictions/{drawRestrictionId}": {
"delete": {
"tags": [
"Draw Restrictions"
],
"summary": "soft delete the Draw Restrictions",
"description": "Draw Restrictions record with the provided drawRestrictionId, will be deleted softly.",
"operationId": "deleteDrawRestrictionV1",
"parameters": [
{
"name": "drawRestrictionId",
"in": "path",
"description": "ID of Draw Restrictions for the request",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "ID of Facility",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance": {
"get": {
"summary": "Retrieves the details of the compliance for the provided criteria",
"description": "Retrieves the compliance records based on requestId, facilityId,partyId and complianceId.",
"operationId": "getComplianceV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "complianceId",
"in": "query",
"description": "complaince Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Compliance"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Compliance"
],
"summary": "Add a new compliance to the Deal",
"description": "Create the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "createComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Compliance"
],
"summary": "Update compliance to the Deal",
"description": "Update the compliance records with the provided data such as dealId, facilityId and complianceName etc.",
"operationId": "updateComplianceV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateComplianceRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedComplianceResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/compliance/{complianceId}": {
"delete": {
"tags": [
"Compliance"
],
"summary": "soft delete the compliance",
"description": "Compliance record with the provided complianceId, will be deleted softly.",
"operationId": "deleteComplianceV1",
"parameters": [
{
"name": "complianceId",
"in": "path",
"description": "ID of Compliance for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails": {
"post": {
"summary": "Create funding details",
"description": "Create the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "createFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsCreateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update fundings Details",
"description": "Update the funding records with the provided data such as dealId, facilityId and fundingAmount etc.",
"operationId": "updateFundingDetailsV1",
"tags": [
"Funding"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFundingDetailsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Funding details",
"description": "Retrieves the funding records based on dealId, facilityId and fundingId.",
"operationId": "getFundingDetailsV1",
"tags": [
"Funding"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fundingId",
"in": "query",
"description": "Funding Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "addressRefrence",
"in": "query",
"description": "reference of address",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingDetailsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingDetails/{fundingId}": {
"delete": {
"tags": [
"Funding"
],
"summary": "soft delete the fundings",
"description": "Fundings record with the provided fundingId, will be deleted softly.",
"operationId": "deleteFundingV1",
"parameters": [
{
"name": "fundingId",
"in": "path",
"description": "ID of funding for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits": {
"post": {
"summary": "Create limit records",
"description": "Create the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "createLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Limit details to the given limit id",
"description": "Update the limit records with the provided data such as dealId, facilityId and obligation etc.",
"operationId": "updateLimitsV1",
"tags": [
"Limits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedLimitResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieve the Limit record",
"description": "Retrieve the Limit record based on limitId.",
"operationId": "getLimitsV1",
"tags": [
"Limits"
],
"parameters": [
{
"name": "limitId",
"in": "query",
"description": "limit Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/limits/{limitId}": {
"delete": {
"tags": [
"Limits"
],
"summary": "soft delete the limits",
"description": "Limits record with the provided limitId, will be deleted softly.",
"operationId": "deleteLimitsV1",
"parameters": [
{
"name": "limitId",
"in": "path",
"description": "ID of limit for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees": {
"post": {
"summary": "create Fee details to the given facility/deal",
"description": "Create the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "createFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Fee details to the given id",
"description": "Update the Fee records with the provided data such as dealId, facilityId, feeType and feeName etc.",
"operationId": "updateFeesV1",
"tags": [
"Fees"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFeesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Fee details to the given facility id/deal id",
"description": "Retrieve the Fee records based on dealId, facilityId, feeType.",
"operationId": "getFeesV1",
"tags": [
"Fees"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fees/{feeId}": {
"delete": {
"tags": [
"Fees"
],
"summary": "soft delete the fees",
"description": "fees record with the provided feeId, will be deleted softly.",
"operationId": "deleteFeesV1",
"parameters": [
{
"name": "feeId",
"in": "path",
"description": "ID of fees for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings": {
"post": {
"summary": "create Pricing details to the given deal/facility",
"description": "Create the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "createPricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Pricing details to the given Pricing id",
"description": "Update the Pricing records with the provided data such as dealId, facilityId and interestRateType etc.",
"operationId": "updatePricingV1",
"tags": [
"Pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPricingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Pricing details to the given facility id",
"description": "Retrieve the Pricing records based on dealId, facilityId.",
"operationId": "getPricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/pricings/{pricingId}": {
"delete": {
"summary": "delete Pricing details to the given pricing id",
"description": "Delete the Pricing records based on pricing Id.",
"operationId": "deletePricingV1",
"tags": [
"Pricing"
],
"parameters": [
{
"name": "pricingId",
"in": "path",
"description": "pricing Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/accounts": {
"post": {
"summary": "create Account details to the given partyId",
"description": "Create the Account records with the provided data such as partyId, bankName etc.",
"operationId": "createAccountV1",
"tags": [
"Account"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedAccountResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update Account details to the given account id",
"description": "Update the account records with the provided data such as partyId and bankName etc.",
"operationId": "updateAccountV1",
"tags": [
"Account"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedAccountResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Account details to the given party id",
"description": "Retrieve the Account records based on partyId.",
"operationId": "getAccountV1",
"tags": [
"Account"
],
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/accounts/{accountId}": {
"delete": {
"summary": "delete Account details to the given account id",
"description": "Delete the Account records based on account Id.",
"operationId": "deleteAccountV1",
"tags": [
"Account"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants": {
"post": {
"summary": "Creates covenants for a Deal",
"description": "Create the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "createCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Covenants for a Deal",
"description": "Update the Covenant records with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the details of covenants for the provided criteria",
"description": "Retrieve the Covenant records based on dealId, facilityId, partyId and covenantId.",
"operationId": "getCovenantsV1",
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "covenantId",
"in": "query",
"description": "covenant Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/covenants/{covenantId}": {
"delete": {
"summary": "Delete the covenant record.",
"description": "Delete the covenant record based on covenantId.",
"operationId": "deleteCovenantsV1",
"parameters": [
{
"name": "covenantId",
"in": "path",
"description": "covenant Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"Covenants"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facility/covenants": {
"put": {
"summary": "Update the covenant record from Facility overview.",
"description": "Update the Covenant records From FO with the provided data such as dealId, facilityId and covenantname etc.",
"operationId": "updateCovenantsFromFOV1",
"tags": [
"Covenants"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CovenantsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCovenantsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions": {
"post": {
"summary": "create credit decisions to the given facility",
"description": "Create the creditDecision records with the provided data such as requestId, facilityId and decisionDate etc.",
"operationId": "createCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditDecisionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update credit decisions to the given creditDecision id",
"description": "Update the creditDecision records with the provided data such as requestId, facilityId and decisionDate etc.",
"operationId": "updateCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCreditDecisionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDecisionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the credit decisions to the given facility",
"description": "Retrieve the creditDecision records based on requestId,facilityId and decisionId.",
"operationId": "getCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "decisionId",
"in": "query",
"description": "decision Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditDecisionList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/scoreCard": {
"post": {
"summary": "create scorecard to the given facility",
"description": "Create the scorecard record with the provided data such as requestId, facilityId and scores etc.",
"operationId": "createScoreCardV1",
"tags": [
"ScoreCard"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScoreCardList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedScoreCardResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update scorecard to the given scorecard id",
"description": "Update the scorecard records with the provided data such as requestId, facilityId and scorecardId etc.",
"operationId": "updateScoreCardV1",
"tags": [
"ScoreCard"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateScoreCardList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedScoreCardResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the scorecard to the given facility",
"description": "Retrieve the ScoreCard records based on requestId,facilityId and scoreCardId.",
"operationId": "getScoreCardV1",
"tags": [
"ScoreCard"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "scoreCardId",
"in": "query",
"description": "scoreCard Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScoreCardList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/scoreCard/{scoreCardId}": {
"delete": {
"summary": "Delete scorecard to the given scorecard id",
"description": "Delete the scorecard record to given scorecard id.",
"operationId": "deleteScoreCardV1",
"tags": [
"ScoreCard"
],
"parameters": [
{
"name": "scoreCardId",
"in": "path",
"description": "scoreCard Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/riskScoreCard": {
"post": {
"summary": "create riskscorecard to the given entity",
"description": "Create the riskscorecard record with the provided data such as requestId, facilityId and scores etc.",
"operationId": "createRiskScoreCardV1",
"tags": [
"RiskScoreCard"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RiskScoreCardList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedRiskScoreCardResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the scorecard to the given entity",
"description": "Retrieve the ScoreCard records based on requestId,facilityId,partyId and riskScoreCardId.",
"operationId": "getRiskScoreCardV1",
"tags": [
"RiskScoreCard"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lineOfBusiness",
"in": "query",
"description": "lob",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "riskScoreCardId",
"in": "query",
"description": "risk scoreCard Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RiskScoreCardList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditDecisions/{creditDecisionId}": {
"delete": {
"summary": "Delete credit decisions to the given creditDecision id",
"description": "Delete the creditDecision record to given creditDecision id.",
"operationId": "deleteCreditDecisionV1",
"tags": [
"CreditDecisions"
],
"parameters": [
{
"name": "creditDecisionId",
"in": "path",
"description": "creditDecision Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/policyExceptions": {
"post": {
"summary": "create policy exceptions to the given facility",
"description": "Create the policyExceptions records with the provided data such as requestId, facilityId and exceptionType etc.",
"operationId": "createPolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExceptionsList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPolicyResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the policy exception to the given facility",
"description": "Retrieve the policy exception records based on facilityId and policyExceptionId.",
"operationId": "getPolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExceptionResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "update policy exceptions to the given policyException id",
"description": "Update the PolicyExceptions records with the provided data such as requestId, facilityId and exceptionType etc.",
"operationId": "updatePolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePolicyExceptionsList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPolicyResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/policyExceptions/{policyExceptionId}": {
"delete": {
"summary": "Delete policy exceptions to the given policy id",
"description": "Delete the policy exceptions record to given policy id.",
"operationId": "deletePolicyExceptionsV1",
"tags": [
"PolicyExceptions"
],
"parameters": [
{
"name": "policyExceptionId",
"in": "path",
"description": "policyException Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/conditions": {
"put": {
"summary": "update condition the given condition id",
"description": "Update the condition records with the provided data such as conditionId, creditDecisionId and etc.",
"operationId": "updateConditionV1",
"tags": [
"Conditions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConditionList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedConditionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/conditions/{conditionId}": {
"delete": {
"summary": "Delete the condition for given condition id",
"description": "Delete the condition records with the provided conditionId.",
"operationId": "deleteConditionV1",
"tags": [
"Conditions"
],
"parameters": [
{
"name": "conditionId",
"in": "path",
"description": "Condition Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requests/{requestId}": {
"get": {
"summary": "Retrieves the requestOverview details",
"description": "Retrieves the requestOverview details based on requestId.",
"operationId": "getRequestOverviewV1",
"tags": [
"RequestOverView"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Deal Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure": {
"post": {
"summary": "Create Exposure records",
"description": "Create the Exposure records with the provided data.",
"operationId": "createExposureV1",
"tags": [
"Exposure"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "get the Exposure records",
"description": "Retrieve the exposure records based on partyId and exposureUniqueId.",
"operationId": "getExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "exposureId",
"in": "query",
"description": "exposureId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "party Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureResponseList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure/{exposureId}": {
"delete": {
"summary": "Deletes exposure for the given exposure id",
"description": "Delete the exposure record to given exposure id.",
"operationId": "deleteExposureV1",
"tags": [
"Exposure"
],
"parameters": [
{
"name": "exposureId",
"in": "path",
"description": "exposure Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilities/{facilityId}": {
"get": {
"summary": "Retrieves FacilityOverview details",
"description": "Retrieves FacilityOverview details based on facilityId.",
"operationId": "getFacilityOverviewV1",
"tags": [
"FacilityOverview"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawings/{drawingId}": {
"get": {
"summary": "Retrieves DrawingOverview details",
"description": "Retrieves DrawingOverview details based on drawingId.",
"operationId": "getDrawingOverviewV1",
"tags": [
"DrawingOverview"
],
"parameters": [
{
"name": "drawingId",
"in": "path",
"description": "Drawing Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawingOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/tasksparams": {
"get": {
"summary": "Retrieves the data related to tasks params",
"description": "Retrieves the task records based on taskStage and taskId.",
"operationId": "getTasksParamsV1",
"tags": [
"TasksParams"
],
"parameters": [
{
"name": "taskStage",
"in": "query",
"description": "Task Stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "taskId",
"in": "query",
"description": "Task ID",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksParamsReferenceDataItems"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/{partyId}": {
"get": {
"summary": "Retrieves PartyOverview details",
"description": "Retrieves PartyOverview details based on partyId.",
"operationId": "getEntityOverviewV1",
"tags": [
"EntityOverview"
],
"parameters": [
{
"name": "partyId",
"in": "path",
"description": "party Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityOverViewResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message/{userId}": {
"post": {
"summary": "creates the messages to the dealId",
"description": "Create the messages records with the provided data such as userId, dealId and messagedescription etc.",
"operationId": "createMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessagesList"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/message": {
"get": {
"summary": "Retrieve the message records",
"description": "Retrieve the message records based on userId and messageId.",
"operationId": "getMessageV1",
"tags": [
"Messages"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "user Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "messageId",
"in": "query",
"description": "message Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMessagesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/integrationServices": {
"get": {
"summary": "Retrieves the details of the integrationServices for the provided criteria",
"description": "Retrieves the integrationServices records based on requestId, facilityId,partyId and integrationServicesId.",
"operationId": "getIntegrationServicesV1",
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "integrationServicesId",
"in": "query",
"description": "integrationServices Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"IntegrationServices"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"IntegrationServices"
],
"summary": "Add a new integrationServices to the facility or party",
"description": "Create the integrationService records with the provided data.",
"operationId": "createIntegrationServicesV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedIntegrationServicesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"IntegrationServices"
],
"summary": "Update IntegrationServices to the facility or party",
"description": "Update the integrationService records with the provided data.",
"operationId": "updateIntegrationServicesV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationServicesRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedIntegrationServicesResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/integrationServices/{integrationServicesId}": {
"delete": {
"tags": [
"IntegrationServices"
],
"summary": "soft delete the integrationServices",
"description": "IntegrationServices record with the provided integrationServicesId, will be deleted softly.",
"operationId": "deleteIntegrationServicesV1",
"parameters": [
{
"name": "integrationServicesId",
"in": "path",
"description": "ID of IntegrationServices for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/externalServicesHistory": {
"get": {
"summary": "Retrieves the details of the externalServicesHistory for the provided criteria",
"description": "Retrieves the externalServicesHistory records based on requestId, facilityId,partyId and externalServicesHistoryId.",
"operationId": "getExternalServicesHistoryV1",
"parameters": [
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "externalServicesHistoryId",
"in": "query",
"description": "externalServicesHistory Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"tags": [
"ExternalServicesHistory"
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryResposes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"ExternalServicesHistory"
],
"summary": "Add a new externalServicesHistory to the request",
"description": "Create the externalServicesHistory records with the provided data.",
"operationId": "createExternalServicesHistoryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedExternalServicesHistoryResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"ExternalServicesHistory"
],
"summary": "Update externalServicesHistory to the facility or party",
"description": "Update the externalServicesHistory records with the provided data.",
"operationId": "updateExternalServicesHistoryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedExternalServicesHistoryResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/externalServicesHistory/{externalServicesHistoryId}": {
"delete": {
"tags": [
"ExternalServicesHistory"
],
"summary": "soft delete the externalServicesHistory",
"description": "ExternalServicesHistory record with the provided externalServicesHistoryId, will be deleted softly.",
"operationId": "deleteExternalServicesHistoryV1",
"parameters": [
{
"name": "externalServicesHistoryId",
"in": "path",
"description": "ID of externalServicesHistory for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/requestProcessRelation": {
"post": {
"summary": "Creates a new Request Process relationship",
"description": "Creates new requestProcessRelation record with the provided data such as facilityId, parenProcessId and requestId etc.",
"operationId": "createRequestProcessRelationV1",
"tags": [
"RequestProcessRelationship"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestProcessRelations"
}
}
}
},
"responses": {
"200": {
"description": "Create RequestProcessRelation Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "RequestProcessRelation Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Request Process relationship",
"description": "Retrieves Request Process relationship record based on the request Id,facility Id, parenProcess Id.",
"operationId": "getRequestProcessRelationV1",
"tags": [
"RequestProcessRelationship"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "parenProcessId",
"in": "query",
"description": "parenProcess Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "RequestProcessRelation retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestProcessRelationResponses"
}
}
}
},
"400": {
"description": "All Deal Details Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilityApproverInfo": {
"post": {
"summary": "Creates the Facility Approver Info",
"description": "Creates facility approver info with the provided data such as requestId, facilityId, committeeId and approverUserId etc.",
"operationId": "createFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFacilityApproversInfo"
}
}
}
},
"responses": {
"200": {
"description": "Create FacilityApproverInfo Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityApproverInfoResponse"
}
}
}
},
"400": {
"description": "FacilityApproverInfo Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Facility Approver Info",
"description": "Retrieves facility approver info based on the requestId,facilityId, committeeId",
"operationId": "getFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "FacilityApproverInfo retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityApproversInfo"
}
}
}
},
"400": {
"description": "FacilityApproverInfo Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Facility Approver Info",
"description": "Update the Facility Approver Info with the provided data",
"operationId": "updateFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FacilityApproversInfo"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedFacilityApproverInfoResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/facilityApproverInfo/{rowId}": {
"delete": {
"summary": "Delete the Facility Approver Info",
"description": "facilityApproverInfo will be deleted with the provided rowId",
"operationId": "deleteFacilityApproverInfoV1",
"tags": [
"FacilityApproverInfo"
],
"parameters": [
{
"name": "rowId",
"in": "path",
"description": "ID of row for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/momInfo": {
"post": {
"summary": "Creates the MOM Info",
"description": "Creates minutes of meeting info with the provided data such as requestId, committeeId and approverUserId etc.",
"operationId": "createMomInfoV1",
"tags": [
"MomInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMomInfos"
}
}
}
},
"responses": {
"200": {
"description": "Create MomInfo Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedMomInfoResponse"
}
}
}
},
"400": {
"description": "MomInfo Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Mom Info",
"description": "Retrieves minutes of meeting info based on the requestId and committeeId",
"operationId": "getMomInfoV1",
"tags": [
"MomInfo"
],
"parameters": [
{
"name": "rowId",
"in": "query",
"description": "Row Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "committeeId",
"in": "query",
"description": "Committee Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "MomInfo retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MomInfos"
}
}
}
},
"400": {
"description": "MomInfo Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditCommitteeInfo": {
"post": {
"summary": "Creates the Credit Committee Info",
"description": "Creates credit Committee info with the provided data",
"operationId": "createCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeRequests"
}
}
}
},
"responses": {
"200": {
"description": "Create CreditCommitteeInfo Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditCommitteeResponse"
}
}
}
},
"400": {
"description": "Credit Committee Creation Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Credit Committee Info",
"description": "Retrieves credit Committee info",
"operationId": "getCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"parameters": [
{
"name": "committeeId",
"in": "query",
"description": "Committee Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "committeeName",
"in": "query",
"description": "Committee Name",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "CreditCommiteeInfo retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeResponses"
}
}
}
},
"400": {
"description": "CreditCommitteeInfo Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update the Credit Committee Info",
"description": "Update the Credit Committee Info with the provided data",
"operationId": "updateCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditCommitteeRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedCreditCommitteeResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/creditCommitteeInfo/{committeeId}": {
"delete": {
"summary": "Delete the Credit Committee Info",
"description": "creditCommittee will be deleted with the provided committeeId",
"operationId": "deleteCreditCommitteeInfoV1",
"tags": [
"CreditCommittee"
],
"parameters": [
{
"name": "committeeId",
"in": "path",
"description": "ID of Committee for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/recentViewedRequestInfo": {
"post": {
"summary": "Create Recently Viewed Request",
"description": "Recently Viewed Requests by a user added",
"operationId": "createRecentViewedRequestInfoV1",
"tags": [
"RecentlyViewedRequest"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecentViewedInputRequest"
}
}
}
},
"responses": {
"200": {
"description": "Recently Viewed Request Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecentViewedRequestSuccessResponse"
}
}
}
},
"400": {
"description": "Recently Viewed Request Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get Recently Viewed Request",
"description": "Retrieves Recently viewed Request info",
"operationId": "getRecentViewedRequestInfoV1",
"tags": [
"RecentlyViewedRequest"
],
"parameters": [
{
"name": "userId",
"in": "query",
"description": "User Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "noOfDays",
"in": "query",
"description": "Duration of records to be retrived",
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "count of requests",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "orderOfRequest",
"in": "query",
"description": "order of requests to be displayed",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Recent Review Request retrieval Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecentViewedRequestResponses"
}
}
}
},
"400": {
"description": "RecentReviewRequest Retrieval Failure",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/parties/renewal": {
"post": {
"summary": "Update PartyId in all LOS tables",
"description": "parties renewal will update the valid partyId in all LOS tables for the request",
"operationId": "partyRenewV1",
"tags": [
"PartyUpdate"
],
"parameters": [
{
"name": "nonVerifiedPartyId",
"in": "query",
"description": "ID before party was verified",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "verifiedPartyId",
"in": "query",
"description": "ID after party was verified",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Id of the request",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerActions": {
"post": {
"summary": "Creates Customer Action",
"description": "creates customer actions with provided details such as customerActionName, customerActionType",
"operationId": "createCustomerActionsV1",
"tags": [
"CustomerActions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Customer Action for the given CustomerActionIds",
"description": "Updates customer actions with provided details such as customerActionStatus, responseValues",
"operationId": "updateCustomerActionsV1",
"tags": [
"CustomerActions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure/externalCommitments": {
"post": {
"summary": "Creates External Commitments",
"description": "creates External Commitments with provided details",
"operationId": "createExternalCommitmentsV1",
"tags": [
"ExternalCommitments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalCommitmentsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalCommitmentsResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates External Commitments",
"description": "Updates External Commitments with provided details",
"operationId": "updateExternalCommitmentsV1",
"tags": [
"ExternalCommitments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalCommitmentsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalCommitmentsResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the external commitments",
"description": "Gets the external commitments data",
"operationId": "getExternalCommitmentsV1",
"tags": [
"ExternalCommitments"
],
"parameters": [
{
"name": "externalCommitmentId",
"in": "query",
"description": "external Commitment Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureId",
"in": "query",
"description": "exposureId",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalCommitmentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure/externalCommitments/{externalCommitmentId}": {
"delete": {
"summary": "soft delete the external Commitment",
"description": "external Commitment record will be deleted softly.",
"operationId": "deleteExternalCommitmentsV1",
"tags": [
"ExternalCommitments"
],
"parameters": [
{
"name": "externalCommitmentId",
"in": "path",
"description": "external Commitment Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure/exposureComments": {
"post": {
"summary": "Creates Exposure Comments",
"description": "creates exposure comments with provided details",
"operationId": "createExposureCommentsV1",
"tags": [
"ExposureComments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureCommentsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureCommentsResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Exposure Comments",
"description": "Updates exposure comments with provided details",
"operationId": "updateExposureCommentsV1",
"tags": [
"ExposureComments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureCommentsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureCommentsResultResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Exposure Comments",
"description": "Gets the exposure comments data",
"operationId": "getExposureCommentsV1",
"tags": [
"ExposureComments"
],
"parameters": [
{
"name": "exposureCommentsId",
"in": "query",
"description": "exposure Comments Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exposureId",
"in": "query",
"description": "exposure Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExposureCommentsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure/exposureComments/{exposureCommentsId}": {
"delete": {
"summary": "soft delete the exposure comment",
"description": "exposure comment record for the provided exposurecommentId will be deleted",
"operationId": "deleteExposureCommentsV1",
"tags": [
"ExposureComments"
],
"parameters": [
{
"name": "exposureCommentsId",
"in": "path",
"description": "exposure Comments Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure/adjustments": {
"post": {
"summary": "Creates Adjustments",
"description": "creates Adjustments with provided details",
"operationId": "createAdjustmentsV1",
"tags": [
"Adjustments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdjustmentsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdjustmentsSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Adjustments .",
"description": "Updates Adjustments with provided details",
"operationId": "updateAdjustmentsV1",
"tags": [
"Adjustments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdjustmentsUpdateRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdjustmentsSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Adjustments details",
"description": "Retrieves the Adjustments records based on exposureId and adjustmentId.",
"operationId": "getAdjustmentsV1",
"tags": [
"Adjustments"
],
"parameters": [
{
"name": "exposureId",
"in": "query",
"description": "exposureId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "adjustmentId",
"in": "query",
"description": "adjustmentId",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdjustmentsGetResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/exposure/adjustments/{adjustmentId}": {
"delete": {
"summary": "soft delete the adjustments",
"description": "adjustments record will be deleted softly.",
"operationId": "deleteAdjustmentsV1",
"tags": [
"Adjustments"
],
"parameters": [
{
"name": "adjustmentId",
"in": "path",
"description": "adjustment Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerActions/task/{taskId}": {
"get": {
"summary": "Gets the customer action",
"description": "Gets the customer actions data based on the taskId and customerActionStatus",
"operationId": "getCustomerActionsByTaskV1",
"tags": [
"CustomerActions"
],
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "Task Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "customerActionStatus",
"in": "query",
"description": "Status of the customer action",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsByTaskResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerActions/request/{requestId}": {
"get": {
"summary": "Gets the customer action",
"description": "Gets the customer actions data based on the taskId and customerActionStatus",
"operationId": "getCustomerActionsByRequestV1",
"tags": [
"CustomerActions"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "customerActionName",
"in": "query",
"description": "CustomerAction Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "appliesToId",
"in": "query",
"description": "appliesToId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "customerActionStatus",
"in": "query",
"description": "Status of the Customer Action",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerActionsByRequestResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/customerActions/{customerActionId}": {
"delete": {
"summary": "soft delete the customer action",
"description": "customer action record for the provided customerActionId will be deleted softly.",
"operationId": "deleteCustomerActionsV1",
"tags": [
"CustomerActions"
],
"parameters": [
{
"name": "customerActionId",
"in": "path",
"description": "Customer Action Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/AdditionalInstructions": {
"post": {
"summary": "Creates Additional Instruction",
"description": "creates Additional Instructions with provided details such as instructionDate, instructionType",
"operationId": "createAdditionalInstructionsV1",
"tags": [
"AdditionalInstructions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInstructionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedAdditionalInstructionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Updates Additional Instructions for the given additionalInstructionIds",
"description": "Updates Additional Instructions with provided details such as instructionType, bank details",
"operationId": "updateAdditionalInstructionsV1",
"tags": [
"AdditionalInstructions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInstructionsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedAdditionalInstructionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Gets the Additional Instruction details",
"description": "Retrieves the Additional Instruction records based on facilityId and additionalInstructionId.",
"operationId": "getAdditionalInstructionsV1",
"tags": [
"AdditionalInstructions"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "additionalInstructionId",
"in": "query",
"description": "Additional Instruction Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInstructionsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/AdditionalInstructions/{additionalInstructionId}": {
"delete": {
"tags": [
"AdditionalInstructions"
],
"summary": "soft delete the Additional Instructions",
"description": "Additional Instructions record with the provided additionalInstructionId, will be deleted softly.",
"operationId": "deleteAdditionalInstructionsV1",
"parameters": [
{
"name": "additionalInstructionId",
"in": "path",
"description": "ID of Additional Instruction for the delete request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingPosition": {
"post": {
"summary": "Create a funding position for the given facility",
"description": "Create a funding position record with the source of funds and use of funds for the given facility",
"operationId": "createFundingPositionV1",
"tags": [
"FundingPosition"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingPositionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update a funding position for the given facility",
"description": "Update a funding position record with the source of funds and use of funds for the given facility",
"operationId": "updateFundingPositionV1",
"tags": [
"FundingPosition"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingPositionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the funding position record",
"description": "Retrieves funding position record based on the request Id or facility Id",
"operationId": "getFundingPositionV1",
"tags": [
"FundingPosition"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundingPositionResponse"
}
}
}
},
"400": {
"description": "Failure response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/fundingPosition/{facilityId}": {
"delete": {
"summary": "Delete funding position record belonging to a facility",
"description": "Delete funding position record based on facilityId.",
"operationId": "deleteFundingPositionV1",
"tags": [
"FundingPosition"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/drawings": {
"post": {
"summary": "Create drawing for the given facility",
"description": "Create drawing records with the provided data such as facilityId, drawingId , drawingName and drawingType etc.",
"operationId": "createDrawingsV1",
"tags": [
"Drawings"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawingsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawingsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update drawing details of the facility",
"description": "Update drawing records with the provided data such as facilityId, drawingId , drawingName and drawingType etc.",
"operationId": "updateDrawingsV1",
"tags": [
"Drawings"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawingsRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedDrawingsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Drawing records of a facility",
"description": "Retrieves the Drawing records based on facilityId and drawingId.",
"operationId": "getDrawingsV1",
"tags": [
"Drawings"
],
"parameters": [
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DrawingsResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/remortgageInfo": {
"post": {
"summary": "Create Re-Mortgage Information for the given facility",
"description": "Create Re-Mortgage details with the provided data such as facilityId, outStandingLoanAmount, bankDetails etc.",
"operationId": "createRemortgageInfoV1",
"tags": [
"RemortgageInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemortgageInfoRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedRemortgageInfoResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update Re-Mortgage Information of the facility",
"description": "Update Re-Mortgage records with the provided data such as facilityId, outStandingLoanAmount, bankDetails etc.",
"operationId": "updateRemortgageInfoV1",
"tags": [
"RemortgageInfo"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemortgageInfoRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedRemortgageInfoResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the Re-Mortgage Information of a facility",
"description": "Retrieves the Re-Mortgage records based on facilityId.",
"operationId": "getRemortgageInfoV1",
"tags": [
"RemortgageInfo"
],
"parameters": [
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemortgageInfoResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/remortgageInfo/{facilityId}": {
"delete": {
"summary": "Delete Re-Mortgage record belonging to a facility",
"description": "Delete Re-Mortgage record based on facilityId.",
"operationId": "deleteRemortgageInfoV1",
"tags": [
"RemortgageInfo"
],
"parameters": [
{
"name": "facilityId",
"in": "path",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/paymentSchedule": {
"post": {
"summary": "Create paymentSchedule for the given drawing",
"description": "Create paymentSchedule records with the provided data such as facilityId, drawingId , simulations etc.",
"operationId": "createPaymentScheduleV1",
"tags": [
"PaymentSchedule"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentScheduleRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPaymentScheduleResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update paymentSchedule details of the drawing",
"description": "Update drawing records with the provided data such as facilityId, drawingId , simulations etc.",
"operationId": "updatePaymentScheduleV1",
"tags": [
"PaymentSchedule"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentScheduleRequests"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessedPaymentScheduleResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the PaymentScheduleRequests records of a Drawing",
"description": "Retrieves the Drawing records based on facilityId,requestId,scheduleId drawingId.",
"operationId": "getPaymentScheduleV1",
"tags": [
"PaymentSchedule"
],
"parameters": [
{
"name": "drawingId",
"in": "query",
"description": "Drawing Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "Facility Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "scheduleId",
"in": "query",
"description": "Schedule Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentScheduleResponses"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/paymentSchedule/{scheduleId}": {
"delete": {
"summary": "Delete payment schedule record belonging to a scheduleId",
"description": "Delete payment schedule record based on scheduleId.",
"operationId": "deletePaymentScheduleV1",
"tags": [
"PaymentSchedule"
],
"parameters": [
{
"name": "scheduleId",
"in": "path",
"description": "schedule Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/notary": {
"post": {
"summary": "creates the Notary to the facilityId",
"description": "Create the Notary records with the provided data such as facilityId,requestId,Notary Name,Date of Deed,Comment,Status of Deed etc.",
"operationId": "createNotaryV1",
"tags": [
"Notarys"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotarysRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotarysResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieve the Notary records",
"description": "Retrieve the Notary records based on RequestId,facilityId and notaryId.",
"operationId": "getNotaryV1",
"tags": [
"Notarys"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "facilityId",
"in": "query",
"description": "facility Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "notaryId",
"in": "query",
"description": "notary Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetNotarysResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Notarys"
],
"summary": "Update Notary to the facility",
"description": "Update the compliance records with the provided data such as facilityId,requestId,Notary Name,Date of Deed,Comment,Status of Deed etc.",
"operationId": "updateNotaryV1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNotarysRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNotarysResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/notary/{notaryId}": {
"delete": {
"tags": [
"Notarys"
],
"summary": "soft delete the Notary",
"description": "Notary record with the provided notaryId, will be deleted softly.",
"operationId": "deleteNotaryV1",
"parameters": [
{
"name": "notaryId",
"in": "path",
"description": "ID of Notary for the request",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Default status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/consent": {
"post": {
"summary": "Create a consent for given request",
"description": "Create a consent record with provided data for the given request",
"operationId": "createConsentV1",
"tags": [
"Consent"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentData"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Retrieves the consent record",
"description": "Retrieves consent record based on the request Id or party Id",
"operationId": "getConsentV1",
"tags": [
"Consent"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "Request Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "partyId",
"in": "query",
"description": "Party Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "consentId",
"in": "query",
"description": "Consent Id",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentData"
}
}
}
},
"400": {
"description": "Failure response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
},
"put": {
"summary": "Update a consent for the given request",
"description": "Update a consent record with provided data for the given request",
"operationId": "updateConsentV1",
"tags": [
"Consent"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentData"
}
}
}
},
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/consent/{consentId}": {
"delete": {
"summary": "soft delete the consent",
"description": "consent record for the provided consentId will be deleted softly.",
"operationId": "deleteConsentV1",
"tags": [
"Consent"
],
"parameters": [
{
"name": "consentId",
"in": "path",
"description": "Consent Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardSuccessResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
},
"/origination/corporate/consent/{expiryDate}": {
"get": {
"summary": "Retrieves the expired consent records",
"description": "Retrieves consent record based on the expiryDate",
"operationId": "getExpiredConsentsV1",
"tags": [
"Consent"
],
"parameters": [
{
"name": "expiryDate",
"in": "path",
"description": "Expiry Date",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentData"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandardErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"UpdateNotaryRequest": {
"properties": {
"notaryId": {
"description": "Notary Id",
"example": "NTY202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"requestId": {
"description": "Request Id",
"example": "R202012345678",
"type": "string"
},
"notaryName": {
"description": "Notary Name",
"example": "desc 123",
"type": "string"
},
"dateOfDeed": {
"description": "Date of Deed",
"example": "desc 123",
"type": "string"
},
"comments": {
"description": "Comments",
"example": "desc 123",
"type": "string"
},
"status": {
"description": "Status",
"example": "desc 123",
"type": "string",
"x-referencetype": "MortgageNotaryStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateNotarysRequest": {
"properties": {
"notarys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateNotaryRequest"
}
}
}
},
"CreateNotaryRequest": {
"properties": {
"requestId": {
"description": "Request Id",
"example": "R202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"dateOfDeed": {
"description": "Date of Deed",
"example": "desc 123",
"type": "string"
},
"comments": {
"description": "Comments",
"example": "desc 123",
"type": "string"
},
"status": {
"description": "Status",
"example": "desc 123",
"type": "string",
"x-referencetype": "MortgageNotaryStatus"
},
"notaryName": {
"description": "Notary Name",
"example": "desc 123",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateNotarysRequest": {
"properties": {
"notarys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateNotaryRequest"
}
}
}
},
"CreateNotarysResponse": {
"properties": {
"notaryId": {
"description": "notary Id",
"example": "NTY202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"GetNotaryResponse": {
"properties": {
"notaryId": {
"description": "Notary Id",
"example": "NTY202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"dateOfDeed": {
"description": "Date of Deed",
"example": "desc 123",
"type": "string"
},
"requestId": {
"description": "Request Id",
"example": "R202012345678",
"type": "string"
},
"notaryName": {
"description": "Notary Name",
"example": "desc 123",
"type": "string"
},
"comments": {
"description": "Comments",
"example": "desc 123",
"type": "string"
},
"status": {
"description": "Status",
"example": "desc 123",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangedTime": {
"description": "Last Change Time",
"example": "true",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"GetNotarysResponse": {
"properties": {
"notarys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetNotaryResponse"
}
}
}
},
"FailureMessage": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"StandardErrorResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailureMessage"
}
},
"ProcessedFacilityResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityCreateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "01",
"type": "string"
},
"facilityId": {
"description": "Temperory id of the facility from onboarding",
"example": "T1234567",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"availableAmount": {
"description": "amount available for restriction",
"example": "5000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security coverage",
"example": "2356789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string",
"x-referencetype": "ApprovalStatus"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization unit Id",
"example": "20",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"approvedAmount": {
"description": "Approved Amount of Facility",
"example": "20000.00",
"type": "string",
"format": "decimal"
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"previousFacilityId": {
"description": "Previous id of the facility from onboarding",
"example": "T1234567909",
"type": "string"
},
"previousLoanAmount": {
"description": "Total amount of the Previous Loan",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"previousMaturityDate": {
"description": "Previous maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"approvedMaturityDate": {
"description": "Approved maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"paidAmount": {
"description": "Amount Paid",
"example": 10250022,
"type": "integer",
"format": "decimal"
},
"amendmentTypes": {
"description": "amendment Types Id",
"example": "01",
"type": "string"
},
"eligibleLoanAmount": {
"description": "Loan Amount",
"example": 600000,
"type": "integer",
"format": "decimal"
},
"isSimulationRequired": {
"description": "Simulation Required",
"example": "Yes",
"type": "string"
},
"aipRejectionReason": {
"description": "AIP Rejection Reason",
"example": "01",
"type": "string",
"x-referencetype": "RejectedReason"
},
"offerRejectionReason": {
"description": "Offer Accept or Reject",
"example": "02",
"type": "string",
"x-referencetype": "RejectedReason"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityUpdateRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "03",
"type": "string"
},
"availableAmount": {
"description": "amount available for restriction",
"example": "5000",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "01",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "01",
"type": "string",
"x-referencetype": "FacilityStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security Coverage",
"example": "2356789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "01",
"type": "string",
"x-referencetype": "AcceptanceStatus"
},
"accountNumber": {
"description": "Account Number",
"example": "12345656565",
"type": "string"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string",
"x-referencetype": "ApprovalStatus"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"approvedAmount": {
"description": "Approved Amount of Facility",
"example": "20000.00",
"type": "string",
"format": "decimal"
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"previousFacilityId": {
"description": "Previous id of the facility from onboarding",
"example": "T1234567909",
"type": "string"
},
"previousLoanAmount": {
"description": "Total amount of the Previous Loan",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"previousMaturityDate": {
"description": "Previous maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"approvedMaturityDate": {
"description": "Approved maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"paidAmount": {
"description": "Amount Paid",
"example": 10250022,
"type": "integer",
"format": "decimal"
},
"amendmentTypes": {
"description": "Amendment Types ",
"example": "01",
"type": "string"
},
"eligibleLoanAmount": {
"description": "Loan Amount",
"example": 600000,
"type": "integer",
"format": "decimal"
},
"isSimulationRequired": {
"description": "Simulation Required",
"example": "Yes",
"type": "string"
},
"aipRejectionReason": {
"description": "AIP Rejection Reason",
"example": "01",
"type": "string",
"x-referencetype": "RejectedReason"
},
"offerRejectionReason": {
"description": "Offer Accept or Reject",
"example": "02",
"type": "string",
"x-referencetype": "RejectedReason"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "Line of Credit",
"type": "string"
},
"usageId": {
"description": "Id of usage",
"example": "U12345",
"type": "string"
},
"availableAmount": {
"description": "amount available for restriction",
"example": "5000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"product": {
"description": "Product that the facility belongs to",
"example": "Q4 Line of Credit",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of facility",
"example": "beneficiary",
"type": "string"
},
"productLineId": {
"description": "Product Line of the product",
"example": "Line of Credit",
"type": "string"
},
"purposeId": {
"description": "Purpose for which the facility is availed",
"example": "Working Capital",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"utilisedAmount": {
"description": "Amount utilised in the facility",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"holdToMaturity": {
"description": "Amount should be hold on till matuirty",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"holdForSale": {
"description": "Amount that will be on hold till for sale",
"example": 10000,
"type": "integer",
"format": "decimal"
},
"requestDate": {
"description": "Date in which the facility is requested",
"type": "string",
"format": "date"
},
"startDate": {
"description": "Date from which the facility is effective",
"type": "string",
"format": "date"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string"
},
"maturityDate": {
"description": "Maturity of the facility in years",
"type": "string",
"format": "date"
},
"lgdRating": {
"description": "LGD rating of the facility",
"example": "A",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "Awaiting Approval",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on facility",
"example": "1001",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"securityCoverage": {
"description": "Security Coverage",
"example": "3456789",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"accountNumber": {
"description": "Account Number",
"example": "2232323322",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"acceptanceStatus": {
"description": "Status of the acceptance",
"example": "Approved",
"type": "string"
},
"approvalStatusId": {
"description": "Aprroval Status Id",
"example": "01",
"type": "string"
},
"activeProcessId": {
"description": "Active Process Id of the facility",
"example": "20",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"externalRefDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRefDetails"
}
},
"featuresDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesDetails"
}
},
"previousFacilityId": {
"description": "Previous id of the facility from onboarding",
"example": "T1234567909",
"type": "string"
},
"previousLoanAmount": {
"description": "Total amount of the Previous Loan",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"paidAmount": {
"description": "Amount Paid",
"example": 10250022,
"type": "integer",
"format": "decimal"
},
"previousMaturityDate": {
"description": "Previous maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"approvedMaturityDate": {
"description": "Approved maturity Date in which the facility is requested",
"type": "string",
"format": "date"
},
"amendmentTypes": {
"description": "Amendment Types ",
"example": "01",
"type": "string"
},
"eligibleLoanAmount": {
"description": "Loan Amount",
"example": 600000,
"type": "integer",
"format": "decimal"
},
"isSimulationRequired": {
"description": "Simulation Required",
"example": "Yes",
"type": "string"
},
"aipRejectionReason": {
"description": "AIP Rejection Reason",
"example": "Incorrect Account Data",
"type": "string"
},
"offerRejectionReason": {
"description": "Offer Accept or Reject",
"example": "Low Income",
"type": "string"
},
"extensionData": {
"type": "object"
},
"approvedAmount": {
"description": "Approved Amount of Facility",
"example": "20000.00",
"type": "string",
"format": "decimal"
}
}
},
"FacilityCreateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
}
}
},
"FacilityUpdateRequests": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityUpdateRequest"
}
}
}
},
"FacilityResponses": {
"properties": {
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
}
}
},
"RelatedPartiesSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
},
"rowId": {
"description": "Specifies RowId of the request",
"example": "R1234,R1290",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRelatedPartiesRequest": {
"properties": {
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"appFulfilmentId": {
"description": "Id of AppFulfilment",
"example": "AF1013925461",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateRelatedPartiesRequest": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "D202012345678",
"type": "string"
},
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related Party",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "03",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "01",
"type": "string",
"x-referencetype": "LimitType"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"appFulfilmentId": {
"description": "Id of AppFulfilment",
"example": "AF1013925461",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RelatedPartiesResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for the row",
"example": "12345678",
"type": "string"
},
"requestId": {
"description": "Unique identifier for deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"groupId": {
"description": "Unique Identifier of group",
"example": "123456789",
"type": "string"
},
"relatedPartyId": {
"description": "Unique Identifier of related party",
"example": "123456789",
"type": "string"
},
"relatedGroupId": {
"description": "Unique Identifier of related Group",
"example": "123456789",
"type": "string"
},
"relatedPartyRole": {
"description": "Role of the related party",
"example": "Guarantor",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"limitType": {
"description": "Type of the Limit for the related party",
"example": "Amount",
"type": "string"
},
"limit": {
"description": "Amount or Percentage of the Limit",
"example": "40",
"type": "string"
},
"appFulfilmentId": {
"description": "Id of AppFulfilment",
"example": "AF1013925461",
"type": "string"
},
"currencyId": {
"description": "Currency of the limit if applicable",
"example": "USD",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "last Modification made by user on related parties",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
}
}
},
"UpdateRelatedPartiesRequests": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateRelatedPartiesRequest"
}
}
}
},
"RelatedPartiesResponses": {
"properties": {
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
}
}
},
"ProcessedTasksResponse": {
"properties": {
"taskId": {
"description": "Unique identifier for Task",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"NoteItem": {
"properties": {
"noteDescription": {
"description": "description notes",
"example": "task notes",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the relatedparties was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"TasksRequest": {
"properties": {
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskProvider"
},
"taskPackage": {
"description": "Package of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPackage"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskCategory"
},
"taskType": {
"description": "Type of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskType"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskStatus"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "01",
"type": "string",
"x-referencetype": "TaskPriority"
},
"extensionData": {
"type": "object"
}
}
},
"TasksResponse": {
"properties": {
"dealId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"taskId": {
"description": "Identifier of the task",
"example": "T12345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "P202012345678",
"type": "string"
},
"taskName": {
"description": "Name of the task",
"example": "Adhoc task",
"type": "string"
},
"taskProvider": {
"description": "Provider of the task",
"example": "Moody's",
"type": "string"
},
"taskPackage": {
"description": "Package of the task",
"example": "Fraud-Check",
"type": "string"
},
"taskCheckList": {
"description": "Checklist for the tasks",
"example": "Borrower",
"type": "string"
},
"taskCategory": {
"description": "Category of the task",
"example": "Prescreening",
"type": "string"
},
"taskType": {
"description": "Type of the task",
"example": "Auto",
"type": "string"
},
"taskDescription": {
"description": "Description of the task",
"example": "Update the primary name of the borrower",
"type": "string"
},
"assignedUserId": {
"description": "The userid the task is assigned to",
"example": "ABC001",
"type": "string"
},
"assignedDate": {
"description": "Date on which the task is assigned",
"type": "string",
"format": "date"
},
"taskDueDate": {
"description": "Date on which the task has to complete",
"type": "string",
"format": "date"
},
"taskEndDate": {
"description": "Date on which the task has ended",
"type": "string",
"format": "date"
},
"taskStatus": {
"description": "Status of the task",
"example": "In-Process",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on tasks",
"example": "1001",
"type": "string"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteItem"
}
},
"taskPriority": {
"description": "priority of the task",
"example": "medium",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"TasksRequests": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksRequest"
}
}
}
},
"TasksResponses": {
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
}
}
},
"CollateralOverview": {
"properties": {
"collateralId": {
"description": "unique Identifier of collateral",
"example": "C123",
"type": "string"
},
"collateralName": {
"description": "Name of the collateral",
"example": "property",
"type": "string"
},
"collateralType": {
"description": "type of collateral",
"example": "01",
"type": "string"
},
"collateralSubType": {
"description": "subtype of collateral",
"example": "001",
"type": "string"
},
"ltvRatio": {
"description": "ltv ratio of collateral",
"example": "5",
"type": "string"
},
"collateralStatus": {
"description": "status of the collateral",
"example": "02",
"type": "string",
"x-referencetype": "CollateralStatus"
},
"advancedRate": {
"description": "advanced rate of collateral",
"example": "30",
"type": "string"
},
"salvageCurrency": {
"description": "currency ofsalvage value",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"salvageValue": {
"description": "salvage value of collateral",
"example": "30",
"type": "string"
},
"owner": {
"description": "owner of collateral",
"example": "abc",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of collateral",
"example": "abc",
"type": "string"
},
"additionalOwners": {
"description": "additional owners of collateral",
"example": "abc",
"type": "string"
},
"adjustedCollateralCurrency": {
"description": "currency value of the adjusted collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedCollateralValue": {
"description": "adjusted value of the collateral",
"example": "property",
"type": "string"
},
"isInsuranceRequired": {
"description": "insurance required for the collateral",
"example": "yes",
"type": "string"
},
"collateralSource": {
"description": "source of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralSource"
},
"propertyCostCurrency": {
"description": "currency of the Property Cost",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"propertyCost": {
"description": "Property Cost",
"example": "10000",
"type": "integer",
"format": "decimal"
},
"registeredPropertyOwner": {
"description": "Registered Property Owner of collateral",
"example": "abc",
"type": "string"
},
"registeredPropertyOwnerName": {
"description": "Registered Property Owner Name of collateral",
"example": "abc",
"type": "string"
}
}
},
"CollateralDetail": {
"properties": {
"description": {
"description": "description of collateral",
"example": "vehicle",
"type": "string"
},
"usage": {
"description": "usage of the collateral",
"example": "01",
"type": "string"
},
"usageRestriction": {
"description": "usageRestriction of collateral",
"example": "01",
"type": "string"
},
"usageDetails": {
"description": "usageDetails of the collateral",
"example": "property",
"type": "string"
},
"propertyType": {
"description": "property Type of collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralPropertyType"
},
"propertyStatus": {
"description": "property status of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralPropertyStatus"
},
"yearsOfConstruction": {
"description": "years of construction for the collateral",
"example": "3",
"type": "string"
},
"size": {
"description": "size of the collateral",
"example": "30sqft",
"type": "string"
},
"builtUpArea": {
"description": "built up area of the collateral",
"example": "200sqft",
"type": "string"
},
"underLease": {
"description": "is the collateral under lease",
"example": "yes",
"type": "string"
},
"beneficiary": {
"description": "beneficiary of the collateral",
"example": "xyz",
"type": "string"
},
"plan": {
"description": "plan of the collateral",
"example": "xyz",
"type": "string"
},
"section": {
"description": "section of the collateral",
"example": "abc",
"type": "string"
},
"plotNo": {
"description": "plot no of the collateral",
"example": "34",
"type": "string"
},
"registrationDate": {
"description": "registration date of the collateral",
"example": "04-04-2020",
"type": "string"
},
"landRegistryNumber": {
"description": "registration Number of the land",
"example": "12345",
"type": "string"
},
"landRegistryDistrict": {
"description": "registration Number of the land",
"example": "medak",
"type": "string"
},
"mortgageRegistrationNumber": {
"description": "registration number of mortgage",
"example": "1234",
"type": "string"
},
"mortgageRegistrationDate": {
"description": "registration date of mortgage",
"example": "04-04-2020",
"type": "string"
},
"mortgageRank": {
"description": "rank of mortgage",
"example": "first",
"type": "string"
},
"pariPassu": {
"description": "pariPassu detail of the collateral",
"example": "abc",
"type": "string"
},
"pariPassuPercentage": {
"description": "pariPassu detail of the collateral",
"example": "50",
"type": "string"
},
"occupancy": {
"description": "occupancy detail of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralOccupancy"
},
"country": {
"description": "country of the collateral",
"example": "India",
"type": "string"
},
"city": {
"description": "city of the collateral",
"example": "hyderabad",
"type": "string"
},
"state": {
"description": "state of the collateral",
"example": "Telangana",
"type": "string"
},
"address1": {
"description": "address1 of the collateral",
"example": "first street",
"type": "string"
},
"address2": {
"description": "address2 of the collateral",
"example": "second street",
"type": "string"
},
"postalCode": {
"description": "postalCode of the collateral",
"example": "200010",
"type": "string"
},
"newOrUsed": {
"description": "new or used collateral",
"example": "new",
"type": "string"
},
"year": {
"description": "year of manufacture",
"example": "3",
"type": "string"
},
"manufacturer": {
"description": "manufacturer of the collateral",
"example": "philips",
"type": "string"
},
"make": {
"description": "make of the collateral",
"example": "make",
"type": "string"
},
"usefulLife": {
"description": "usefulLife of the collateral",
"example": "3",
"type": "string"
},
"model": {
"description": "model of the collateral",
"example": "Z125",
"type": "string"
},
"issuerName": {
"description": "issuer name of the collateral",
"example": "200010",
"type": "string"
},
"documentNumber": {
"description": "document number of the collateral",
"example": "PAWD123",
"type": "string"
},
"dateOfIssue": {
"description": "date of issue of the collateral document",
"example": "02-02-2020",
"type": "string"
},
"placeOfIssue": {
"description": "place of Issue of the collateral",
"example": "hyderabad",
"type": "string"
},
"expiryDate": {
"description": "expiry date of the document of the collateral",
"example": "200010",
"type": "string"
},
"securityName": {
"description": "name of the security of the collateral",
"example": "abc",
"type": "string"
},
"securityId": {
"description": "security Id of the collateral",
"example": "Z125",
"type": "string"
},
"isincusip": {
"description": "isin/cusip of the collateral",
"example": "I234",
"type": "string"
},
"quantity": {
"description": "quantity of the collateral",
"example": "half",
"type": "string"
},
"costPriceCurrency": {
"description": "currency value of the costPrice collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"costPrice": {
"description": "cost Price of the collateral",
"example": "60000",
"type": "string"
},
"industry": {
"description": "industry of the collateral",
"example": "motor",
"type": "string"
},
"insuredCustomer": {
"description": "insured customer of the collateral",
"example": "abc",
"type": "string"
},
"chassisNumber": {
"description": "chassisNumber of the vehicle",
"example": "C123",
"type": "string"
},
"engineNumber": {
"description": "engineNumber of the vehicle",
"example": "E1234",
"type": "string"
},
"policyNumber": {
"description": "policy number of the collateral",
"example": "P1234",
"type": "string"
},
"insuredPremiumAmountCurrency": {
"description": "currency value of the insuredPremiumAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"insuredPremiumAmount": {
"description": "insured premium amount of the collateral",
"example": "60000",
"type": "string"
},
"accountNumber": {
"description": "account Number",
"example": "HDFC123",
"type": "string"
},
"bankName": {
"description": "bank name",
"example": "HDFC",
"type": "string"
},
"currentInterestRate": {
"description": "current interest rate",
"example": "10",
"type": "string"
},
"openingDate": {
"description": "opening date",
"example": "04-04-2020",
"type": "string"
},
"interestRateAsOf": {
"description": "interest rate as of",
"example": "10",
"type": "string"
},
"maturityDate": {
"description": "maturity date of the collateral",
"example": "04-04-2020",
"type": "string"
},
"contractStartDate": {
"description": "contract start date",
"example": "10-10-2020",
"type": "string"
},
"contractExpiryDate": {
"description": "contract expiry date",
"example": "04-04-2020",
"type": "string"
},
"stockType": {
"description": "type of stock",
"example": "new",
"type": "string"
},
"stockQuantity": {
"description": "quantity Of stock",
"example": "100 kg",
"type": "string"
},
"debtorOutstandingCurrency": {
"description": "currency value of the debtorOutstanding collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"debtorOutstanding": {
"description": "outStanding from debtors",
"example": "10000000",
"type": "string"
},
"creditorOutstandingCurrency": {
"description": "currency value of the creditorOutstanding collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"creditorOutstanding": {
"description": "outstanding from creditor",
"example": "049020",
"type": "string"
},
"mortgagePropertyType": {
"description": "Property type of Mortgage collateral",
"example": "01",
"type": "string",
"x-referencetype": "MortgagePropertyType"
},
"propertySubType": {
"description": "Property subtype of Mortgage collateral",
"example": "01",
"type": "string",
"x-referencetype": "MortgagePropertySubType"
},
"furnishedType": {
"description": "Furnished type of Mortgage collateral",
"example": "01",
"type": "string",
"x-referencetype": "FurnishedType"
},
"propertyAge": {
"description": "Property age of Mortgage collateral",
"example": "10",
"type": "string"
},
"mortgagePropertyStatus": {
"description": "Property status of Mortgage collateral",
"example": "01",
"type": "string",
"x-referencetype": "MortgagePropertyStatus"
},
"constructionCompletionDate": {
"description": "Construction Completion Date of Mortgage collateral Property",
"example": "yyyy-mm-dd",
"type": "string",
"format": "date"
},
"numberOfFloors": {
"description": "Number Of Floors of Mortgage collateral Property",
"example": "5",
"type": "string"
},
"sellerName": {
"description": "Seller name of Mortgage collateral",
"example": "Andrew",
"type": "string"
},
"expectedConstructionCompletionDate": {
"description": "expected Construction Completion Date of Mortgage collateral Property",
"example": "yyyy-mm-dd",
"type": "string",
"format": "date"
},
"propertyUsage": {
"description": "Property usage of Mortgage collateral Property",
"example": "01",
"type": "string",
"x-referencetype": "PropertyUsage"
},
"doorNumber": {
"description": "Door Number of Mortgage collateral Property",
"example": "101",
"type": "string"
},
"floorNumber": {
"description": "Floor Number of Mortgage collateral Property",
"example": "2",
"type": "string"
}
}
},
"CollateralDueDiligence": {
"properties": {
"nextValuationDate": {
"description": "next valuation date",
"example": "04-04-2020",
"type": "string"
},
"insuranceCompany": {
"description": "insurance company",
"example": "LIC",
"type": "string"
},
"requiredCoverage": {
"description": "required coverage",
"example": "02",
"type": "string",
"x-referencetype": "CollateralRequiredCoverage"
},
"agentName": {
"description": "name of the agent",
"example": "xyz",
"type": "string"
},
"policyNumber": {
"description": "policy number",
"example": "P1234",
"type": "string"
},
"coverageAmountCurrency": {
"description": "currency value of the coverageAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"coverageAmount": {
"description": "amount of coverage",
"example": "400000",
"type": "string"
},
"agentPhone": {
"description": "phone number of agent",
"example": "04042020",
"type": "string"
},
"policyType": {
"description": "policy type",
"example": "LIC",
"type": "string"
},
"deductableAmountCurrency": {
"description": "currency value of the coverageAmount collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"deductableAmount": {
"description": "deductable amount",
"example": "5000000",
"type": "string"
},
"agentEmail": {
"description": "email of the agent",
"example": "xyz@temenos.com",
"type": "string"
},
"expirationDate": {
"description": "expiration date",
"example": "04-04-2020",
"type": "string"
},
"additionalInsured": {
"description": "additionalInsured",
"example": "yes",
"type": "string"
},
"registration": {
"description": "registration",
"example": "LIC",
"type": "string"
},
"registrationLocation": {
"description": "registration Location",
"example": "hyderabad",
"type": "string"
},
"registrationExpiryDate": {
"description": "registrationexpiryDate",
"example": "02-02-2020",
"type": "string"
},
"liabiltyCoverageAmount": {
"description": "coverage amount of liability",
"example": "04042020",
"type": "string"
},
"personalInjuryCoverageAmount": {
"description": "coverage amount of personal injury",
"example": "1000000",
"type": "string"
},
"collisionCoverageAmount": {
"description": "coverage amount of collision",
"example": "1000000",
"type": "string"
},
"valuations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueRequest"
}
},
"otherDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OtherDueDiligenceRequest"
}
}
}
},
"ValueRequest": {
"properties": {
"valuationDate": {
"description": "date of report",
"example": "04-04-2020",
"type": "string"
},
"valuationValueCurrency": {
"description": "currency value of the valuationValue collateral",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"valuationValue": {
"description": "value",
"example": "100000",
"type": "string"
},
"valuationSource": {
"description": "source of report",
"example": "ABC corporation",
"type": "string"
},
"valuationDocumentId": {
"description": "Id of the report",
"example": "R1234",
"type": "string"
},
"valuationDocumentName": {
"description": "Name of the report",
"example": "Audit",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"OtherDueDiligenceRequest": {
"properties": {
"dueDelligencedate": {
"description": "date of report",
"example": "04-04-2020",
"type": "string"
},
"dueDelligenceType": {
"description": "type",
"example": "01",
"type": "string",
"x-referencetype": "CollateralTypeDueDiligence"
},
"dueDelligenceStatus": {
"description": "status of report",
"example": "ABC corporation",
"type": "string",
"x-referencetype": "CollateralStatusDueDiligence"
},
"dueDelligenceDocumentId": {
"description": "Id of the report",
"example": "R1234",
"type": "string"
},
"dueDelligenceDocumentName": {
"description": "Name of the report",
"example": "Audit",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRequest": {
"properties": {
"comments": {
"description": "comments on Collateral",
"example": "this property is shared",
"type": "string"
},
"partyId": {
"description": "partyId",
"example": "the party of the collateral",
"type": "string"
},
"externalReferenceId": {
"description": "external Reference Id",
"example": "CO21085YN701",
"type": "string"
},
"collateralOverview": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralOverview"
}
]
},
"collateralDetail": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDetail"
}
]
},
"collateralDueDiligence": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDueDiligence"
}
]
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the collateral",
"example": "lata123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralResponse": {
"properties": {
"comments": {
"description": "comments on Collateral",
"example": "this property is shared",
"type": "string"
},
"partyId": {
"description": "partyId",
"example": "the party of the collateral",
"type": "string"
},
"externalReferenceId": {
"description": "external Reference Id",
"example": "CO21085YN701",
"type": "string"
},
"collateralOverview": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralOverview"
}
]
},
"collateralDetail": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDetail"
}
]
},
"collateralDueDiligence": {
"allOf": [
{
"$ref": "#/components/schemas/CollateralDueDiligence"
}
]
},
"collateralRelationshipResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipsResponse"
}
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the collateral",
"example": "lata123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the collateral was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRequests": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRequest"
}
}
}
},
"CollateralResponses": {
"properties": {
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
}
}
},
"ProcessedCollateralResponse": {
"properties": {
"partyId": {
"description": "Unique identifier for party",
"example": "P202035269718",
"type": "string"
},
"collateralId": {
"description": "Collateral id",
"example": "C202035292905",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipRequest": {
"properties": {
"collateralId": {
"description": "Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"requestId": {
"description": "Identifier of Request",
"example": "R202104218237",
"type": "string"
},
"facilityId": {
"description": "Identifier of Facility",
"example": "F12345678623",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral Relationship",
"example": "1001",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipRequests": {
"properties": {
"collateralRelationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipRequest"
}
}
}
},
"CollateralRelationshipsResponse": {
"properties": {
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C202035292905",
"type": "string"
},
"requestId": {
"description": "Unique Identifier of Request",
"example": "R202035269718",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F200722894832",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Collateral Relationship",
"example": "1001",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeDateTime": {
"description": "Date when the Collateral Relationship was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralRelationshipsResponses": {
"properties": {
"collateralRelationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralRelationshipsResponse"
}
}
}
},
"DocumentCreationRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"expiryDate": {
"description": "Date Of Document Expiry",
"example": "02-03-2022",
"type": "string",
"format": "date"
},
"appEvidenceId": {
"description": "Id of evidence",
"example": "EV1013925529",
"type": "string"
},
"isReusable": {
"description": "Is Document reusable",
"example": "true",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentTypeList"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategoryList"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"isSystemGenerated": {
"description": "System generated documents identifier",
"example": "true",
"type": "string"
},
"appliesTo": {
"description": "Applies To Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentAppliesToCategory"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDocumentsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D2020123456",
"type": "string"
},
"documentId": {
"description": "Unique identifier for Document",
"example": "123456789",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentUpdateRequest": {
"properties": {
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier for Document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"expiryDate": {
"description": "Date Of Document Expiry",
"example": "02-03-2022",
"type": "string",
"format": "date"
},
"appEvidenceId": {
"description": "Id of evidence",
"example": "EV1013925529",
"type": "string"
},
"isReusable": {
"description": "Is Document reusable",
"example": "true",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "02",
"type": "string",
"x-referencetype": "DocumentTypeList"
},
"documentCategory": {
"description": "Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentCategoryList"
},
"documentStatus": {
"description": "Status of a document",
"example": "01",
"type": "string",
"x-referencetype": "DocumentStatus"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"isSystemGenerated": {
"description": "System generated documents identifier",
"example": "true",
"type": "string"
},
"appliesTo": {
"description": "Applies To Category of a document",
"example": "03",
"type": "string",
"x-referencetype": "DocumentAppliesToCategory"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of collateral",
"example": "123456789",
"type": "string"
},
"documentId": {
"description": "Unique Identifier of a document",
"example": "123456789",
"type": "string"
},
"documentName": {
"description": "name of a document",
"example": "Aadhar card",
"type": "string"
},
"expiryDate": {
"description": "Date Of Document Expiry",
"example": "02-03-2022",
"type": "string",
"format": "date"
},
"appEvidenceId": {
"description": "Id of evidence",
"example": "EV1013925529",
"type": "string"
},
"isReusable": {
"description": "Is Document reusable",
"example": "true",
"type": "string"
},
"documentVersion": {
"description": "Document Version",
"example": "1",
"type": "string"
},
"documentType": {
"description": "type of a document",
"example": "Terms Sheet",
"type": "string"
},
"documentCategory": {
"description": "Category of a document",
"example": "Entity",
"type": "string"
},
"documentStatus": {
"description": "Status of a document",
"example": "Approved",
"type": "string"
},
"documentMethod": {
"description": "Document Method",
"example": "Internal",
"type": "string"
},
"documentDelivery": {
"description": "Document Delivery",
"example": "eSign",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"fileSize": {
"description": "The size of the File",
"example": "10 MB",
"type": "string"
},
"lastChangeUserId": {
"description": "last Modification made by user on Documents",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"isSystemGenerated": {
"description": "System generated documents identifier",
"example": "true",
"type": "string"
},
"appliesTo": {
"description": "Applies To Category of a document",
"example": "03",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentCreationRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
}
}
},
"DocumentUpdateRequests": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentUpdateRequest"
}
}
}
},
"DocumentResponses": {
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
}
},
"FacilityTerm": {
"properties": {
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateDealSchema": {
"properties": {
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string"
},
"usageId": {
"description": "Usage of the deal",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"sourceOfApplication": {
"description": "The channel application is sourced",
"example": "Internal - Origination",
"type": "string",
"x-referencetype": "ApplicationSource"
},
"facilityList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityCreateRequest"
}
},
"relatedPartiesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRelatedPartiesRequest"
}
},
"documentsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCreationRequest"
}
},
"collateralsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"lastChangeUserId": {
"description": "last Modification made by user on Requests",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a Request",
"example": "ABC Corp",
"type": "string"
},
"requestStatus": {
"description": "status of a Request",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"activeProcessId": {
"description": "Active Process for Request",
"example": "1",
"type": "string"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
},
"approvedAmount": {
"description": "Approved Amount of Request",
"example": "20000.00",
"type": "string",
"format": "decimal"
}
}
},
"DealCreationResponse": {
"properties": {
"requestId": {
"description": "Request ID of the Deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "D487598",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "200722894",
"type": "string"
},
"collateralId": {
"description": "ID of the collateral created for this request",
"example": "200722894",
"type": "string"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"status": {
"description": "Status of the deal",
"example": "Created",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateDealSchema": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "01",
"type": "string"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"profitCenter": {
"description": "Profit Center details",
"example": "01",
"type": "string",
"x-referencetype": "ProfitCenter"
},
"branchId": {
"description": "ID of the branch for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Branch"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "01",
"type": "string",
"x-referencetype": "Portfolio"
},
"requestStatus": {
"description": "Status of the deal",
"example": "01",
"type": "string",
"x-referencetype": "DealStatus"
},
"requestDate": {
"description": "Date on which the deal was requested",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"withdrawalReasonType": {
"description": "Withdrawl reason type of the deal",
"example": "01",
"type": "string",
"x-referencetype": "WithdrawalReasonType"
},
"withdrawalReason": {
"description": "Reason for withdrawl",
"example": "Free text",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"extensionData": {
"type": "object"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"sourceOfApplication": {
"description": "The channel application is sourced",
"example": "Internal - Origination",
"type": "string",
"x-referencetype": "ApplicationSource"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
},
"approvedAmount": {
"description": "Approved Amount of Request",
"example": "20000.00",
"type": "string",
"format": "decimal"
}
}
},
"DealUpdatedResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"DealDetailsResponse": {
"properties": {
"requestId": {
"description": "Request ID of the deal",
"example": "346892749827",
"type": "string"
},
"dealId": {
"description": "ID of the deal",
"example": "487598",
"type": "string"
},
"partyId": {
"description": "ID of the party",
"example": "P1293438",
"type": "string"
},
"groupId": {
"description": "ID of the group",
"example": "P1293438",
"type": "string"
},
"arrangementId": {
"description": "ID of Arrangement",
"example": "A3468238",
"type": "string"
},
"relationshipManager": {
"description": "Name of relationship manager",
"example": "XYZ",
"type": "string"
},
"purposeId": {
"description": "Purpose of the deal",
"example": "home loan",
"type": "string"
},
"usageId": {
"description": "Usage of the request",
"example": "01",
"type": "string"
},
"amount": {
"description": "Amount of the deal",
"example": 5000000,
"type": "integer",
"format": "decimal"
},
"currencyId": {
"description": "Currency of the deal",
"example": "INR",
"type": "string"
},
"profitCenter": {
"description": "Profit Center details",
"example": "Hyderabad",
"type": "string"
},
"branchId": {
"description": "Name of the branch for this deal",
"example": "HiTech City",
"type": "string"
},
"portfolioId": {
"description": "Portfolio number for this deal",
"example": "1989233",
"type": "string"
},
"requestStatus": {
"description": "Status of the deal",
"example": "Submitted",
"type": "string"
},
"requestDate": {
"description": "Date of request",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "last Modification made by user on Deals",
"example": "1001",
"type": "string"
},
"requestName": {
"description": "Name of a deal",
"example": "ABC Corp",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"activeProcessId": {
"description": "Active Process for Deal",
"example": "1",
"type": "string"
},
"withdrawalReasonType": {
"description": "Type of reason for withdrawal ",
"example": "02",
"type": "string"
},
"withdrawalReason": {
"description": "Reason for withdrawal",
"example": "Free text enterd by customer as reason ",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"canWithdraw": {
"description": "This flag is to maintain either true or false whether to withdraw application or not",
"example": true,
"type": "boolean"
},
"lastWithDrawnStage": {
"description": "last withdrawn stage id",
"example": "02",
"type": "string"
},
"extensionData": {
"type": "object"
},
"externalReferenceId": {
"description": "External Reference Id of Request",
"example": "346892749828",
"type": "string"
},
"ouId": {
"description": "The organization Unit Id",
"example": "1234",
"type": "string"
},
"sourceOfApplication": {
"description": "The channel application is sourced",
"example": "Internal - Origination",
"type": "string",
"x-referencetype": "ApplicationSource"
},
"facilitiesInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilitiesInfoResponse"
}
},
"approvedAmount": {
"description": "Approved Amount of Request",
"example": "30000.00",
"type": "string",
"format": "decimal"
}
}
},
"AllDealDetailsResponse": {
"properties": {
"allDealsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
}
}
},
"Liquidity": {
"properties": {
"currentRatio": {
"description": "Current ratio",
"example": "1234567.90",
"type": "string"
},
"quickRatio": {
"description": "quick ratio",
"example": "345678.90",
"type": "string"
}
}
},
"IncomeRatio": {
"properties": {
"debtToIncomeRatio": {
"description": "Debt to Income Ratio",
"example": "12345.98",
"type": "string"
}
}
},
"Leverage": {
"properties": {
"debtToEquity": {
"description": "Debt to equity",
"example": "12345.67",
"type": "string"
},
"debtToTotalAssets": {
"description": "Debt to Total Assets",
"example": "23456.98",
"type": "string"
},
"debtIntEarned": {
"description": "Debt interest earned",
"example": "12345.89",
"type": "string"
},
"fixedCoverageCharge": {
"description": "fixedCoverageCharge",
"example": "12345.89",
"type": "string"
},
"ebitda": {
"description": "ebitda",
"example": "1000000",
"type": "string"
},
"turnover": {
"description": "turnover ",
"example": "12345678.90",
"type": "string"
},
"equity": {
"description": "equity ",
"example": "1237.89",
"type": "string"
},
"dscr": {
"description": "dscr",
"example": "1234.78",
"type": "string"
}
}
},
"Profitability": {
"properties": {
"grossMargin": {
"description": "Gross Margin",
"example": "1234567.89",
"type": "string"
},
"operatingMargin": {
"description": "Operation Margin",
"example": "1234567.89",
"type": "string"
},
"netProfitMargin": {
"description": "Net Profit Margin",
"example": "12345.980",
"type": "string"
},
"roa": {
"description": "ROA",
"example": "100000000",
"type": "string"
},
"roe": {
"description": "ROE",
"example": "1000000",
"type": "string"
}
}
},
"Efficiency": {
"properties": {
"receivableTurnover": {
"description": "Receivable Turn Over",
"example": "1234.90",
"type": "string"
},
"daySaleOutstanding": {
"description": "Day sale outstanding",
"example": "100000000",
"type": "string"
},
"inventoryTurnover": {
"description": "Inventory turn over",
"example": "100000000000",
"type": "string"
},
"dayOfInventory": {
"description": "dayOf Inventory",
"example": "100000000",
"type": "string"
},
"accountPayableTurnover": {
"description": "account Payable Turnover",
"example": "1000000",
"type": "string"
},
"totalAssetTurnover": {
"description": "total Asset Turnover",
"example": "123456789000",
"type": "string"
}
}
},
"CreateFinancialResultRequest": {
"properties": {
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"incomeRatio": {
"allOf": [
{
"$ref": "#/components/schemas/IncomeRatio"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFinancialResultListRequest": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFinancialResultRequest"
}
}
}
},
"CreateFinancialResultResponse": {
"properties": {
"financialResultId": {
"description": "Specifies Id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"FinancialResultResponse": {
"properties": {
"financialResultId": {
"description": "Specifies id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"incomeRatio": {
"allOf": [
{
"$ref": "#/components/schemas/IncomeRatio"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Financial Result was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"FinancialResultsResponse": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialResultResponse"
}
}
}
},
"UpdateFinancialResultRequest": {
"properties": {
"financialResultId": {
"description": "Specifies id of the Financial Result",
"example": "FI8879879868",
"type": "string"
},
"partyId": {
"description": "Unique id of the Party",
"example": "P12345678",
"type": "string"
},
"year": {
"description": "Financial Year",
"example": "2021",
"type": "string"
},
"month": {
"description": "Financial Month",
"example": "04",
"type": "string",
"x-referencetype": "Month"
},
"dateAdded": {
"description": "Date when Financial Result is Added",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"liquidity": {
"allOf": [
{
"$ref": "#/components/schemas/Liquidity"
}
]
},
"leverage": {
"allOf": [
{
"$ref": "#/components/schemas/Leverage"
}
]
},
"incomeRatio": {
"allOf": [
{
"$ref": "#/components/schemas/IncomeRatio"
}
]
},
"profitability": {
"allOf": [
{
"$ref": "#/components/schemas/Profitability"
}
]
},
"efficiency": {
"allOf": [
{
"$ref": "#/components/schemas/Efficiency"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateFinancialResultListRequest": {
"properties": {
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFinancialResultRequest"
}
}
}
},
"NarrativesCreateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"collateralId": {
"description": "ID of the Collateral created for this deal",
"example": "C1234567",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesUpdateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "D20201234",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456789",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this deal",
"example": "F200722894",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"collateralId": {
"description": "ID of the Collateral created for this deal",
"example": "C12345678",
"type": "string"
},
"categoryId": {
"description": "ID of the category",
"example": "02",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesDocumentItem": {
"properties": {
"documentId": {
"description": "ID of the document uploaded in narrative",
"example": "D20201234",
"type": "string"
},
"documentName": {
"description": "Name of the document",
"example": "asset.txt",
"type": "string"
}
}
},
"ExternalServiceDocumentItem": {
"properties": {
"documentId": {
"description": "ID of the document uploaded in narrative",
"example": "D20201234",
"type": "string"
},
"documentName": {
"description": "Name of the document",
"example": "asset.txt",
"type": "string"
}
}
},
"ProcessedNarrativesResponse": {
"properties": {
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesResponse": {
"properties": {
"categoryId": {
"description": "ID of the category",
"example": "2",
"type": "string"
},
"narrative": {
"description": "Narrative added by a user",
"example": "The management team at ABC has been in place since its inception",
"type": "string"
},
"narrativeId": {
"description": "Unique identifier for Narrative",
"example": "N20201234",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "F123456",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F123456",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"collateralId": {
"description": "Unique identifier for Collateral",
"example": "N20201234",
"type": "string"
},
"partyId": {
"description": "Unique identifier for Party",
"example": "N20201234",
"type": "string"
},
"userId": {
"description": "ID of the user",
"example": "A123",
"type": "string"
},
"modifiedDate": {
"description": "Date on which the Narrative is modified",
"type": "string",
"format": "date"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativesResponses": {
"properties": {
"Narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
}
}
},
"NarrativesCreateRequests": {
"properties": {
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesCreateRequest"
}
}
}
},
"NarrativesUpdateRequests": {
"properties": {
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesUpdateRequest"
}
}
}
},
"EnrichmentResponseItem": {
"properties": {
"value": {
"description": "Value of the reference record",
"type": "string"
},
"description": {
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DecisionStatusResponseItem": {
"properties": {
"value": {
"description": "Decision Status Id",
"example": "01",
"type": "string"
},
"description": {
"description": "Decision Status Value",
"example": "Approve",
"type": "string"
},
"allowedDecisionType": {
"description": "Decision Status: Applicable category",
"example": "Individual,Committee",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralSubTypesItem": {
"properties": {
"collateralSubTypeId": {
"description": "Collateral Sub Type Id",
"example": "001",
"type": "string"
},
"collateralSubTypeValue": {
"description": "Collateral Sub Type Value",
"example": "Car",
"type": "string"
},
"t24ReferenceId": {
"description": "t24 Reference Id Collateral Sub Type",
"example": "200",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralTypesItem": {
"properties": {
"collateralTypeId": {
"description": "Collateral Type Id",
"example": "01",
"type": "string"
},
"collateralTypeValue": {
"description": "Collateral Type Value",
"example": "Vehicles",
"type": "string"
},
"collateralSubTypes": {
"description": "Collateral Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralSubTypesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"StageSignalTypesItems": {
"properties": {
"stage": {
"description": "Stage Value",
"example": "01",
"type": "string"
},
"signalName": {
"description": "Stage Name",
"example": "prescreeningSignal",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndustrialSubTypesItem": {
"properties": {
"industrialSubTypeId": {
"description": "industrial Sub Type Id",
"example": "001",
"type": "string"
},
"industrialSubTypeValue": {
"description": "Industrial Sub Type Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndustrialTypesItem": {
"properties": {
"industrialTypeId": {
"description": "Industrial Type Id",
"example": "01",
"type": "string"
},
"industrialTypeValue": {
"description": "Industrial Type Value",
"example": "Vehicles",
"type": "string"
},
"industrialSubTypes": {
"description": "Industrial Sub Types",
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialSubTypesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"FeeNamesItem": {
"properties": {
"feeNameId": {
"description": "Fee Name Id",
"example": "001",
"type": "string"
},
"feeNameValue": {
"description": "Fee Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypesItem": {
"properties": {
"feeTypesId": {
"description": "Fee Type Id",
"example": "01",
"type": "string"
},
"feeTypesValue": {
"description": "Fee Type Value",
"example": "Vehicles",
"type": "string"
},
"feeNames": {
"description": "Fee Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"StagesForLobItem": {
"properties": {
"stageId": {
"description": "stage id",
"example": "01",
"type": "string"
},
"stageValue": {
"description": "stage name",
"example": "Submitted",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RequestStagesLobItem": {
"properties": {
"lobValue": {
"description": "Line of business Id",
"example": "01",
"type": "string"
},
"description": {
"description": "lob description",
"example": "Corporate",
"type": "string"
},
"stages": {
"description": "stages for respective lob",
"type": "array",
"items": {
"$ref": "#/components/schemas/StagesForLobItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"FacilityStagesLobItem": {
"properties": {
"lobValue": {
"description": "Line of business Id",
"example": "01",
"type": "string"
},
"description": {
"description": "lob description",
"example": "Corporate",
"type": "string"
},
"purposeId": {
"description": "purposeId name",
"example": "01,02",
"type": "string"
},
"stages": {
"description": "stages for respective lob",
"type": "array",
"items": {
"$ref": "#/components/schemas/StagesForLobItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ConditionNamesItem": {
"properties": {
"conditionNameId": {
"description": "Condition Name Id",
"example": "001",
"type": "string"
},
"conditionNameValue": {
"description": "Condition Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ConditionTypesItem": {
"properties": {
"conditionTypesId": {
"description": "Condition Type Id",
"example": "01",
"type": "string"
},
"conditionTypesValue": {
"description": "Condition Type Value",
"example": "Vehicles",
"type": "string"
},
"conditionNames": {
"description": "Condition Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"CovenantNamesItem": {
"properties": {
"covenantNameId": {
"description": "Covenant Name Id",
"example": "001",
"type": "string"
},
"covenantNameValue": {
"description": "Covenant Name Value",
"example": "Car",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantTypesItem": {
"properties": {
"covenantTypesId": {
"description": "Covenant Type Id",
"example": "01",
"type": "string"
},
"covenantTypesValue": {
"description": "Covenant Type Value",
"example": "Vehicles",
"type": "string"
},
"covenantNames": {
"description": "Covenant Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceNamesItem": {
"properties": {
"complianceNameId": {
"description": "Compliance Name Id",
"example": "001",
"type": "string"
},
"complianceNameValue": {
"description": "Compliance Name Value",
"example": "Car",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceTypesItem": {
"properties": {
"complianceTypesId": {
"description": "Compliance Type Id",
"example": "01",
"type": "string"
},
"complianceTypesValue": {
"description": "Compliance Type Value",
"example": "Vehicles",
"type": "string"
},
"complianceNames": {
"description": "Compliance Names",
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceNamesItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"NarrativeCategoryItem": {
"properties": {
"type": {
"description": "Narrative Category Type",
"example": "financial",
"type": "string"
},
"value": {
"description": "Narrative Category Value",
"example": "01",
"type": "string"
},
"description": {
"description": "description of Narrative category",
"example": "financial",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RoleCategoryItem": {
"properties": {
"categoryId": {
"description": "Category Id",
"example": "01",
"type": "string"
},
"roles": {
"description": "Keycloak roles",
"example": "Relationship Manager,SME RM,Retail RM",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionTypesItem": {
"properties": {
"type": {
"description": "Policy Exception Type",
"example": "equity",
"type": "string"
},
"value": {
"description": "Policy Exception Value",
"example": "01",
"type": "string"
},
"description": {
"description": "description of Policy exception",
"example": "equity",
"type": "string"
},
"appliesTo": {
"description": "applies to which category",
"example": "Facility",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"StateInfo": {
"properties": {
"stateCode": {
"description": "code of the state",
"example": "AK",
"type": "string"
},
"stateName": {
"description": "State name",
"example": "Alaska",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CountryInfo": {
"properties": {
"countryCode": {
"description": "Code of the country",
"example": "US",
"type": "string"
},
"countryUniCode": {
"description": "Uni code of the country",
"example": "+840",
"type": "string"
},
"countryName": {
"description": "Name of the country",
"example": "United States",
"type": "string"
},
"countryPhoneCode": {
"description": "Phone code of the country",
"example": "+840",
"type": "string"
},
"states": {
"description": "List of states",
"type": "array",
"items": {
"$ref": "#/components/schemas/StateInfo"
}
},
"extensionData": {
"type": "object"
}
}
},
"TasksInfoItem": {
"properties": {
"taskId": {
"description": "Task Id",
"example": "01",
"type": "string"
},
"taskName": {
"description": "Task Name",
"example": "Borrower Info",
"type": "string"
},
"waive": {
"description": "Waive",
"example": "Required",
"type": "string"
},
"taskDescription": {
"description": "Task Description",
"example": "Borrower Info",
"type": "string"
},
"taskType": {
"description": "Task Type",
"example": "Manual",
"type": "string"
},
"defaultUserId": {
"description": "Default User Id",
"example": "1001",
"type": "string"
},
"ruleId": {
"description": "rule Id",
"example": "01",
"type": "string"
},
"taskPackage": {
"description": "task Package",
"example": "Fraud-check",
"type": "string"
},
"taskProvider": {
"description": "task Provider",
"example": "Borrower",
"type": "string"
},
"noOfDays": {
"description": "Task Lifetime for no of days",
"example": "5",
"type": "string"
},
"defaultUserEmail": {
"description": "Default User Email",
"example": "temenostestmail@gmail.com",
"type": "string"
},
"partyIndicator": {
"description": "Party Indicator",
"example": "00",
"type": "string"
},
"overview": {
"description": "overview screen",
"example": "Entity Overview",
"type": "string"
},
"section": {
"description": "Section Screen",
"example": "Documents",
"type": "string"
},
"processDefId": {
"description": "Id of process initiated by PAM",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"TasksCheckListItem": {
"properties": {
"taskCheckListId": {
"description": "Task Check List Id",
"example": "01",
"type": "string"
},
"taskCheckListName": {
"description": "Task Check List Name",
"example": "Fraud check",
"type": "string"
},
"tasksInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksInfoItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"TasksParamsItem": {
"properties": {
"taskStage": {
"description": "Task Stage",
"example": "Onboarding",
"type": "string"
},
"tasksCheckList": {
"description": "Task CheckList",
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"lastChangeUserId": {
"description": "Last Change User Id",
"example": "1001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"WorkflowtasksCheckListItem": {
"properties": {
"taskType": {
"description": "Task Type",
"example": "Retrigger",
"type": "string"
},
"serviceName": {
"description": "Name of the service to be invoked",
"example": "OriginationJavaServices",
"type": "string"
},
"operationName": {
"description": "Name of the operation in the service",
"example": "GetBlacklistResult",
"type": "string"
},
"taskId": {
"description": "Id for the Task",
"example": "T003",
"type": "string"
},
"provider": {
"description": "Provider for the Task",
"example": "Blacklist",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityPurposeItem": {
"properties": {
"purposeId": {
"description": "ID for facility purpose",
"example": "01",
"type": "string"
},
"value": {
"description": "Facility type",
"example": "New Facility",
"type": "string"
},
"description": {
"description": "Purpose of the Facility",
"example": "New Loan Creation",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ReferenceDataItems": {
"properties": {
"queueNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentAppliesToCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentCategoryList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentTypeList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"documentStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"limitType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"relatedPartyRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"historyTables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"dealStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"lineOfBusiness": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"covenantFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"operator": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"interestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"month": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"restrictionType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"restrictionStartDate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"payType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"addressType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DecisionStatusResponseItem"
}
},
"complianceType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"currency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"noOfEmployees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"portfolio": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"profitCenter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPriority": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"salutation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"partyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"conditionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"fundingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingInterestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeBalanceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"basisTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collectionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskPackage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingIndex": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"complianceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityUsage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"policyExceptionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"pricingStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"productReferenceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"branchReferenceData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"jobTitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskProvider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"taskCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"acceptanceStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"companyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"contactTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"feeFrequencyTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"riskRatingTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"beneficialOwnerDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rateTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"provider": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"providerType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"repricingFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"paymentFrequency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralTypesItem"
}
},
"stageSignalTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageSignalTypesItems"
}
},
"industryTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrialTypesItem"
}
},
"conditionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionTypesItem"
}
},
"covenantTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantTypesItem"
}
},
"complianceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceTypesItem"
}
},
"narrativeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativeCategoryItem"
}
},
"policyExceptionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionTypesItem"
}
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryInfo"
}
},
"feeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeTypesItem"
}
},
"requestStagesLob": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestStagesLobItem"
}
},
"facilityStagesLob": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityStagesLobItem"
}
},
"UITasksCheckList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksCheckListItem"
}
},
"withdrawalReasonType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralPropertyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralPropertyStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralOccupancy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralRequiredCoverage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralTypeDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralStatusDueDiligence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"approvalStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"committeeRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"collateralStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rateChangeMethod": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"capBasis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"floorBasis": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"repaymentScheduleType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"installmentType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"roundingRule": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rounding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"interestSpreadType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"roleCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleCategoryItem"
}
},
"collateralSource": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"workflowTasksCheckList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowtasksCheckListItem"
}
},
"instructionType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"amendmentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"amendRequestTypeStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"amendRequestType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"facilityPurpose": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityPurposeItem"
}
},
"bankType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgagePropertyType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgagePropertySubType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"furnishedType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgagePropertyStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"propertyUsage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"productType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"drawingType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgageType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"mortgageNotaryStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"disbursementType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"repaymentPayType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"remortgageReason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"additionalLoanAmountPurpose": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
},
"rejectedReason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnrichmentResponseItem"
}
}
}
},
"BasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"partyType": {
"description": "type of the party",
"example": "Individual",
"type": "string"
},
"legalName": {
"description": "legalName of the Customer",
"example": "ABC Company",
"type": "string"
},
"registrationNumber": {
"description": "registration number of the Customer",
"example": "ABC Company",
"type": "string"
},
"companyType": {
"description": "company type",
"example": "Community Interest Company (CIC)",
"type": "string",
"x-referencetype": "CompanyType"
},
"industryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"subIndustryType": {
"description": "industry type",
"example": "Telecom",
"type": "string"
},
"registrationDate": {
"description": "date of registration",
"example": "Telecom",
"type": "string"
},
"yearsInBusiness": {
"description": "years in business",
"example": "5",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedAnnualRevenue": {
"description": "estimated annual revenue",
"example": "10000000",
"type": "string"
},
"noOfEmployees": {
"description": "no of employees",
"example": "01",
"type": "string"
},
"websiteAddress": {
"description": "websire address",
"example": "www.abc.com",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"companyOverview": {
"description": "company overview",
"example": "Telecom company",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"jobTitle": {
"description": "jobTitle of the person",
"example": "MD",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phnNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddr": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PartyInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "12345",
"type": "string"
},
"partyName": {
"description": "Name of the party",
"example": "ABC corporation",
"type": "string"
},
"partyType": {
"description": "Type of the party",
"example": "Individual",
"type": "string"
}
}
},
"GroupInfo": {
"properties": {
"groupId": {
"description": "unique identifier of the group",
"example": "1234567",
"type": "string"
},
"groupName": {
"description": "Name of the Group",
"example": "ABC Group",
"type": "string"
},
"groupType": {
"description": "Type of the Group",
"example": "Borrowing",
"type": "string"
},
"overView": {
"description": "Overview of the Group",
"type": "string"
},
"partyInfoList": {
"description": "party infor of particular group",
"type": "array",
"items": {
"$ref": "#/components/schemas/PartyInfo"
}
},
"phoneNumber": {
"description": "phone number",
"example": "9999999999",
"type": "string"
},
"phoneCode": {
"description": "phone code",
"example": "+91",
"type": "string"
},
"emailAddress": {
"description": "email address",
"example": "abc@gmail.com",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IndividualBasicInfo": {
"properties": {
"partyId": {
"description": "unique identifier of the party",
"example": "2",
"type": "string"
},
"title": {
"description": "title of the person",
"example": "Mr",
"type": "string"
},
"firstName": {
"description": "firstName of the person",
"example": "Ram",
"type": "string"
},
"middleName": {
"description": "middleName of the person",
"example": "Chandra",
"type": "string"
},
"lastName": {
"description": "lastName of the person",
"example": "Prasad",
"type": "string"
},
"dateOfBirth": {
"description": "dob of the person",
"example": "1978-06-03",
"type": "string"
},
"identificationNumber": {
"description": "id proof of the person",
"example": "9876095404361276",
"type": "string"
},
"country": {
"description": "country",
"example": "US",
"type": "string"
},
"addressLine1": {
"description": "address line 1",
"example": "abc building",
"type": "string"
},
"addressLine2": {
"description": "address line 2",
"example": "def road",
"type": "string"
},
"state": {
"description": "state",
"example": "south carolina",
"type": "string"
},
"city": {
"description": "city",
"example": "charlotte",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "600023",
"type": "string"
},
"code": {
"description": "phone code",
"example": "11",
"type": "string"
},
"phoneNumber": {
"description": "phoneNumber of the person",
"example": "9876543210",
"type": "string"
},
"emailAddress": {
"description": "emailAddress of the person",
"example": "ram@gmail.com",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityInfo": {
"properties": {
"facilityId": {
"description": "unique identifier of the facility",
"example": "F20201234567",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P20201234567",
"type": "string"
},
"groupId": {
"description": "unique identifier of the group",
"example": "P20201234567",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "facility123",
"type": "string"
},
"purpose": {
"description": "purpose of the facility",
"example": "01",
"type": "string"
},
"usageId": {
"description": "usage id of the facility",
"example": "01",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "line of credit",
"type": "string"
},
"currency": {
"description": "Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amount": {
"description": "amount of the facility",
"example": "10000000",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ModifiedFacilityInfo": {
"properties": {
"facilityId": {
"description": "unique identifier of the facility",
"example": "M20211234567_02",
"type": "string"
},
"previousFacilityId": {
"description": "unique identifier of the facility",
"example": "F20201234567,M20211234567_01",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P20201234567",
"type": "string"
},
"facilityName": {
"description": "name of the facility",
"example": "facility123",
"type": "string"
},
"purpose": {
"description": "purpose of the facility",
"example": "01",
"type": "string"
},
"usageId": {
"description": "usage id of the facility",
"example": "01",
"type": "string"
},
"type": {
"description": "type of the facility",
"example": "line of credit",
"type": "string"
},
"currency": {
"description": "Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"amendmentTypes": {
"description": "amendmentTypes of the facility",
"example": "01,02,04",
"type": "string"
},
"maturityDate": {
"description": "maturity date of the facility",
"example": "2020-06-03",
"type": "string"
},
"previousMaturityDate": {
"description": "previous Maturity Date of the facility",
"example": "2020-06-03",
"type": "string"
},
"loanAmount": {
"description": "Loan Amount of the facility",
"example": "10000000",
"type": "string"
},
"previousLoanAmount": {
"description": "Previous Loan Amount of the facility",
"example": "600000",
"type": "string"
},
"commencementDate": {
"description": "commencement date of the facility",
"example": "2020-06-03",
"type": "string"
},
"paidAmount": {
"description": "paid amount of the facility",
"example": "50000",
"type": "string"
},
"arrangementNo": {
"description": "arrangement number of the facility",
"example": "123456789",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RelatedPartyInfo": {
"properties": {
"id": {
"description": "unique identifier",
"example": "12345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"groupId": {
"description": "unique identifier of the group",
"example": "P20201234567",
"type": "string"
},
"relatedGroupId": {
"description": "unique identifier of the related group",
"example": "P20201234567",
"type": "string"
},
"relatedPartyId": {
"description": "unique identifier of the related party",
"example": "P20201234567",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"partyName": {
"description": "name of the party",
"example": "abc",
"type": "string"
},
"relatedPartyName": {
"description": "name of the related party",
"example": "party1",
"type": "string"
},
"relatedGroupName": {
"description": "name of the relatedGroup",
"example": "group1",
"type": "string"
},
"relatedPartyType": {
"description": "type of the relatedparty",
"example": "abc",
"type": "string"
},
"role": {
"description": "role",
"example": "01",
"type": "string",
"x-referencetype": "RelatedPartyRole"
},
"limitType": {
"description": "amount or percentage of limit",
"example": "percentage",
"type": "string"
},
"limitCurrency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"limitValue": {
"description": "value",
"example": "10000000",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"CollateralInfo": {
"properties": {
"collateralId": {
"description": "unique identifier of the collateral",
"example": "C202012345678",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"name": {
"description": "name of the collateral",
"example": "building",
"type": "string"
},
"type": {
"description": "type of the collateral",
"example": "01",
"type": "string"
},
"subType": {
"description": "subtype of the collateral",
"example": "001",
"type": "string"
},
"owner": {
"description": "owner of the collateral",
"example": "self",
"type": "string"
},
"country": {
"description": "country of the collateral",
"example": "US",
"type": "string"
},
"currency": {
"description": "currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"estimatedValue": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
},
"collateralStatus": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string",
"x-referencetype": "CollateralStatus"
},
"collateralSource": {
"description": "source of the collateral",
"example": "01",
"type": "string",
"x-referencetype": "CollateralSource"
},
"externalReferenceId": {
"description": "estimated value of the collateral",
"example": "1000000",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"DocumentInfo": {
"properties": {
"documentId": {
"description": "Id of the document",
"example": "123456",
"type": "string"
},
"partyId": {
"description": "unique identifier of the party",
"example": "P202012345678",
"type": "string"
},
"facilityId": {
"description": "unique identifier of the Facility",
"example": "T202012345678",
"type": "string"
},
"collateralId": {
"description": "unique identifier of the Collateral",
"example": "T202012345678",
"type": "string"
},
"requestId": {
"description": "unique identifier of the request",
"example": "T202012345",
"type": "string"
},
"documentName": {
"description": "name of the document",
"example": "agreement",
"type": "string"
},
"documentType": {
"description": "type of the document",
"example": "02",
"type": "string"
},
"fileName": {
"description": "The name of the File",
"example": "XYZ",
"type": "string"
},
"uploadOn": {
"description": "date of upload",
"example": "2020-06-03",
"type": "string"
},
"category": {
"description": "category",
"example": "",
"type": "string"
},
"appliesTo": {
"description": "appliesTo",
"example": "01",
"type": "string"
},
"expiryDate": {
"description": "date of expiry",
"example": "2020-06-03",
"type": "string"
},
"isReusable": {
"description": "document is reuse or not",
"example": "true",
"type": "string"
},
"appEvidenceId": {
"description": "application Evidence Id",
"example": "1234556",
"type": "string"
},
"fileSize": {
"description": "fileSize of the document",
"example": "2000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerRequestInfo": {
"properties": {
"requestId": {
"description": "Id of the request",
"example": "654564",
"type": "string"
},
"userId": {
"description": "id of the user who created the request",
"example": "87654",
"type": "string"
},
"usageId": {
"description": "id of the usage who created the request",
"example": "U123",
"type": "string"
},
"currency": {
"description": "currency",
"example": "INR",
"type": "string",
"x-referencetype": "Currency"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"status": {
"description": "current step of submission process",
"example": "Draft",
"type": "string"
},
"screenFlag": {
"description": "Specifies screen of the request",
"example": "Facility",
"type": "string"
},
"requestType": {
"description": "Specifies request type",
"example": "delete",
"type": "string"
},
"summary": {
"description": "summary of the request being raised",
"example": "test summary",
"type": "string"
},
"requestDate": {
"description": "Date of the request being raised",
"example": "2020-06-03",
"type": "string"
},
"purposeTypes": {
"description": "Purpose types of the request being raised",
"example": "01,02",
"type": "string"
},
"customerInformation": {
"allOf": [
{
"$ref": "#/components/schemas/BasicInfo"
}
]
},
"groupInformation": {
"allOf": [
{
"$ref": "#/components/schemas/GroupInfo"
}
]
},
"facilityItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityInfo"
}
},
"modifiedFacilityItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModifiedFacilityInfo"
}
},
"relatedPartyItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyInfo"
}
},
"newRelatedPartyIndividualItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndividualBasicInfo"
}
},
"newRelatedPartyBusinessItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicInfo"
}
},
"collateralItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralInfo"
}
},
"documentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentInfo"
}
},
"extensionData": {
"type": "object"
}
}
},
"CustomerRequestsInfo": {
"properties": {
"customerRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerRequestInfo"
}
}
}
},
"CreateCustomerProcessedResponse": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "TEMP-12345678",
"type": "string"
},
"customerPartyId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"customerGroupId": {
"description": "Specifies id of the customer",
"example": "T12345678",
"type": "string"
},
"facilityId": {
"description": "unique id of the facility",
"example": "F202012345678",
"type": "string"
},
"Ids": {
"description": "unique id of the relatedParties",
"example": "P202012345678",
"type": "string"
},
"individualPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"businessPartyIds": {
"description": "unique id of the parties",
"example": "P202012345678",
"type": "string"
},
"collateralIds": {
"description": "unique id of the collaterals",
"example": "C202012345678",
"type": "string"
},
"documentIds": {
"description": "unique id of the documents",
"example": "D202012345678",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"InFlightFacilitiesInfo": {
"properties": {
"facilityId": {
"description": "Specifies id of the inflight facilityId",
"example": "F20201234567,M20211234567_01",
"type": "string"
},
"requestId": {
"description": "Id of the request",
"example": "654564",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"InFlightFacilityResponse": {
"properties": {
"inFlightFacilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InFlightFacilitiesInfo"
}
}
}
},
"DrawRestrictionsRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"restrictionType": {
"description": "Restriction Type",
"example": "01",
"type": "string",
"x-referencetype": "RestrictionType"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"currencyId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyIdsArray"
}
},
"startsFrom": {
"description": "from which date the restriction starts",
"example": "01",
"type": "string",
"x-referencetype": "RestrictionStartDate"
},
"startDate": {
"description": "Date when the restriction will be applicable",
"example": "01/01/2021",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012586",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDrawRestrictionsResponse": {
"properties": {
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "P123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of User",
"example": "1234567890",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"drawRestrictionId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10012566",
"type": "string"
},
"restrictionType": {
"description": "Restriction Type",
"example": "Maximum Limit amount",
"type": "string"
},
"restrictionValue": {
"description": "Restriction Value",
"example": "500K",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"currencyId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyIdsArray"
}
},
"startsFrom": {
"description": "from which date the restriction starts",
"example": "01",
"type": "string"
},
"startDate": {
"description": "Date when the restriction will be applicable",
"example": "01/01/2021",
"type": "string"
},
"year": {
"description": "year",
"example": "02",
"type": "string"
},
"month": {
"description": "month",
"example": "06",
"type": "string"
},
"days": {
"description": "days",
"example": "20",
"type": "string"
},
"lastChangeUserId": {
"description": "User Id of Last change made on restriction",
"example": "1001",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the restriction was last changed",
"type": "string",
"format": "date"
},
"comment": {
"description": "Comments Made by User",
"example": "Maximum limit Amount",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"DrawRestrictionsRequests": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionsRequest"
}
}
}
},
"DrawRestrictionResponses": {
"properties": {
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
}
}
},
"ComplianceRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "R2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateComplianceRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "COMP123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceType"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "01",
"type": "string",
"x-referencetype": "ComplianceStatus"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceRequest"
}
}
}
},
"UpdateComplianceRequests": {
"properties": {
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateComplianceRequest"
}
}
}
},
"ComplianceResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Request",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P2020123456",
"type": "string"
},
"collateralId": {
"description": "Unique Identifier of Collateral",
"example": "C2020123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"userId": {
"description": "Unique Identifier of user",
"example": "123456789",
"type": "string"
},
"complianceId": {
"description": "Unique Identifier of Compliance",
"example": "123456789",
"type": "string"
},
"complianceTypeId": {
"description": "Unique Identifier of a complianceType",
"example": "123456789",
"type": "string"
},
"complianceName": {
"description": "name of a compliance",
"example": "Aadhar card",
"type": "string"
},
"comment": {
"description": "compliance comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a compliance",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ComplianceResponses": {
"properties": {
"Compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
}
}
},
"PolicyExceptionResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "P3456789",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"policyExceptionId": {
"description": "Unique Identifier of PolicyException",
"example": "123456789",
"type": "string"
},
"exceptionType": {
"description": "Type of Exception",
"type": "string"
},
"description": {
"description": "description of the exception",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"type": "string"
},
"comment": {
"description": "policyException comment",
"example": "abcd",
"type": "string"
},
"status": {
"description": "status of a policyException",
"example": "Approved",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last chaged the compliance",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the complaince was last changed",
"type": "string",
"format": "date"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionResponses": {
"properties": {
"policyExceptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionResponse"
}
}
}
},
"ProcessedComplianceResponse": {
"properties": {
"RequestId": {
"description": "Unique identifier for Deal",
"example": "200722894",
"type": "string"
},
"facilityId": {
"description": "Unique identifier for Facility",
"example": "200722894",
"type": "string"
},
"complianceId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedConditionResponse": {
"properties": {
"conditionId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"ProcessedDecisionResponse": {
"properties": {
"creditDecisionId": {
"description": "Unique identifier for Compliance",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"ProcessedPolicyResponse": {
"properties": {
"policyExceptionId": {
"description": "Unique identifier for PolicyExceptions",
"example": "PE123456",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"AddressDetails": {
"properties": {
"addressLine1": {
"description": "address Line1",
"example": "1-2-33/4/5, Baker Street",
"type": "string"
},
"addressLine2": {
"description": "address Line2",
"example": "Opp. White House",
"type": "string"
},
"city": {
"description": "city",
"example": "Los Angeles",
"type": "string"
},
"countryId": {
"description": "country id",
"example": "0",
"type": "string"
},
"state": {
"description": "state",
"example": "ca",
"type": "string"
},
"zipCode": {
"description": "zip code",
"example": "10011",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsCreateRequest": {
"properties": {
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disbursement Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disbursementPercentage": {
"description": "The disbursement percentage",
"example": "10",
"type": "string"
},
"disbursementDate": {
"description": "The date of the disbursement",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"payeeName": {
"description": "Name of the Payee",
"example": "Antony",
"type": "string"
},
"accountNumber": {
"description": "Account Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"bankName": {
"description": "Name of the Payee",
"example": "ABC bank",
"type": "string"
},
"swiftCode": {
"description": "Swift code",
"example": "SW9384",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"addressRefrence": {
"description": "Reference of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"disbursementType": {
"description": "Type of disbursement",
"example": "Full Disbursement",
"type": "string",
"x-referencetype": "DisbursementType"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsUpdateRequest": {
"properties": {
"fundingId": {
"description": "ID of the funding created for this Request",
"example": "F200722894",
"type": "string"
},
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"disbursementPercentage": {
"description": "The disbursement percentage",
"example": "10",
"type": "string"
},
"disbursementDate": {
"description": "The date of the disbursement",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string",
"x-referencetype": "PayType"
},
"payeeName": {
"description": "Name of the Payee",
"example": "Antony",
"type": "string"
},
"accountNumber": {
"description": "Account Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"bankName": {
"description": "Name of the Payee",
"example": "ABC bank",
"type": "string"
},
"swiftCode": {
"description": "Swift code",
"example": "SW9384",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"addressRefrence": {
"description": "Reference of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"disbursementType": {
"description": "Type of disbursement",
"example": "Full Disbursement",
"type": "string",
"x-referencetype": "DisbursementType"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedFundingDetailsResponse": {
"properties": {
"fundingId": {
"type": "string",
"description": "Specifies the ID of the funding",
"example": "F123"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"FundingDetailsResponse": {
"properties": {
"fundingId": {
"description": "ID of the funding created for this Request",
"example": "F200722894",
"type": "string"
},
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Id of the drawing created for a Facility",
"example": "F202012345678-01",
"type": "string"
},
"authorizedUserId": {
"description": "ID of the authorisedUser",
"example": "2",
"type": "string"
},
"fundingDate": {
"description": "The date of the funding",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"fundingTime": {
"description": "Time of the funding",
"example": "2 years",
"type": "string"
},
"grossAmount": {
"description": "The gross Amount",
"example": "50000",
"type": "string"
},
"grossCurrency": {
"description": "The currency of the gross Amount",
"example": "USD",
"type": "string"
},
"holdbackAmount": {
"description": "The held back money",
"example": "10000",
"type": "string"
},
"holdbackCurrency": {
"description": "The Currency of the held back money",
"example": "USD",
"type": "string"
},
"disburseAmount": {
"description": "The amount of the disburse",
"example": "10000",
"type": "string"
},
"disburseCurrency": {
"description": "Currency Of the Disburse",
"example": "USD",
"type": "string"
},
"disbursementPercentage": {
"description": "The disbursement percentage",
"example": "10",
"type": "string"
},
"disbursementDate": {
"description": "The date of the disbursement",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"payType": {
"description": "How the payment was to be done",
"example": "01",
"type": "string"
},
"payeeName": {
"description": "Name of the Payee",
"example": "Antony",
"type": "string"
},
"accountNumber": {
"description": "Account Number of the user",
"example": "ABCD123",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A1",
"type": "string"
},
"bankName": {
"description": "Name of the payee",
"example": "ABC bank",
"type": "string"
},
"swiftCode": {
"description": "Swift code",
"example": "SW9384",
"type": "string"
},
"fundingAcctStatus": {
"description": "Status of the funding Account",
"example": "Approved",
"type": "string"
},
"addressRefrence": {
"description": "Reference of address",
"example": "A123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeUserid": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date and Time of the lastchange",
"example": "2020-09-05 10:08 08 800",
"type": "string",
"format": "date"
},
"addressDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AddressDetails"
}
]
},
"thirdPartyPayee": {
"description": "thirdPartyPayee",
"example": true,
"type": "boolean"
},
"disbursementType": {
"description": "Type of disbursement",
"example": "Full Disbursement",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FundingDetailsResponses": {
"properties": {
"Funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
}
}
},
"LimitThings": {
"properties": {
"unadvisedLimit": {
"description": "Limit that unadvised",
"example": "$10000",
"type": "string"
},
"advisedLimit": {
"description": "Limit that advised",
"example": "$5000",
"type": "string"
},
"utilisedLimit": {
"description": "Already used limit",
"example": "$5000",
"type": "string"
},
"availableLimit": {
"description": "Limit that available",
"example": "$5000",
"type": "string"
},
"requestedAmount": {
"description": "Amount that requested",
"example": "$10000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"LimitsRequest": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": "Specifies the outstanding debt",
"example": "$5000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"LimitsResponse": {
"properties": {
"limitId": {
"description": "Specifies id of the Limit",
"example": "L12345678",
"type": "string"
},
"dealId": {
"description": "Specifies id of the deal",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "P202035269718",
"type": "string"
},
"obligation": {
"description": " Specifies the outstanding debt",
"example": "$50000",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"changedLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"newLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"previousLimits": {
"allOf": [
{
"$ref": "#/components/schemas/LimitThings"
}
]
},
"userId": {
"description": "Specifies id of the user",
"example": "U123456",
"type": "string"
},
"modifiedDate": {
"description": "The date modify the Limit",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Limit",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedLimitResponse": {
"properties": {
"limitId": {
"description": "Unique Identifier of Draw Restriction",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
}
}
},
"FeeTypeOnGoing": {
"properties": {
"balanceType": {
"description": "DD field,Visible only If Percentage is selected in Percentage/Amount",
"example": "01",
"type": "string",
"x-referencetype": "FeeBalanceTypes"
},
"frequency": {
"description": "Fee Frequency",
"example": "05",
"type": "string",
"x-referencetype": "FeeFrequencyTypes"
},
"rateBasis": {
"description": "DD field, Visible only If Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"rateType": {
"description": "Default to Fixed, Visible only if Percentage is selected in Percentage/Amount",
"example": "fixed",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypeEvent": {
"properties": {
"feeBasis": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "Visible only if Percentage is selected in Percentage/Amount",
"example": "48",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeTypeClosing": {
"properties": {
"feeBasis": {
"description": "feeBasisId",
"example": "12345678",
"type": "string"
},
"percentage": {
"description": "percentage",
"example": "48",
"type": "string"
},
"collection": {
"description": "DD field, collection",
"example": "12345678",
"type": "string"
},
"status": {
"description": "DD field, status",
"example": "01",
"type": "string",
"x-referencetype": "FeeStatus"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFeeRequest": {
"properties": {
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateFeeRequest": {
"properties": {
"feeId": {
"description": "unique id of the fee",
"example": "FEE202035269718",
"type": "string"
},
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string",
"x-referencetype": "FeeType"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FeeResponse": {
"properties": {
"feeId": {
"description": "Specifies id of the fees",
"example": "12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the request",
"example": "D202035269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202012345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"feeName": {
"description": "Specifies name of the fee",
"example": "maintainance",
"type": "string"
},
"feeType": {
"description": "fee Type",
"example": "01",
"type": "string"
},
"amtOrPercent": {
"description": "amount or percentage",
"example": "amount",
"type": "string"
},
"currency": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "USD",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"amount": {
"description": "Visible only if amount is selected in Percentage/Amount",
"example": "100000000",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"feeTypeOnGoing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeOnGoing"
}
]
},
"feeTypeEvent": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeEvent"
}
]
},
"feeTypeClosing": {
"allOf": [
{
"$ref": "#/components/schemas/FeeTypeClosing"
}
]
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFeeRequest"
}
}
}
},
"UpdateFeesRequest": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateFeeRequest"
}
}
}
},
"FeesResponse": {
"properties": {
"feesItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
}
}
},
"ProcessedFeesResponse": {
"properties": {
"feesId": {
"description": "Unique identifier for fees",
"example": "FEE202035292905",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"StandardSuccessResponse": {
"properties": {
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details",
"type": "string"
}
}
},
"Structure": {
"properties": {
"years": {
"description": "Number of Years",
"example": "2",
"type": "string"
},
"months": {
"description": "Number of Months",
"example": "12",
"type": "string"
},
"days": {
"description": "Number of Days",
"example": "31",
"type": "string"
},
"indexType": {
"description": "The index type",
"example": "01",
"type": "string",
"x-referencetype": "PricingIndex"
},
"rateBasisId": {
"description": "The rate basis Id",
"example": "01",
"type": "string",
"x-referencetype": "RateTypes"
},
"paymentFrequency": {
"description": "The Payment Frequency",
"example": "01",
"type": "string",
"x-referencetype": "PaymentFrequency"
},
"rateChangeMethod": {
"description": "The Rate Change Method",
"example": "01",
"type": "string",
"x-referencetype": "RateChangeMethod"
},
"repricingFrequency": {
"description": "The Repricing Frequency",
"example": "01",
"type": "string",
"x-referencetype": "RepricingFrequency"
},
"baseRate": {
"description": "The base rate percentage",
"example": "20",
"type": "string"
},
"indicativeBaseRate": {
"description": "The Indicative Base Rate percentage",
"example": "35",
"type": "string"
},
"freezePeriod": {
"description": "The number of days to freeze",
"example": "31",
"type": "string"
},
"rateLockDate": {
"description": "The rate lock date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"interestSpread": {
"description": "The interest Spread percentage",
"example": "15",
"type": "string"
},
"interestSpreadType": {
"description": "The interest Spread type",
"example": "01",
"type": "string",
"x-referencetype": "InterestSpreadType"
},
"rateLockExpiryDate": {
"description": "The Rate Lock Expiry Date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"borrowerRate": {
"description": "The borrowerRate percentage",
"example": "10",
"type": "string"
},
"indicativeBorrowerRate": {
"description": "The indicative Borrower Rate percentage",
"example": "25",
"type": "string"
},
"aprRate": {
"description": "The apr Rate percentage",
"example": "10",
"type": "string"
},
"interestCapBasis": {
"description": "The Cap Basis",
"example": "01",
"type": "string",
"x-referencetype": "CapBasis"
},
"interestCap": {
"description": "The Cap percentage",
"example": "12",
"type": "string"
},
"interestFloorBasis": {
"description": "The Floor Basis",
"example": "01",
"type": "string",
"x-referencetype": "FloorBasis"
},
"interestFloor": {
"description": "The Floor Basis percentage",
"example": "20",
"type": "string"
}
}
},
"Schedule": {
"properties": {
"installmentType": {
"description": "The installment type",
"example": "01",
"type": "string",
"x-referencetype": "InstallmentType"
},
"repaymentType": {
"description": "The repayment type",
"example": "Revolving",
"type": "string"
},
"repaymentScheduleType": {
"description": "The repayment Schedule type",
"example": "01",
"type": "string",
"x-referencetype": "RepaymentScheduleType"
},
"firstInstallmentDate": {
"description": "The first Installment Date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"reoccurringInstallmentDate": {
"description": "The reoccurring Installment Date",
"example": "21",
"type": "string"
},
"rounding": {
"description": "The rounding",
"example": "01",
"type": "string",
"x-referencetype": "Rounding"
},
"roundingRule": {
"description": "The rounding Rule",
"example": "01",
"type": "string",
"x-referencetype": "RoundingRule"
},
"installmentCurrency": {
"description": "The installment Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"installmentAmount": {
"description": "The installmentAmount",
"example": "10000",
"type": "string"
},
"repaymentScheduleDocumentId": {
"description": "The repayment Schedule DocumentId",
"example": "d723-232-28de",
"type": "string"
},
"repaymentScheduleDocumentName": {
"description": "The repayment Schedule Document Name",
"example": "abc.pdf",
"type": "string"
},
"balloonCurrency": {
"description": "The balloon Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"balloonAmount": {
"description": "The balloon Amount",
"example": "100000",
"type": "string"
},
"minimumPaymentCurrency": {
"description": "The minimumPaymentCurrency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"minimumPaymentAmount": {
"description": "The minimum Payment Amount",
"example": "10000",
"type": "string"
},
"minimumPaymentPercentage": {
"description": "The minimum Payment Percentage",
"example": "40",
"type": "string"
}
}
},
"PricingComment": {
"properties": {
"commentText": {
"description": "The comment Text",
"example": "add pricing",
"type": "string"
},
"commentUser": {
"description": "The comment User",
"example": "bfleck",
"type": "string"
},
"commentDate": {
"description": "The comment date",
"example": "2020-06-03",
"type": "string",
"format": "date"
}
}
},
"currencyIdsArray": {
"properties": {
"currency": {
"description": "The restricted currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
}
}
},
"ExternalRefDetails": {
"properties": {
"type": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"id": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
}
}
},
"FeaturesDetails": {
"properties": {
"type": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"id": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
},
"name": {
"description": "The external ref type",
"example": "Oppertunity ID",
"type": "string"
},
"value": {
"description": "The external ref Id",
"example": "12345",
"type": "string"
},
"description": {
"description": "The external ref description",
"example": "Yes, I like to order a cheque book",
"type": "string"
}
}
},
"PricingRequest": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the deal",
"example": "R202135269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202112345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"pricingType": {
"description": "The type of interest",
"example": "01",
"type": "string",
"x-referencetype": "InterestType"
},
"product": {
"description": "The type of product",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"structure": {
"allOf": [
{
"$ref": "#/components/schemas/Structure"
}
]
},
"schedule": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
},
"pricingComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingComment"
}
},
"status": {
"description": "The status",
"example": "01",
"type": "string",
"x-referencetype": "PricingStatus"
},
"lastChangeUserId": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PricingResponse": {
"properties": {
"pricingId": {
"description": "Specifies id of the pricingId",
"example": "P12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the deal",
"example": "R202135269718",
"type": "string"
},
"facilityId": {
"description": "Specifies id of the facility",
"example": "F202112345678",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"pricingType": {
"description": "The type of interest",
"example": "01",
"type": "string"
},
"product": {
"description": "The type of product",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"structure": {
"allOf": [
{
"$ref": "#/components/schemas/Structure"
}
]
},
"schedule": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
},
"pricingComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingComment"
}
},
"status": {
"description": "The status",
"example": "01",
"type": "string"
},
"lastChangeUserId": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp modify the Pricing",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"AccountRequest": {
"properties": {
"requestId": {
"description": "Specifies id of the Request",
"example": "R202135269718",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "12345678",
"type": "string"
},
"bankName": {
"description": "Specifies name of the bank",
"example": "Euro banck",
"type": "string"
},
"branchName": {
"description": "The branch name of the banck",
"example": "European",
"type": "string"
},
"accountNumber": {
"description": "The account number",
"example": "12356789",
"type": "string"
},
"accountType": {
"description": "The type of the account",
"example": "Savings",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"AccountUpdateRequest": {
"properties": {
"accountId": {
"description": "Specifies id of the Accounts",
"example": "AC12345",
"type": "string"
},
"requestId": {
"description": "Specifies id of the Request",
"example": "R202135269718",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "12345678",
"type": "string"
},
"bankName": {
"description": "Specifies name of the bank",
"example": "Euro banck",
"type": "string"
},
"branchName": {
"description": "The branch name of the banck",
"example": "European",
"type": "string"
},
"accountNumber": {
"description": "The account number",
"example": "12356789",
"type": "string"
},
"accountType": {
"description": "The type of the account",
"example": "Savings",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "U123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"AccountResponse": {
"properties": {
"accountId": {
"description": "Specifies id of the account",
"example": "A12345678",
"type": "string"
},
"requestId": {
"description": "Specifies id of the Request",
"example": "R202135269718",
"type": "string"
},
"partyId": {
"description": "Specifies id of the party",
"example": "12345678",
"type": "string"
},
"bankName": {
"description": "Specifies name of the bank",
"example": "Euro banck",
"type": "string"
},
"branchName": {
"description": "The branch name of the banck",
"example": "European",
"type": "string"
},
"accountNumber": {
"description": "The account number",
"example": "12356789",
"type": "string"
},
"accountType": {
"description": "The type of the account",
"example": "Savings",
"type": "string"
},
"lastChangeUserid": {
"description": "Specifies id of the User",
"example": "u12345",
"type": "string"
},
"lastChangeDateTime": {
"description": "The time stamp create and modify the account",
"example": "2022-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"PricingRequests": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingRequest"
}
}
}
},
"PricingResponses": {
"properties": {
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
}
}
},
"ProcessedPricingResponse": {
"properties": {
"pricingId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"AccountRequests": {
"properties": {
"account": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountRequest"
}
}
}
},
"AccountUpdateRequests": {
"properties": {
"account": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountUpdateRequest"
}
}
}
},
"AccountResponses": {
"properties": {
"account": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountResponse"
}
}
}
},
"ProcessedAccountResponse": {
"properties": {
"accountId": {
"description": "Unique Identifier",
"example": "A123456",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedCreditDecisionResponse": {
"properties": {
"creditDecisionId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"conditionId": {
"description": "Unique Identifier",
"example": "CON12345",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedScoreCardResponse": {
"properties": {
"scoreCardId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"scoreId": {
"description": "Unique Identifier",
"example": "CON12345",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedCovenantsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Deal",
"example": "D202012345678",
"type": "string"
},
"covenantId": {
"description": "Unique identifier for covenant",
"example": "COV2345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"CovenantsRequest": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "C12345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string",
"x-referencetype": "CovenantType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string",
"x-referencetype": "CovenantFrequency"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "CovenantStatus"
},
"operator": {
"description": "Operator of the Covenant",
"example": "01",
"type": "string",
"x-referencetype": "Operator"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "requirement",
"type": "string"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantsResponse": {
"properties": {
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"facilityId": {
"description": "Identifier of the facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Identifier of the party",
"example": "12345678",
"type": "string"
},
"covenantId": {
"description": "Identifier of the covenant",
"example": "COV202012345678",
"type": "string"
},
"covenantTypeId": {
"description": "Covenant Type",
"example": "01",
"type": "string"
},
"covenantName": {
"description": "Covenant Name",
"example": "YE Financial Statement",
"type": "string"
},
"dueDate": {
"description": "Covenant Due Date",
"example": "2020-12-20",
"type": "string"
},
"frequency": {
"description": "frequency",
"example": "01",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"status": {
"description": "Status of the Covenant",
"example": "01",
"type": "string"
},
"operator": {
"description": "Operator of the Covenant",
"example": "==",
"type": "string"
},
"requirement": {
"description": "requirement of the Covenant",
"example": "",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserid": {
"description": "User ID who did this change",
"example": "ABC001",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CovenantsRequests": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsRequest"
}
}
}
},
"CovenantsResponses": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
}
}
},
"ConditionsInfo": {
"properties": {
"conditionId": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ScoreInfo": {
"properties": {
"scoreType": {
"description": "Type of score",
"example": "Company Bureau Score",
"type": "string"
},
"value": {
"description": "Value of given type",
"example": 700,
"type": "integer",
"format": "decimal"
},
"score": {
"description": "Value of score",
"example": 10,
"type": "integer",
"format": "decimal"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateConditionRequest": {
"properties": {
"conditionId": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"creditDecisionId": {
"description": "id of credit decision",
"example": "12345678",
"type": "string"
},
"conditionType": {
"description": "condition type",
"example": "precedent",
"type": "string"
},
"conditionName": {
"description": "condition name",
"example": "proof of business registration",
"type": "string"
},
"conditionRequirement": {
"description": "condition requirement",
"example": "in good standing",
"type": "string"
},
"assignedUserId": {
"description": "assigned user id",
"example": "Donna Dunklin",
"type": "string"
},
"conditionStatus": {
"description": "condition status",
"example": "01",
"type": "string",
"x-referencetype": "ConditionStatus"
},
"conditionComment": {
"description": "condition comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditDecisionInfo": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"creditDecisionId": {
"description": "Unique identifier of the Credit decision",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"committeeId": {
"description": "Unique identifier of the committee",
"example": "12345678",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"approvedAmount": {
"description": "Amount utilised in the committee",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"finalDecision": {
"description": "finalDecision of committee",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"totalScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionsInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"amendmentType": {
"description": "Amendment type selected for facility",
"example": "01",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the Collateral",
"example": "C65675677",
"type": "string"
},
"approvedMaturityDate": {
"description": "Approved maturity date of facility",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ScoreCardInfo": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"scoreCardId": {
"description": "Unique identifier of the Score Card",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"totalScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"scores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoreInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateCreditDecisionRequest": {
"properties": {
"creditDecisionId": {
"description": "Unique identifier of the CreditDecision",
"example": "123456",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"drawingId": {
"description": "Specifies id of the drawing",
"example": "F202012345678-01",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"approverUserId": {
"description": "approver user Id",
"example": "12345678",
"type": "string"
},
"committeeId": {
"description": "Unique identifier of the committee",
"example": "12345678",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"approvedAmount": {
"description": "Amount utilised in the committee",
"example": 250000,
"type": "integer",
"format": "decimal"
},
"finalDecision": {
"description": "finalDecision of committee",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"decisionDate": {
"description": "decision date",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "expiry Date",
"type": "string",
"format": "date"
},
"decisionId": {
"description": "decision Id",
"example": "01",
"type": "string"
},
"decisionComment": {
"description": "decision comment",
"example": "comment",
"type": "string"
},
"totalScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"amendmentType": {
"description": "Amendment type selected for facility",
"example": "01",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the Collateral",
"example": "C65675677",
"type": "string"
},
"approvedMaturityDate": {
"description": "approved maturity date",
"example": "2021-12-30",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"UpdateScoreCardRequest": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"scoreCardId": {
"description": "Unique identifier of the Score Card",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"totalScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"scores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoreInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"PolicyExceptionsRequest": {
"properties": {
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"exceptionType": {
"description": "type of the exception",
"type": "string"
},
"description": {
"description": "Description of the exception",
"type": "string"
},
"status": {
"description": "The status of the exception",
"type": "string",
"x-referencetype": "PolicyExceptionStatus"
},
"comment": {
"description": "Policy exceptions comment",
"example": "comment",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"UpdatePolicyExceptionsRequest": {
"properties": {
"policyExceptionId": {
"description": "Unique identifier of the PolicyExceptions",
"example": "PE123456",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"collateralId": {
"description": "Unique identifier of the collateral",
"example": "C202035292905",
"type": "string"
},
"exceptionType": {
"description": "type of the exception",
"type": "string"
},
"description": {
"description": "exception description",
"type": "string"
},
"status": {
"description": "The status of the exception",
"type": "string",
"x-referencetype": "PolicyExceptionStatus"
},
"comment": {
"description": "exception comment",
"example": "comment",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"extensionData": {
"type": "object"
}
}
},
"CreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
}
}
},
"UpdateCreditDecisionList": {
"properties": {
"creditDecisionItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateCreditDecisionRequest"
}
}
}
},
"UpdateScoreCardList": {
"properties": {
"ScoreCardItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateScoreCardRequest"
}
}
}
},
"ScoreCardList": {
"properties": {
"scorecardItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoreCardInfo"
}
}
}
},
"RiskScoreCardList": {
"properties": {
"riskscorecardItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskScoreCardInfo"
}
}
}
},
"PolicyExceptionsList": {
"properties": {
"policyExceptionsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionsRequest"
}
}
}
},
"UpdatePolicyExceptionsList": {
"properties": {
"policyExceptionsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdatePolicyExceptionsRequest"
}
}
}
},
"UpdateConditionList": {
"properties": {
"conditionItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateConditionRequest"
}
}
}
},
"RequestOverViewResponse": {
"properties": {
"parentProcessId": {
"description": "Parent Process for Deal",
"example": "1",
"type": "string"
},
"requestOverView": {
"allOf": [
{
"$ref": "#/components/schemas/DealDetailsResponse"
}
]
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsResponse"
}
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"borrowerFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"drawRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"compliances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"policyException": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyExceptionResponse"
}
},
"IntegrationService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
},
"ExternalServiceHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
},
"checklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"financialResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialResultResponse"
}
},
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
},
"momInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MomInfo"
}
},
"consents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsentItem"
}
},
"exposure": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureResponseList"
}
}
}
},
"directDetails": {
"properties": {
"facilityId": {
"description": "facility Id",
"example": "F352552",
"type": "string"
},
"facilityType": {
"description": "facility Type",
"example": "sample",
"type": "string"
},
"originationAmountCurrency": {
"description": "origination Amount Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"originationAmount": {
"description": "origination Amount",
"example": "10000",
"type": "string"
},
"estimatedMaturityDate": {
"description": "estimated Maturity Date",
"example": "01/22/2022",
"type": "string"
},
"outstandingAmountCurrency": {
"description": "outstanding Amount Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"outstandingAmount": {
"description": "outstanding Amount",
"example": "20000",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"indirectDetails": {
"properties": {
"facilityId": {
"description": "facility Id",
"example": "F352552",
"type": "string"
},
"guaranteeLimitPercentage": {
"description": "guarantee Limit Percentage",
"example": "70",
"type": "string"
},
"guaranteeLimitAmountCurrency": {
"description": "guarantee Limit Amount Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"guaranteeLimitAmount": {
"description": "guarantee Limit Amount",
"example": "10000",
"type": "string"
},
"originationAmountCurrency": {
"description": "origination Amount Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"originationAmount": {
"description": "origination Amount",
"example": "10000",
"type": "string"
},
"potentialObligationAmountCurrency": {
"description": "potential Obligation Amount Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"potentialObligationAmount": {
"description": "potential Obligation Amount",
"example": "20000",
"type": "string"
},
"estimatedMaturityDate": {
"description": "estimated Maturity Date",
"example": "01/22/2022",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"pendingDetails": {
"properties": {
"facilityId": {
"description": "facility Id",
"example": "F352552",
"type": "string"
},
"facilityType": {
"description": "facility Type",
"example": "sample",
"type": "string"
},
"originationAmountCurrency": {
"description": "origination Amount Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"originationAmount": {
"description": "origination Amount",
"example": "10000",
"type": "string"
},
"estimatedMaturityDate": {
"description": "estimated Maturity Date",
"example": "01/22/2022",
"type": "string"
},
"isIndirect": {
"description": "is Indirect",
"example": true,
"type": "boolean"
},
"extensionData": {
"type": "object"
}
}
},
"AdjustmentsInfo": {
"properties": {
"exposureId": {
"description": "adjusted Date",
"example": "E12345",
"type": "string"
},
"lastChangeUserId": {
"description": "User Id",
"example": "a123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"facilityType": {
"description": "Type of facility",
"example": "01",
"type": "string"
},
"adjustedAmount": {
"description": "Adjusted Amount",
"example": "2 million",
"type": "string"
},
"adjustedCurrency": {
"description": "Adjusted Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedComment": {
"description": "adjusted comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"AdjustmentsUpdateInfo": {
"properties": {
"adjustmentId": {
"description": "adjusted User Id",
"example": "A123",
"type": "string"
},
"exposureId": {
"description": "adjusted Date",
"example": "E12345",
"type": "string"
},
"lastChangeUserId": {
"description": "User Id",
"example": "a123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"facilityType": {
"description": "Type the facility",
"example": "01",
"type": "string"
},
"adjustedAmount": {
"description": "Adjusted Amount",
"example": "2 million",
"type": "string"
},
"adjustedCurrency": {
"description": "Adjusted Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"adjustedComment": {
"description": "adjusted comment",
"example": "Lorem lpsum Lorem lpsum",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalCommitmentsInfo": {
"properties": {
"externalCommitmentId": {
"description": "external Commitment Id",
"example": "EC2727277",
"type": "string"
},
"exposureId": {
"description": "exposure Id",
"example": "a123",
"type": "string"
},
"lastChangeUserId": {
"description": "last changed User Id",
"example": "a123",
"type": "string"
},
"lastChangeDateTime": {
"description": "last changed date time",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"lenderName": {
"description": "Name of the lender",
"example": "Jhon",
"type": "string"
},
"commitmentAmount": {
"description": "commitment Amount",
"example": "2",
"type": "string"
},
"maturityDate": {
"description": "maturity Date",
"example": "2020-06-03",
"type": "string"
},
"commitmentCurrency": {
"description": "commitment Currency",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureCommentsInfo": {
"properties": {
"exposureCommentsId": {
"description": "exposure Comments Id",
"example": "EXP7644567",
"type": "string"
},
"exposureId": {
"description": "exposure Id",
"example": "E27272727",
"type": "string"
},
"lastChangeUserId": {
"description": "adjusted User Id",
"example": "a123",
"type": "string"
},
"lastChangeDateTime": {
"description": "last changed date time",
"example": "2020-06-03 10:08 08 800",
"type": "string",
"format": "date"
},
"comment": {
"description": "comment",
"example": "this exposure is pending",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureInfo": {
"properties": {
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"exposureId": {
"description": "Unique identifier of the Exposure",
"example": "P202035292905",
"type": "string"
},
"requestId": {
"description": "Request Id",
"example": "R202035292905",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"directDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/directDetails"
}
},
"indirectDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/indirectDetails"
}
},
"pendingDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pendingDetails"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"createdDateTime": {
"description": "Exposure Date and Time",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ExposureList": {
"properties": {
"exposureItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
}
}
},
"ExposureResponseList": {
"properties": {
"exposureItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureInfo"
}
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsUpdateInfo"
}
},
"externalCommitments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalCommitmentsInfo"
}
},
"exposureComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureCommentsInfo"
}
}
}
},
"FacilityOverViewResponse": {
"properties": {
"parentProcessId": {
"description": "Parent Process for Deal",
"example": "1",
"type": "string"
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"fees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"drawRestriction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawRestrictionResponse"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
},
"compliance": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComplianceResponse"
}
},
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksResponse"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsResponse"
}
},
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
},
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInstructionsResponse"
}
},
"notarys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetNotaryResponse"
}
},
"remortgageInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemortgageInfoResponse"
}
}
}
},
"DrawingOverViewResponse": {
"properties": {
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsResponse"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealDetailsResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"narratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NarrativesResponse"
}
},
"fees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeeResponse"
}
},
"decision": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditDecisionInfo"
}
},
"funding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingDetailsResponse"
}
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingResponse"
}
},
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInstructionsResponse"
}
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartiesResponse"
}
},
"remortgageInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemortgageInfoResponse"
}
}
}
},
"TasksParamsReferenceDataItems": {
"properties": {
"tasksParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TasksParamsItem"
}
},
"tasksInfo": {
"$ref": "#/components/schemas/TasksInfoItem"
}
}
},
"EntityOverViewResponse": {
"properties": {
"covenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovenantsResponse"
}
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
},
"facilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityResponse"
}
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitsResponse"
}
},
"account": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountResponse"
}
},
"Exposures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureResponseList"
}
},
"IntegrationService": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
},
"ExternalServiceHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
}
}
},
"MessageList": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"MessagesList": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageList"
}
}
}
},
"CreateMessagesResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
}
}
},
"GetMessageResponse": {
"properties": {
"messageId": {
"description": "message Id",
"example": "MSG202012345678",
"type": "string"
},
"dealId": {
"description": "deal Id",
"example": "R202012345678",
"type": "string"
},
"facilityId": {
"description": "Facility Id",
"example": "F202012345678",
"type": "string"
},
"messageDescription": {
"description": "message description",
"example": "desc 123",
"type": "string"
},
"userId": {
"description": "user Id",
"example": "12345",
"type": "string"
},
"read": {
"description": "read flag",
"example": "true",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"lastChangeDateTime": {
"description": "read flag",
"example": "true",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"GetMessagesResponse": {
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetMessageResponse"
}
}
}
},
"IntegrationServicesRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"integrationServicesId": {
"description": "Unique Identifier of IntegrationServices",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "01",
"type": "string",
"x-referencetype": "Provider"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "01",
"type": "string",
"x-referencetype": "ProviderType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"accountNumber": {
"description": "Account Number",
"example": "abcd",
"type": "string"
},
"package1": {
"description": "Name of the first Package",
"example": "weekly package",
"type": "string"
},
"package2": {
"description": "Name of the second Package",
"example": "monthly package",
"type": "string"
},
"package3": {
"description": "Name of the third Package",
"example": "yearly package",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the Integration Service",
"example": "lata123",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"IntegrationServicesRequests": {
"properties": {
"integrationServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesRequest"
}
}
}
},
"IntegrationServicesResponse": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"integrationServicesId": {
"description": "Unique Identifier of IntegrationServices",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "Airtel",
"type": "string"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "3g",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"accountNumber": {
"description": "Account Number",
"example": "abcd",
"type": "string"
},
"package1": {
"description": "Name of the first Package",
"example": "weekly package",
"type": "string"
},
"package2": {
"description": "Name of the second Package",
"example": "monthly package",
"type": "string"
},
"package3": {
"description": "Name of the third Package",
"example": "yearly package",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the Integration Service",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Integration Service was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"IntegrationServicesResponses": {
"properties": {
"integrationServices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationServicesResponse"
}
}
}
},
"ProcessedIntegrationServicesResponse": {
"properties": {
"integrationServicesId": {
"description": "Unique identifier for integrationServices",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryRequest": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"externalServicesHistoryId": {
"description": "Unique Identifier of externalServicesHistory",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "01",
"type": "string",
"x-referencetype": "Provider"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "01",
"type": "string",
"x-referencetype": "ProviderType"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"package1": {
"description": "Package of service",
"example": "monthly",
"type": "string"
},
"result": {
"description": "Link of external result",
"example": "www.result.com",
"type": "string"
},
"status": {
"description": "The status of ExternalServiceHistory",
"example": "Pending",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the externalServicesHistory",
"example": "lata123",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServiceDocumentItem"
}
},
"comments": {
"description": "Comments",
"example": "Comments",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryRequests": {
"properties": {
"externalServicesHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRequest"
}
}
}
},
"ExternalServicesHistoryRespose": {
"properties": {
"requestId": {
"description": "Unique Identifier of Deal",
"example": "D2020123456",
"type": "string"
},
"facilityId": {
"description": "Unique Identifier of Facility",
"example": "F2020123456",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "123456789",
"type": "string"
},
"externalServicesHistoryId": {
"description": "Unique Identifier of externalServicesHistory",
"example": "123456789",
"type": "string"
},
"serviceProvider": {
"description": "Name of the service Provider",
"example": "Airtel",
"type": "string"
},
"serviceType": {
"description": "Type of the serviceProvider",
"example": "3g",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"package1": {
"description": "Package of service",
"example": "monthly",
"type": "string"
},
"result": {
"description": "Link of external result",
"example": "www.result.com",
"type": "string"
},
"status": {
"description": "The status of ExternalServiceHistory",
"example": "Pending",
"type": "string"
},
"lastChangeUserId": {
"description": "UserID of the user who last changed the externalServicesHistory ",
"example": "lata123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the externalServicesHistory was last changed",
"type": "string",
"format": "date"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServiceDocumentItem"
}
},
"comments": {
"description": "Comments",
"example": "Comments",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"ExternalServicesHistoryResposes": {
"properties": {
"externalServicesHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalServicesHistoryRespose"
}
}
}
},
"ProcessedExternalServicesHistoryResponse": {
"properties": {
"externalServicesHistoryId": {
"description": "Unique identifier for externalServicesHistory",
"example": "200722894",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRequestProcessRelation": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R123456",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F123456",
"type": "string"
},
"parentProcessId": {
"description": "unique identifier of parentProcess",
"example": "P123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"extensionData": {
"type": "object"
}
}
},
"CreateRequestProcessRelations": {
"properties": {
"requestProcessRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateRequestProcessRelation"
}
}
}
},
"RequestProcessRelationResponse": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R123456",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F123456",
"type": "string"
},
"parentProcessId": {
"description": "unique identifier of parentProcess",
"example": "P123456",
"type": "string"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RequestProcessRelationResponses": {
"properties": {
"requestProcessRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestProcessRelationResponse"
}
}
}
},
"CreateFacilityApproverInfo": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F20217632573",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "C2021754566",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "7645756",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "7645756",
"type": "string"
},
"riskOfficerUserId": {
"description": "userId of the riskOfficer",
"example": "01",
"type": "string"
},
"riskOfficerDecisionId": {
"description": "decisionId of the riskOfficer",
"example": "7645756",
"type": "string"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreateFacilityApproversInfo": {
"properties": {
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateFacilityApproverInfo"
}
}
}
},
"ProcessedFacilityApproverInfoResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for facilityApprover",
"example": "2007228945674",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityApproverInfo": {
"properties": {
"rowId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"facilityId": {
"description": "unique identifier of facility",
"example": "F20217632573",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "C2021754566",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "7645756",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "01",
"type": "string"
},
"riskOfficerUserId": {
"description": "userId of the riskOfficer",
"example": "01",
"type": "string"
},
"riskOfficerDecisionId": {
"description": "decisionId of the riskOfficer",
"example": "7645756",
"type": "string"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "7645756",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the facilityApproverInfo was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"FacilityApproversInfo": {
"properties": {
"facilityApproverInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FacilityApproverInfo"
}
}
}
},
"MemberInfo": {
"properties": {
"memberId": {
"description": "Member Id",
"example": "bfleck",
"type": "string"
},
"memberRole": {
"description": "Member Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
}
}
},
"CreateMomInfo": {
"properties": {
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "CC3",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "gregory",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "secretary",
"type": "string"
},
"mom": {
"description": "MOM",
"example": "mom Details Added",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MomDocumentItem"
}
},
"extensionData": {
"type": "object"
}
}
},
"MomDocumentItem": {
"properties": {
"documentId": {
"description": "ID of the document uploaded in mom",
"example": "D20201234",
"type": "string"
},
"documentName": {
"description": "Name of the document",
"example": "asset.txt",
"type": "string"
}
}
},
"MomInfo": {
"properties": {
"rowId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"requestId": {
"description": "unique identifier of request",
"example": "R202136437546",
"type": "string"
},
"committeeId": {
"description": "unique identifier of committee",
"example": "CC3",
"type": "string"
},
"approverUserId": {
"description": "userId of the approver",
"example": "gregory",
"type": "string"
},
"approverRoleId": {
"description": "role of the approver",
"example": "secretary",
"type": "string"
},
"mom": {
"description": "MOM",
"example": "MOM123",
"type": "string"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MomDocumentItem"
}
},
"lastChangeDateTime": {
"description": "Date when the facilityApproverInfo was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"CreateMomInfos": {
"properties": {
"momInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateMomInfo"
}
}
}
},
"ProcessedMomInfoResponse": {
"properties": {
"rowId": {
"description": "Unique identifier for facilityApprover",
"example": "2007228945674",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"MomInfos": {
"properties": {
"momInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MomInfo"
}
}
}
},
"CreditCommitteeRequest": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Committee",
"example": "CR1726789239",
"type": "string"
},
"committeeName": {
"description": "Name of a Committeee",
"example": "CC1",
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberInfo"
}
},
"noOfDecisions": {
"description": "Number of Decisions needed for the commitee to carry on with the decision",
"example": "4",
"type": "string"
},
"secretaryId": {
"description": "Secretary Id",
"example": "gregory",
"type": "string"
},
"secretaryRole": {
"description": "Secretary Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"hierarchy": {
"description": "Hierarchy of a committee",
"example": "10",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeRequests": {
"properties": {
"creditCommitteeRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditCommitteeRequest"
}
}
}
},
"ProcessedCreditCommitteeResponse": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Credit Committee",
"example": "CR7628390",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeResponse": {
"properties": {
"committeeId": {
"description": "Unique Identifier of Committee",
"example": "CR1726789239",
"type": "string"
},
"committeeName": {
"description": "Name of a Committeee",
"example": "CC1",
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberInfo"
}
},
"noOfDecisions": {
"description": "Number of Decisions needed for the commitee to carry on with the decision",
"example": "4",
"type": "string"
},
"secretaryId": {
"description": "secretary ID",
"example": "01",
"type": "string"
},
"secretaryRole": {
"description": "secretary Role",
"example": "01",
"type": "string",
"x-referencetype": "CommitteeRole"
},
"lastChangeUserId": {
"description": "last changed userId",
"example": "123456",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the credit commitee was last changed",
"type": "string",
"format": "date"
},
"hierarchy": {
"description": "Hierarchy of a committee",
"example": "10",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CreditCommitteeResponses": {
"properties": {
"creditCommitteeResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditCommitteeResponse"
}
}
}
},
"FacilitiesInfoResponse": {
"properties": {
"facilityId": {
"description": "Unique identifier for Facility",
"example": "F202012345678",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of party",
"example": "123456789",
"type": "string"
},
"facilityType": {
"description": "Type of the facility",
"example": "Line of Credit",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string"
},
"totalAmount": {
"description": "Total amount of the facility",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"facilityName": {
"description": "Name of the facility",
"example": "ABC Ltd",
"type": "string"
},
"facilityStatus": {
"description": "Status of the facility",
"example": "Awaiting Approval",
"type": "string"
}
}
},
"RecentViewedRequestSuccessResponse": {
"properties": {
"userId": {
"description": "Unique identifier for user",
"example": "bfleck",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details or corrective actions"
},
"extensionData": {
"type": "object"
}
}
},
"RecentViewedInputRequest": {
"properties": {
"userId": {
"description": "Unique Identifier of User",
"example": "bfleck",
"type": "string"
},
"requestId": {
"description": "Unique Identifier of Request",
"example": "D48759833",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RecentViewedRequestResponse": {
"properties": {
"userId": {
"description": "Unique Identifier of User",
"example": "bfleck",
"type": "string"
},
"requestId": {
"description": "Unique Identifier of Request",
"example": "D48759833",
"type": "string"
},
"timeStamp": {
"description": "Date when the Recent review request was last changed",
"example": "2021-08-11 08:36:02.697",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"RecentViewedRequestResponses": {
"properties": {
"recentViewedResponses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecentViewedRequestResponse"
}
}
}
},
"CustomerActionRequest": {
"properties": {
"customerActionId": {
"description": "Uniquely generated uuid Customer Action Instance",
"example": "95a138d2-1c8b-11ec-9621-0242ac130002",
"type": "string"
},
"customerActionName": {
"description": "Unique Idenitifier of a customer action type",
"example": "IncomeDocument,EmploymentStatus",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"customerActionType": {
"description": "Type Of User Action",
"example": "Currency, Date",
"type": "string"
},
"group": {
"description": "User Action Group",
"example": "Personal Information",
"type": "string"
},
"actionLevel": {
"description": "Entity or Facility",
"example": "Entity",
"type": "string"
},
"createdBy": {
"description": "User Name of the creator",
"example": "ABC",
"type": "string"
},
"createdTime": {
"description": "Date when the Customer Action was created",
"type": "string",
"format": "date"
},
"title": {
"description": "Heading of the user action card",
"example": "Please Enter your First Name",
"type": "string"
},
"titleKey": {
"description": "Unique key to support internalization",
"example": "TIN01234",
"type": "string"
},
"appliesToId": {
"description": "Facility Id/Drawing Id if the action level is facility or Entity Id if the action levele is entity",
"example": "F0123456,F0123456-01,E012345",
"type": "string"
},
"appliesToName": {
"description": "Full name of the entity if level is entity",
"example": "false",
"type": "string"
},
"responseValues": {
"description": "Response values provided by customer",
"example": "Accepted",
"type": "string"
},
"responseTimeStamp": {
"description": "Date when Customer gave the response",
"type": "string",
"format": "date"
},
"responseChannel": {
"description": "Channel from where the response comes",
"example": "Origination",
"type": "string"
},
"customerActionStatus": {
"description": "Status of the user action",
"example": "Pending with Customer/Submitted/Waived/Skipped",
"type": "string"
},
"taskId": {
"description": "Id of the associated task",
"example": "123456789",
"type": "string"
},
"processId": {
"description": "Process ID",
"example": "P1234567",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"AdjustmentsSuccessResponse": {
"properties": {
"adjustmentId": {
"description": "Unique identifier for Adjustment",
"example": "A1234455",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Any further details"
}
}
},
"ExposureSuccessResponse": {
"properties": {
"exposureId": {
"description": "Unique identifier for Exposure",
"example": "EXP1234455",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Any further details"
}
}
},
"CustomerActionsResponse": {
"properties": {
"customerActionId": {
"description": "Unique identifier for Customer Actions",
"example": "95a138d2-1c8b-11ec-9621-0242ac130002",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Any further details"
}
}
},
"CustomerActionsByTaskResponse": {
"properties": {
"customerActionId": {
"description": "Uniquely generated uuid Customer Action Instance",
"example": "95a138d2-1c8b-11ec-9621-0242ac130002",
"type": "string"
},
"customerActionName": {
"description": "Unique Idenitifier of a customer action type",
"example": "IncomeDocument,EmploymentStatus",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"customerActionType": {
"description": "Type Of User Action",
"example": "Currency, Date",
"type": "string"
},
"group": {
"description": "User Action Group",
"example": "Personal Information",
"type": "string"
},
"actionLevel": {
"description": "Entity or Facility",
"example": "Entity",
"type": "string"
},
"createdBy": {
"description": "User Name of the creator",
"example": "ABC",
"type": "string"
},
"createdTime": {
"description": "Date when the Customer Action was created",
"type": "string",
"format": "date"
},
"title": {
"description": "Heading of the user action card",
"example": "Please Enter your First Name",
"type": "string"
},
"titleKey": {
"description": "Unique key to support internalization",
"example": "TIN01234",
"type": "string"
},
"appliesToId": {
"description": "Facility Id/Drawing Id if the action level is facility or Entity Id if the action levele is entity",
"example": "FF0123456,F0123456-01,E012345",
"type": "string"
},
"appliesToName": {
"description": "Full name of the entity if level is entity",
"example": "false",
"type": "string"
},
"responseValues": {
"description": "Response values provided by customer",
"example": "Accepted",
"type": "string"
},
"responseTimeStamp": {
"description": "Date when Customer gave the response",
"type": "string",
"format": "date"
},
"responseChannel": {
"description": "Channel from where the response comes",
"example": "Origination",
"type": "string"
},
"customerActionStatus": {
"description": "Status of the user action",
"example": "Pending with Customer/Submitted/Waived/Skipped",
"type": "string"
},
"taskId": {
"description": "Id of the associated task",
"example": "123456789",
"type": "string"
},
"processId": {
"description": "Process ID",
"example": "P1234567",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerActionsByRequestResponse": {
"properties": {
"customerActionId": {
"description": "Uniquely generated uuid Customer Action Instance",
"example": "95a138d2-1c8b-11ec-9621-0242ac130002",
"type": "string"
},
"customerActionName": {
"description": "Unique Idenitifier of a customer action type",
"example": "IncomeDocument,EmploymentStatus",
"type": "string"
},
"requestId": {
"description": "Unique identifier for Request",
"example": "D202012345678",
"type": "string"
},
"customerActionType": {
"description": "Type Of User Action",
"example": "Currency, Date",
"type": "string"
},
"group": {
"description": "User Action Group",
"example": "Personal Information",
"type": "string"
},
"actionLevel": {
"description": "Entity or Facility",
"example": "Entity",
"type": "string"
},
"createdBy": {
"description": "User Name of the creator",
"example": "ABC",
"type": "string"
},
"createdTime": {
"description": "Date when the Customer Action was created",
"type": "string",
"format": "date"
},
"title": {
"description": "Heading of the user action card",
"example": "Please Enter your First Name",
"type": "string"
},
"titleKey": {
"description": "Unique key to support internalization",
"example": "TIN01234",
"type": "string"
},
"appliesToId": {
"description": "Facility Id/Drawing Id if the action level is facility or Entity Id if the action levele is entity",
"example": "F0123456,F0123456-01,E012345",
"type": "string"
},
"appliesToName": {
"description": "Full name of the entity if level is entity",
"example": "false",
"type": "string"
},
"responseValues": {
"description": "Response values provided by customer",
"example": "Accepted",
"type": "string"
},
"responseTimeStamp": {
"description": "Date when Customer gave the response",
"type": "string",
"format": "date"
},
"responseChannel": {
"description": "Channel from where the response comes",
"example": "Origination",
"type": "string"
},
"customerActionStatus": {
"description": "Status of the user action",
"example": "Pending with Customer/Submitted/Waived/Skipped",
"type": "string"
},
"taskId": {
"description": "Id of the associated task",
"example": "123456789",
"type": "string"
},
"processId": {
"description": "Process ID",
"example": "P1234567",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"CustomerActionsRequests": {
"properties": {
"customerActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerActionRequest"
}
}
}
},
"AdjustmentsRequests": {
"properties": {
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsInfo"
}
}
}
},
"AdjustmentsUpdateRequests": {
"properties": {
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsUpdateInfo"
}
}
}
},
"AdjustmentsGetResponse": {
"properties": {
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentsUpdateInfo"
}
}
}
},
"ExternalCommitmentsRequests": {
"properties": {
"externalCommitments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalCommitmentsInfo"
}
}
}
},
"ExposureCommentsResultResponse": {
"properties": {
"exposureCommentsId": {
"description": "exposure CommentsId",
"example": "EXP6545678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"ExternalCommitmentsResultResponse": {
"properties": {
"externalCommitmentId": {
"description": "ExternalCommitment Id",
"example": "EXTC12345",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"ExternalCommitmentsResponse": {
"properties": {
"externalCommitments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalCommitmentsInfo"
}
}
}
},
"ExposureCommentsRequests": {
"properties": {
"exposureComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureCommentsInfo"
}
}
}
},
"ExposureCommentsResponse": {
"properties": {
"exposureComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExposureCommentsInfo"
}
}
}
},
"CustomerActionsByTaskResponses": {
"properties": {
"customerActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerActionsByTaskResponse"
}
}
}
},
"CustomerActionsByRequestResponses": {
"properties": {
"customerActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerActionsByRequestResponse"
}
}
}
},
"ProcessedRiskScoreCardResponse": {
"properties": {
"riskScoreCardId": {
"description": "Unique Identifier",
"example": "10021202",
"type": "string"
},
"status": {
"description": "Specifies status of the request",
"example": "Success",
"type": "string"
},
"message": {
"description": "Specifies the text that provide more details or corrective actions",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"RiskScoreCardInfo": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "D202035292905",
"type": "string"
},
"riskScoreCardId": {
"description": "Unique identifier of the Score Card",
"example": "123456789",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"partyId": {
"description": "Unique identifier of the party",
"example": "P202035292905",
"type": "string"
},
"lineOfBusiness": {
"description": "Unique identifier of the line of business",
"example": "02",
"type": "string"
},
"totalRiskScore": {
"description": "sum of all individual parameter scores",
"example": 100,
"type": "integer",
"format": "decimal"
},
"riskScores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskScoreInfo"
}
},
"lastChangeUserId": {
"description": "userId of the person who updated the record",
"example": "12345678",
"type": "string"
},
"lastChangeDateTime": {
"description": "last updated date",
"example": "2020-06-03",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"RiskScoreInfo": {
"properties": {
"riskScoreType": {
"description": "Type of score",
"example": "Company Bureau Score",
"type": "string"
},
"value": {
"description": "Value of given type",
"example": 700,
"type": "integer",
"format": "decimal"
},
"riskScore": {
"description": "Value of score",
"example": 10,
"type": "integer",
"format": "decimal"
},
"extensionData": {
"type": "object"
}
}
},
"BankDetails": {
"properties": {
"bankType": {
"description": "Type of the Bank",
"example": "01",
"type": "string",
"x-referencetype": "BankType"
},
"accountNumber": {
"description": "Account Number",
"example": "AC2129222",
"type": "string"
},
"routeNumber": {
"description": "Route Number",
"example": "A12",
"type": "string"
},
"bankName": {
"description": "Bank Name",
"example": "ABC Bank",
"type": "string"
}
}
},
"OtherBankDetails": {
"properties": {
"bankCode": {
"description": "Code of the Bank",
"example": "01",
"type": "string"
},
"accountNumber": {
"description": "Account Number",
"example": "AC2129222",
"type": "string"
},
"bankName": {
"description": "Bank Name",
"example": "ABC Bank",
"type": "string"
}
}
},
"AdditionalInstructionsRequest": {
"properties": {
"additionalInstructionId": {
"description": "ID of the Additional Instructions",
"example": "AI983495385",
"type": "string"
},
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Id of the drawing created for a Facility",
"example": "F202012345678-01",
"type": "string"
},
"facilityType": {
"description": "Facility Type",
"example": "2",
"type": "string"
},
"authorizedUserId": {
"description": "The ID of authorized user",
"example": "A123",
"type": "string"
},
"instructionDate": {
"description": "Date of the Instruction",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"instructionType": {
"description": "The instruction Type",
"example": "10",
"type": "string",
"x-referencetype": "InstructionType"
},
"bankDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BankDetails"
}
]
},
"autoPay": {
"description": "Auto Pay",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string",
"x-referencetype": "LineOfBusiness"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"payType": {
"description": "Pay Type",
"example": "SWIFT",
"type": "string",
"x-referencetype": "RepaymentPayType"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Additional Instruction was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"AdditionalInstructionsRequests": {
"properties": {
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInstructionsRequest"
}
}
}
},
"AdditionalInstructionsResponse": {
"properties": {
"additionalInstructionId": {
"description": "ID of the Additional Instructions",
"example": "AI983495385",
"type": "string"
},
"requestId": {
"description": "ID of the Request",
"example": "R202129226526",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"facilityId": {
"description": "ID of the facility created for this Request",
"example": "F202129226590",
"type": "string"
},
"drawingId": {
"description": "Id of the drawing created for a Facility",
"example": "F202012345678-01",
"type": "string"
},
"facilityType": {
"description": "Facility Type",
"example": "2",
"type": "string"
},
"authorizedUserId": {
"description": "The ID of authorized user",
"example": "A123",
"type": "string"
},
"instructionDate": {
"description": "Date of the Instruction",
"example": "2021-11-18",
"type": "string",
"format": "date"
},
"instructionType": {
"description": "The instruction Type",
"example": "10",
"type": "string"
},
"bankDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BankDetails"
}
]
},
"autoPay": {
"description": "Auto Pay",
"example": true,
"type": "boolean"
},
"lineOfBusiness": {
"description": "The line of business",
"example": "01",
"type": "string"
},
"amendRequestTypeStatus": {
"description": "Status to tell amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestTypeStatus"
},
"amendRequestType": {
"description": "type of amend Request",
"example": "01",
"type": "string",
"x-referencetype": "AmendRequestType"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"payType": {
"description": "Pay Type",
"example": "SWIFT",
"type": "string",
"x-referencetype": "RepaymentPayType"
},
"lastChangeDateTime": {
"description": "Date when the Additional Instruction was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"AdditionalInstructionsResponses": {
"properties": {
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInstructionsResponse"
}
}
}
},
"ProcessedAdditionalInstructionsResponse": {
"properties": {
"additionalInstructionId": {
"description": "ID of the Additional Instructions",
"example": "AI8374823543",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"SourceOfFunds": {
"properties": {
"requestedAmount": {
"description": "Requested loan amount",
"example": 50000,
"type": "integer",
"format": "decimal"
},
"customerContribution": {
"description": "Customer contribution towards source of funds",
"example": 50000,
"type": "integer",
"format": "decimal"
},
"coApplicantContribution": {
"description": "Co-applicant's contribution towards source of funds",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"otherSource": {
"description": "Contribution from other sources towards source of funds",
"example": 12500,
"type": "integer",
"format": "decimal"
}
}
},
"SourceOfFundsResponse": {
"properties": {
"requestedAmount": {
"description": "Requested amount",
"example": 50000,
"type": "integer",
"format": "decimal"
},
"customerContribution": {
"description": "Customer contribution towards source of funds",
"example": 50000,
"type": "integer",
"format": "decimal"
},
"coApplicantContribution": {
"description": "Co-applicant's contribution towards source of funds",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"otherSource": {
"description": "Contribution from other sources towards source of funds",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"totalSourceOfFunds": {
"description": "Sum of all sources of fund",
"example": 87500,
"type": "integer",
"format": "decimal"
}
}
},
"UseOfFunds": {
"properties": {
"purchaseCost": {
"description": "Cost of property",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"governmentCharges": {
"description": "Government charges for purchase of property",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"bankCharges": {
"description": "Bank charges for purchase of property",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"insuranceCharges": {
"description": "Insurance charges for purchase of property",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"miscellaneousCharges": {
"description": "Miscellaneous charges for purchase of property",
"example": 6250.5,
"type": "integer",
"format": "decimal"
},
"otherBankPayment": {
"description": "Outstanding loan amount to other bank",
"example": 100000,
"type": "integer",
"format": "decimal"
},
"otherExpenses": {
"description": "Additional loan that is required for other expenses",
"example": 30000,
"type": "integer",
"format": "decimal"
}
}
},
"UseOfFundsResponse": {
"properties": {
"purchaseCost": {
"description": "Cost of property",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"governmentCharges": {
"description": "Government charges for purchase of property",
"example": 25000,
"type": "integer",
"format": "decimal"
},
"bankCharges": {
"description": "Bank charges for purchase of property",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"insuranceCharges": {
"description": "Insurance charges for purchase of property",
"example": 12500,
"type": "integer",
"format": "decimal"
},
"miscellaneousCharges": {
"description": "Miscellaneous charges for purchase of property",
"example": 6250.5,
"type": "integer",
"format": "decimal"
},
"otherBankPayment": {
"description": "Outstanding loan amount to other bank",
"example": 100000,
"type": "integer",
"format": "decimal"
},
"otherExpenses": {
"description": "Additional loan that is required for other expenses",
"example": 30000,
"type": "integer",
"format": "decimal"
},
"totalUseOfFunds": {
"description": "Sum of all uses of funds",
"example": 6250.5,
"type": "integer",
"format": "decimal"
}
}
},
"FundingPositionRequest": {
"properties": {
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"currencyId": {
"description": "Currency in which the facility is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"sourceOfFunds": {
"allOf": [
{
"$ref": "#/components/schemas/SourceOfFunds"
}
]
},
"useOfFunds": {
"allOf": [
{
"$ref": "#/components/schemas/UseOfFunds"
}
]
},
"lastChangeUserId": {
"description": "last Modification made by user on funding position",
"example": "rmuser",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
},
"FundingPositionResponseItem": {
"properties": {
"requestId": {
"description": "Unique identifier of the deal",
"example": "R02035292905",
"type": "string"
},
"facilityId": {
"description": "Unique identifier of the facility",
"example": "F202035292905",
"type": "string"
},
"currencyId": {
"description": "Currency for the funding position amounts",
"example": "USD",
"type": "string"
},
"sourceOfFunds": {
"allOf": [
{
"$ref": "#/components/schemas/SourceOfFundsResponse"
}
]
},
"useOfFunds": {
"allOf": [
{
"$ref": "#/components/schemas/UseOfFundsResponse"
}
]
},
"surplusOrDeficitAmount": {
"description": "Sum of all uses of funds",
"example": 6250.5,
"type": "integer",
"format": "decimal"
},
"lastChangeUserId": {
"description": "last Modification made by user on funding position",
"example": "rmuser",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the funding position was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"FundingPositionResponse": {
"properties": {
"fundingPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FundingPositionResponseItem"
}
}
}
},
"DrawingsTerm": {
"properties": {
"years": {
"description": "Number of Years",
"example": "2",
"type": "string"
},
"months": {
"description": "Number of Months",
"example": "12",
"type": "string"
},
"days": {
"description": "Number of Days",
"example": "31",
"type": "string"
}
}
},
"FixedInterestTerm": {
"properties": {
"interestYears": {
"description": "Number of Years",
"example": "4",
"type": "string"
},
"interestMonths": {
"description": "Number of Months",
"example": "12",
"type": "string"
},
"interestDays": {
"description": "Number of Days",
"example": "31",
"type": "string"
}
}
},
"DrawingsRequests": {
"properties": {
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsRequest"
}
}
}
},
"DrawingsRequest": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"drawingId": {
"description": "Unique Identifier of drawing",
"example": "F20221234567-01",
"type": "string"
},
"productId": {
"description": "productType of drawing",
"example": "Mortgage Facilities",
"type": "string"
},
"drawingName": {
"description": "Name of the drawing created for the facility",
"example": "First Installment",
"type": "string"
},
"drawingType": {
"description": "Drawing Type",
"example": "01",
"type": "string",
"x-referencetype": "DrawingType"
},
"mortgageType": {
"description": "Mortgage Type",
"example": "01",
"type": "string",
"x-referencetype": "MortgageType"
},
"requestAmount": {
"description": "Request Amount",
"example": "50000",
"type": "string"
},
"term": {
"allOf": [
{
"$ref": "#/components/schemas/DrawingsTerm"
}
]
},
"fixedInterestTerm": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestTerm"
}
]
},
"approvedAmount": {
"description": "Approved Amount",
"example": "12",
"type": "string"
},
"currencyId": {
"description": "Currency in which the Drawing is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"startDate": {
"description": "Date from which the drawing is effective",
"type": "string",
"format": "date"
},
"maturityDate": {
"description": "Maturity of the drawing",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedDrawingsResponse": {
"properties": {
"drawingId": {
"description": "Id of the drawing created for a Facility",
"example": "F202012345678-01",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"DrawingsResponses": {
"properties": {
"drawings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DrawingsResponse"
}
}
}
},
"DrawingsResponse": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"drawingId": {
"description": "Unique Identifier of drawing",
"example": "F20221234567-01",
"type": "string"
},
"productId": {
"description": "productType of drawing",
"example": "Mortgage Facilities",
"type": "string"
},
"drawingName": {
"description": "Name of the drawing created for the facility",
"example": "First Installment",
"type": "string"
},
"drawingType": {
"description": "Drawing Type",
"example": "Initial",
"type": "string"
},
"mortgageType": {
"description": "Mortgage Type",
"example": "01",
"type": "string"
},
"requestAmount": {
"description": "Request Amount",
"example": "50000",
"type": "string"
},
"term": {
"allOf": [
{
"$ref": "#/components/schemas/DrawingsTerm"
}
]
},
"fixedInterestTerm": {
"allOf": [
{
"$ref": "#/components/schemas/FixedInterestTerm"
}
]
},
"approvedAmount": {
"description": "Approved Amount",
"example": "50000",
"type": "string"
},
"currencyId": {
"description": "Currency in which the drawing is executed",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"coreRefrenceType": {
"description": "Arrangement or Limit",
"example": "Arrangement",
"type": "string"
},
"coreRefrenceId": {
"description": "Arrangement or Limit ID",
"example": "AAA32123455666",
"type": "string"
},
"startDate": {
"description": "Date from which the drawing is effective",
"type": "string",
"format": "date"
},
"maturityDate": {
"description": "Maturity of the drawing",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"RemortgageInfoRequests": {
"properties": {
"remortgageInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemortgageInfoRequest"
}
}
}
},
"RemortgageInfoRequest": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"outStandingLoanAmount": {
"description": "Outstanding Loan Amount",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"outStandingLoanCurrencyId": {
"description": "Currency in which the Outstanding Loan Amount is taken",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"remortgageReason": {
"description": "Reason for Re-Mortgage",
"example": "01",
"type": "string",
"x-referencetype": "RemortgageReason"
},
"additionalLoanRequired": {
"description": "Flag for additional loan amount requirement",
"example": true,
"type": "boolean"
},
"additionalLoanAmount": {
"description": "Additional Loan Amount",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"additionalLoanCurrencyId": {
"description": "Currency in which the Additional Loan Amount is requested",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"additionalLoanAmountPurpose": {
"description": "Purpose for additional loan amount",
"example": "01",
"type": "string",
"x-referencetype": "AdditionalLoanAmountPurpose"
},
"bankDetails": {
"allOf": [
{
"$ref": "#/components/schemas/OtherBankDetails"
}
]
},
"lastInstallmentDate": {
"description": "Last Installment Date",
"type": "string",
"format": "date"
},
"outStandingAmountDate": {
"description": "OutStanding Amount Date",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedRemortgageInfoResponse": {
"properties": {
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"RemortgageInfoResponses": {
"properties": {
"remortgageInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RemortgageInfoResponse"
}
}
}
},
"RemortgageInfoResponse": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"outStandingLoanAmount": {
"description": "Outstanding Loan Amount",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"outStandingLoanCurrencyId": {
"description": "Currency in which the Outstanding Loan Amount is taken",
"example": "USD",
"type": "string"
},
"remortgageReason": {
"description": "Reason for Re-Mortgage",
"example": "01",
"type": "string"
},
"additionalLoanRequired": {
"description": "Flag for additional loan amount requirement",
"example": true,
"type": "boolean"
},
"additionalLoanAmount": {
"description": "Additional Loan Amount",
"example": 10250000,
"type": "integer",
"format": "decimal"
},
"additionalLoanCurrencyId": {
"description": "Currency in which the Additional Loan Amount is requested",
"example": "USD",
"type": "string",
"x-referencetype": "Currency"
},
"additionalLoanAmountPurpose": {
"description": "Purpose for additional loan amount",
"example": "01",
"type": "string"
},
"bankDetails": {
"allOf": [
{
"$ref": "#/components/schemas/OtherBankDetails"
}
]
},
"lastInstallmentDate": {
"description": "Last Installment Date",
"type": "string",
"format": "date"
},
"outStandingAmountDate": {
"description": "OutStanding Amount Date",
"type": "string",
"format": "date"
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ScheduleDetail": {
"properties": {
"dueAmount": {
"description": "Amount due for the schedule",
"example": "666.67",
"type": "string"
},
"paymentTypeName": {
"description": "Payment Type Name",
"example": "Linear Principal",
"type": "string"
},
"property": {
"description": "Property",
"example": "Account",
"type": "string"
},
"propertyAmount": {
"description": "Amount of the property",
"example": "666.67",
"type": "string"
}
}
},
"SimulationItem": {
"properties": {
"dueDate": {
"description": "Due date of the simulation",
"example": "15/04/21",
"type": "string"
},
"totalPayment": {
"description": "Total payment of the simulation",
"example": "1,513.15",
"type": "string"
},
"outstandingAmount": {
"description": "Outstanding Amount of the simulations",
"example": "1,666.66",
"type": "string"
},
"scheduleDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleDetail"
}
}
}
},
"PaymentScheduleRequests": {
"properties": {
"paymentSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleRequest"
}
}
}
},
"PaymentScheduleRequest": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"drawingId": {
"description": "Unique Identifier of drawing",
"example": "F20221234567-01",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the request",
"example": "F20221234567",
"type": "string"
},
"scheduleId": {
"description": "Unique identifier of the request",
"example": "SH20221234567",
"type": "string"
},
"simulationType": {
"description": "Simulation Type",
"example": "01",
"type": "string",
"x-referencetype": "SimulationType"
},
"simulations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimulationItem"
}
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ProcessedPaymentScheduleResponse": {
"properties": {
"scheduleId": {
"description": "Id of the paymentSchedule created for a Drawing",
"example": "SH202012345678",
"type": "string"
},
"status": {
"type": "string",
"description": "Specifies status of the request",
"example": "Success"
},
"message": {
"type": "string",
"description": "Specifies the text that provide more details"
}
}
},
"PaymentScheduleResponses": {
"properties": {
"paymentSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleResponse"
}
}
}
},
"PaymentScheduleResponse": {
"properties": {
"facilityId": {
"description": "ID of the facility",
"example": "F20221234567",
"type": "string"
},
"drawingId": {
"description": "Unique Identifier of drawing",
"example": "F20221234567-01",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the request",
"example": "F20221234567",
"type": "string"
},
"scheduleId": {
"description": "Unique identifier of the request",
"example": "SH20221234567",
"type": "string"
},
"simulationType": {
"description": "Simulation Type",
"example": "01",
"type": "string"
},
"simulations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimulationItem"
}
},
"lastChangeUserId": {
"description": "ID of the user who made the last change",
"example": "A123",
"type": "string"
},
"lastChangeDateTime": {
"description": "Date when the Drawing details was last changed",
"type": "string",
"format": "date"
},
"extensionData": {
"type": "object"
}
}
},
"ConsentData": {
"properties": {
"consents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsentItem"
}
}
}
},
"ConsentItem": {
"properties": {
"requestId": {
"description": "Unique identifier of the request",
"example": "R02035292905",
"type": "string"
},
"partyId": {
"description": "Unique Identifier of Party",
"example": "2132129222",
"type": "string"
},
"retentionPeriod": {
"description": "Number of days before consent should expire",
"example": "30",
"type": "string"
},
"consentId": {
"description": "Unique Identifier of consentId",
"example": "CST2132129222",
"type": "string"
},
"consentIdentifier": {
"description": "Consent Code",
"example": "Onboarding_Disclaimer",
"type": "string"
},
"acceptanceStatus": {
"description": "Acceptance status of the consent",
"example": true,
"type": "boolean"
},
"createdDate": {
"description": "Date when the consent is accepted by the user",
"type": "string",
"format": "date"
},
"expiryDate": {
"description": "Expiry Date of the consent",
"type": "string",
"format": "date"
},
"externalReferenceId": {
"description": "External Reference Id",
"example": "QWERD32",
"type": "string"
},
"versionId": {
"description": "Version Id of the consent",
"example": "1.0",
"type": "string"
},
"termsNConditionContentId": {
"description": "termsNConditionContentId of the consent",
"example": "TCC12345",
"type": "string"
},
"termsNConditionCodeId": {
"description": "termNConditionCodeId of the consent",
"example": "TE7645",
"type": "string"
},
"consentProvider": {
"description": "Name of the party who accepted the consent",
"example": "ABC corporation",
"type": "string"
},
"appliesTo": {
"description": "consent applies to which category",
"example": "Application",
"type": "string"
},
"extensionData": {
"type": "object"
}
}
}
}
}
}
,
dom_id: "#swagger-ui5",
presets: [
SwaggerUIBundle.presets.apis,
]
})
</script> |
|
|