{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula CreditAssessment Query", "description": "**CreditAssessment Query API**:\n\n
CreditAssessment Query API retrieves creditassessments and aggregates.\n\n
**CreditAssessment Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/creditassessmentquery" } ], "paths": { "/api/auto": { "get": { "tags": [ "AutomatedCreditAssessment" ], "summary": "Get all Automated Credit Assessment Enquiries.", "description": "\nThis method returns all Automated Credit Assessment Enquiries for given tenant

Required permissions:
Following permissions are required: AutomatedCreditAssessmentAccess", "operationId": "GetAutomatedCreditAssessments", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of AutomatedCreditAssessments is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomatedCreditAssessmentDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/auto/{id}": { "get": { "tags": [ "AutomatedCreditAssessment" ], "summary": "Get an Automated Credit Assessment Enquiry by Id.", "description": "\nThis method returns the Automated Credit Assessment for given id.

Required permissions:
Following permissions are required: AutomatedCreditAssessmentAccess", "operationId": "GetAutomatedCreditAssessmentById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An automated credit assessment details is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomatedCreditAssessmentDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/auto/{id}/snapshot": { "get": { "tags": [ "AutomatedCreditAssessment" ], "summary": "Get an Automated Credit Assessment Enquiry Snapshot by Automated Credit Assessment Enquiry Id.", "description": "\nThis method returns the Automated Credit Assessment Enquiry Snapshot for given id.

Required permissions:
Following permissions are required: AutomatedCreditAssessmentAccess", "operationId": "GetAutomatedCreditAssessmentSnapshotById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An automated credit assessment snapshot details is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoCreditAssessmentEnquirySnapshotDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/auto/entity/{entityId}/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "AutomatedCreditAssessment" ], "summary": "Get an Automated Credit Assessment by Entity, Journey and Task Id.", "description": "\nThis method returns the Automated Credit Assessment for given id.

Required permissions:
Following permissions are required: AutomatedCreditAssessmentAccess", "operationId": "GetAutomatedCreditAssessmentByEntityJourneyTaskId", "parameters": [ { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An automated credit assessment details is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomatedCreditAssessmentDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/auto/journey/{journeyId}": { "get": { "tags": [ "AutomatedCreditAssessment" ], "summary": "Get an Automated Credit Assessment by Journey Id.", "description": "\nThis method returns the Automated Credit Assessment for given journey id.

Required permissions:
Following permissions are required: AutomatedCreditAssessmentAccess", "operationId": "GetAutomatedCreditAssessmentByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An automated credit assessment details is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomatedCreditAssessmentDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/creditassessment/set/{setId}": { "get": { "tags": [ "CreditAssessment" ], "summary": "Get a Credit Assessment Set with all and latest version of credit assessments", "description": "\nReturns the Credit Assessment Set for the specified ID

Required permissions:
Following permissions are required: CreditAssessmentAccess", "operationId": "GetCreditAssessmentSetById", "parameters": [ { "name": "setId", "in": "path", "description": "The id of the Credit Assessment Set to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Credit Assessment Set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentSetDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Credit Assessment Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/creditassessment/set/journey/{journeyId}": { "get": { "tags": [ "CreditAssessment" ], "summary": "Get a Credit Assessment Set with all and latest version of credit assessments by JourneyId", "description": "\nReturns the Credit Assessment Set for the specified Journey ID

Required permissions:
Following permissions are required: CreditAssessmentAccess", "operationId": "GetCreditAssessmentSetByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "description": "The Journey Id of the Credit Assessment Set to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Credit Assessment set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentSetDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. A Credit Assessment set for the given journey id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/creditassessment/assessment/{assessmentId}": { "get": { "tags": [ "CreditAssessment" ], "summary": "Get a Credit Assessment by Id", "description": "\nReturns the Credit Assessment for the specified ID with latest version

Required permissions:
Following permissions are required: CreditAssessmentAccess", "operationId": "GetCreditAssessmentById", "parameters": [ { "name": "assessmentId", "in": "path", "description": "The id of the Credit Assessment to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Credit Assessment is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Credit Assessment with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/creditassessment/assessment/task/{taskId}": { "get": { "tags": [ "CreditAssessment" ], "summary": "Get a Credit Assessment by Task Id", "description": "\nReturns the Credit Assessment for the specified Task ID with latest version

Required permissions:
Following permissions are required: CreditAssessmentAccess", "operationId": "GetCreditAssessmentByTaskId", "parameters": [ { "name": "taskId", "in": "path", "description": "The corresponding task id of the Credit Assessment to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Credit Assessment is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Credit Assessment for given Task id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/creditassessment/assessment/{assessmentId}/version/{versionNumber}/snapshot": { "get": { "tags": [ "CreditAssessment" ], "summary": "Get a Credit Assessment Snapshot by creditAssessmentId and versionNumber", "description": "\nReturns a Credit Assessment Snapshot by creditAssessmentId and versionNumber

Required permissions:
Following permissions are required: CreditAssessmentAccess", "operationId": "GetCreditAsssessmentSnapshot", "parameters": [ { "name": "assessmentId", "in": "path", "description": "The credit assessment id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The credit assessment version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Credit Assessment Snapshot is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Credit Assessment Snapshot cannot be found.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/creditassessment/journey/{journeyId}/history": { "get": { "tags": [ "CreditAssessment" ], "summary": "Get a Credit Assessment History by journeyId", "description": "\nReturns a Credit Assessment History by journeyId

Required permissions:
Following permissions are required: CreditAssessmentAccess, AutomatedCreditAssessmentAccess", "operationId": "GetHistoryByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "description": "The credit assessment journeyId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. History is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. History cannot be found.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/creditassessment/task/{taskId}/historysnapshot": { "get": { "tags": [ "CreditAssessment" ], "summary": "Get a Credit Assessment History Snapshot by taskId", "description": "\nReturns a Credit Assessment History Snapshot by taskId

Required permissions:
Following permissions are required: CreditAssessmentAccess, AutomatedCreditAssessmentAccess", "operationId": "GetHistorySnapshotByTaskId", "parameters": [ { "name": "taskId", "in": "path", "description": "The credit assessment taskId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. History Snapshot is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. History Snapshot cannot be found.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get all Automated Credit Assessment Providers.", "description": "\nThis method returns all Automated Credit Assessment Providers for given tenant

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetAllCreditAssessmentProviders", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of AutomatedCreditAssessments is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentProviderDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/{providerId}": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get Automated Credit Assessment Providers by Id.", "description": "\nThis method returns the Automated Credit Assessment Providers for given provider id.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetCreditAssessmentProvidersById", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An Automated Credit Assessment provider is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentProviderDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/configurations": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get all Automated Credit Assessment Providers Configurations.", "description": "\nThis method returns all Automated Credit Assessment Providers Configuration for given tenant

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetAllCreditAssessmentProvidersConfiguration", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of AutomatedCreditAssessments is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/{providerId}/configuration": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get Automated Credit Assessment Providers by Id.", "description": "\nThis method returns the Automated Credit Assessment Providers for given provider id.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetProviderConfigurationById", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An Automated Credit Assessment provider is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/mappingconfigurations": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get all Automated Credit Assessment Providers Mapping Configurations.", "description": "\nThis method returns all Automated Credit Assessment Mapping Configuration for given tenant

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetAllMappingConfiguration", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of Mapping Configuration is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/{providerId}/mappingconfiguration": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get Automated Credit Assessment Mapping Configuration by Provider Id.", "description": "\nThis method returns the Automated Credit Assessment Mapping Configuration for given provider id.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetMappingConfigurationByProviderId", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. An Automated Credit Assessment mapping configuration is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/adapterSchemas": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get all Automated Credit Assessment Providers Adapter Schemas.", "description": "\nThis method returns all Automated Credit Assessment Adapter Schema for given tenant

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetAllAdapterSchema", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of Adapter Schema is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/{providerId}/adapterSchema": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get Automated Credit Assessment Adapter Schema by Provider Id.", "description": "\nThis method returns the Automated Credit Assessment Adapter Schema for given provider id.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetAdapterSchema", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "200": { "description": "Success. An Automated Credit Assessment adapter schema is returned" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/{providerId}/test": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Get a test result for a Provider by Provider Id", "description": "\nThis method returns the Provider Test Result for given Provider Id.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetProviderTestResult", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Provider Test Result is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderTestResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/{providerId}/configurationSummary": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Gets a summarised result of the statuses associated with a provider.", "description": "\nThis method returns a summary of the provider which includes details about the provider itself,\r\n\nthe configuration, mapping configuration and adapter schema statues for given Provider Id.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetCreditAssessmentProviderConfigurationSummaryByProviderId", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Configuration Summary is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } }, "/api/providers/configurationSummaries": { "get": { "tags": [ "CreditAssessmentProvider" ], "summary": "Gets a summarised result of the statuses associated with a provider.", "description": "\nThis method returns summaries of all providers which includes details about the providers themselves,\r\n\nthe configuration, mapping configuration and adapter schema statues.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess", "operationId": "GetCreditAssessmentProviderConfigurationSummaries", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A list of Configuration Summaries is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "Error Code" } ] } } } } } } } }, "components": { "schemas": { "AdapterConfigurationDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdapterSchemaDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the schema", "format": "uuid" }, "providerId": { "type": "string", "description": "Provider Id of the schema", "format": "uuid" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/SchemaDto" } ], "description": "The schema contains request and result schema", "nullable": true } }, "additionalProperties": false, "description": "Adapter Configuration Schema" }, "AdapterSchemaDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdapterSchemaDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AdapterSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AdapterSchemaDto" } ], "description": "Adapter Configuration Schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentEnquirySnapshotDto": { "type": "object", "properties": { "autoCreditAssessmentEnquiryId": { "type": "string", "format": "uuid" }, "mappingConfiguration": { "allOf": [ { "$ref": "#/components/schemas/MappingConfigurationDto" } ], "description": "Mapping Configuration Schema", "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentEnquirySnapshotDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditAssessmentEnquirySnapshotDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AutomatedCreditAssessmentDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity id of automated credit assessment", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "id": { "type": "string", "description": "Id of automated credit assessment", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "name": { "type": "string", "description": "Name of automated credit assessment", "nullable": true, "example": "Automated Credit Assessment" }, "journeyId": { "type": "string", "description": "Journey Id which automated credit assessment belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id which automated credit assessment belongs", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "providerId": { "type": "string", "description": "Provider Id which automated credit assessment is referring to", "format": "uuid", "example": "58dcd00d-8a44-4de8-9fce-3c5be46675c2" }, "providerInternalIdentifier": { "type": "string", "description": "A unique identifier for the provider.", "nullable": true }, "searchCriteria": { "description": "Schema that contains attributes to be used for automated credit assessment", "nullable": true }, "enquiryResult": { "allOf": [ { "$ref": "#/components/schemas/EnquiryResult" } ], "description": "Results for automated credit assessment", "nullable": true } }, "additionalProperties": false }, "AutomatedCreditAssessmentDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedCreditAssessmentDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AutomatedCreditAssessmentDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AutomatedCreditAssessmentDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "nullable": true }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "nullable": true }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreditApproverDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Credit Approver identifier", "nullable": true, "example": "41e1dfa3-9e93-467d-8fdb-7ae0aecea913" }, "order": { "type": "integer", "description": "Number indicating which order the approver will make a decision in", "format": "int32", "example": 1 }, "role": { "type": "string", "description": "Role/Team the approver belongs to", "nullable": true, "example": "Relationship Manager 1" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Credit Approver metadata", "nullable": true } }, "additionalProperties": false, "description": "DTO representing Credit Approver data" }, "CreditAssessmentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Credit Decision identifier", "format": "uuid", "example": "cc91d893-7643-433a-9b7c-00813178dc76" }, "setId": { "type": "string", "description": "Identifier of the set this Credit Decision belongs to", "format": "uuid", "example": "78e59d67-9f80-4f5a-b25a-036d603cb37e" }, "taskId": { "type": "string", "description": "Identifier of the Credit Decision task", "format": "uuid", "example": "53eeadd4-b177-451f-9a78-0311b52b3e72" }, "taskDataKey": { "type": "string", "description": "Task DataKey", "nullable": true, "example": "ket one" }, "name": { "type": "string", "description": "Name of this Credit Assessment", "nullable": true, "example": "Name" }, "version": { "allOf": [ { "$ref": "#/components/schemas/CreditAssessmentVersionDto" } ], "description": "Request DTO containing latest credit decision version data", "nullable": true }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentVersionDto" }, "description": "All versions for the current credit assessment", "nullable": true } }, "additionalProperties": false, "description": "DTO representing Credit Decision data" }, "CreditAssessmentDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreditAssessmentDto" } ], "description": "DTO representing Credit Decision data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditAssessmentProviderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Credit Assessment Provider UiD", "format": "uuid", "example": "e381900c-cd27-4024-ad84-52145f0bea4e" }, "name": { "type": "string", "description": "Provider Name", "nullable": true, "example": "Experian Test" }, "enabled": { "type": "boolean", "description": "Flag to check if provider is Eanbled or not", "example": false }, "isCustom": { "type": "boolean", "description": "Flag to initialise if provider is customised or not", "example": false }, "internalIdentifier": { "type": "string", "description": "The internal identifier for a provider", "nullable": true, "example": "equifax-sample" } }, "additionalProperties": false, "description": "Provider Schema" }, "CreditAssessmentProviderDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentProviderDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditAssessmentProviderDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreditAssessmentProviderDto" } ], "description": "Provider Schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditAssessmentSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Credit Decision Set identifier", "format": "uuid", "example": "661cbc05-4a6d-4d08-aaed-a9d334e9ad9c" }, "journeyId": { "type": "string", "description": "Journey Id which the Credit Decision set belongs to", "format": "uuid", "example": "549bfca3-1cc0-4186-b4c3-751be5fc2ced" }, "status": { "type": "string", "description": "Status of the Credit Decision set", "nullable": true, "example": "Verified" }, "created": { "type": "string", "description": "Date and time that the set was created", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "creditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentDto" }, "description": "List of Credit Decisions in set", "nullable": true } }, "additionalProperties": false, "description": "DTO representing Credit Decision set data" }, "CreditAssessmentSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreditAssessmentSetDto" } ], "description": "DTO representing Credit Decision set data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditAssessmentVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Credit Assessment version", "format": "uuid", "example": "7f637116-814a-4430-b924-1d56ed024fc3" }, "versionNumber": { "type": "integer", "description": "Version number of the credit assessment", "format": "int32" }, "status": { "type": "string", "description": "Status of the Credit Assessment version", "nullable": true, "example": "Verified" }, "assessmentOutcome": { "type": "string", "description": "Credit approval decision made by the approver", "nullable": true, "example": "Recommended" }, "assessmentComment": { "type": "string", "description": "Credit approval decision made by the approver", "nullable": true, "example": "Recommended" }, "supportingDocuments": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of IDs of the documents provided for consideration when determining credit assessment", "nullable": true }, "integrationProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Response from integrated credit providers", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Credit Assessment metadata", "nullable": true }, "groupProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GroupDto" }, "description": "Credit Decision for grouped metadata", "nullable": true }, "approver": { "allOf": [ { "$ref": "#/components/schemas/CreditApproverDto" } ], "description": "Approver chosen to review this credit assessment", "nullable": true }, "created": { "type": "string", "description": "Date and time that the Credit Assessment was created", "format": "date-time", "example": "2020-01-01T20:00:00.000Z" }, "lastUpdated": { "type": "string", "description": "Date and time that the Credit Assessment was last updated", "format": "date-time", "example": "2021-01-01T22:00:00.000Z" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions for entity", "nullable": true } }, "additionalProperties": false, "description": "DTO representing Credit Assessment version data" }, "DateLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "EnquiryResult": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "providerName": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "expiry": { "type": "string", "format": "date-time", "nullable": true }, "requestedBy": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "resultOutcome": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "isCompleted": { "type": "boolean", "readOnly": true }, "isInProgress": { "type": "boolean", "readOnly": true }, "isFailed": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ExternalProviderRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "FieldDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "" }, "friendlyName": { "type": "string", "description": "Friendly name of the field\r\nFor display purpose", "nullable": true, "example": "" }, "isMandatory": { "type": "boolean", "description": "The flag to set if property is mandatory" }, "type": { "type": "string", "description": "Type of the field", "nullable": true, "example": "String" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "Address line 1" }, "nestedFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "description": "Nested field", "nullable": true } }, "additionalProperties": false, "description": "The Field schema" }, "GroupDto": { "type": "object", "properties": { "sets": { "type": "array", "items": { "$ref": "#/components/schemas/GroupSetDto" }, "description": "A collection of sets of items to be used for grouped data.", "nullable": true } }, "additionalProperties": false }, "GroupRequirement": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "primaryDataGroupField": { "type": "string", "nullable": true }, "snapshotPropertyItems": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRequirementItem" }, "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "GroupRequirementItem": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "valueType": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "isAdditionalField": { "type": "boolean" }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "GroupSetDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupSetItemDto" }, "description": "A collection of items.", "nullable": true } }, "additionalProperties": false }, "GroupSetItemDto": { "type": "object", "properties": { "key": { "type": "string", "description": "The dataKey of the item", "nullable": true }, "value": { "type": "string", "description": "Value of the item", "nullable": true }, "valueType": { "type": "string", "description": "The type of the value of the item.", "nullable": true }, "separator": { "type": "string", "description": "The separator character to be used for grouping multiple values.", "nullable": true } }, "additionalProperties": false, "description": "An individual item from a group." }, "HistoryDto": { "type": "object", "properties": { "historyItems": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryItemDto" }, "description": "A list of all history items for a given criteria. To represent automated and manual credit assessments.", "nullable": true } }, "additionalProperties": false }, "HistoryDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/HistoryDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "HistoryItemDto": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryVersionDto" }, "description": "All versions for a given credit assessment.", "nullable": true } }, "additionalProperties": false }, "HistoryVersionDto": { "type": "object", "properties": { "assessmentId": { "type": "string", "description": "The Id of the credit assessment", "nullable": true }, "taskName": { "type": "string", "description": "The name of the credit assessment task", "nullable": true }, "versionNumber": { "type": "integer", "description": "The version number / order of the credit assessment", "format": "int32" }, "assessmentOutcome": { "type": "string", "description": "The assessment outcome for the credit assessment", "nullable": true }, "assessmentComment": { "type": "string", "description": "The assessment comment for the credit assessment", "nullable": true }, "type": { "type": "string", "description": "The credit assessment type. \"Automated\" or \"Manual\"", "nullable": true }, "completedOn": { "type": "string", "description": "The datetime the credit assessment was completed on", "format": "date-time", "nullable": true }, "approverRole": { "type": "string", "description": "The role of the credit assessment approver. For Automated credit assessments this will be \"System\"", "nullable": true }, "approverId": { "type": "string", "description": "The Id of the approver of the task. Only for manual credit assessment", "nullable": true }, "providerName": { "type": "string", "description": "The name of the provider the assessment data was obtained from. Only for automated credit assessment", "nullable": true } }, "additionalProperties": false }, "MappingConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "providerId": { "type": "string", "format": "uuid" }, "initiateAutomatedCreditAssessmentRequest": { "allOf": [ { "$ref": "#/components/schemas/MappingDto" } ], "description": "The mapping configuration request schema for request", "nullable": true }, "initiateAutomatedCreditAssessmentResult": { "allOf": [ { "$ref": "#/components/schemas/MappingDto" } ], "description": "The mapping configuration result schema for request", "nullable": true } }, "additionalProperties": false, "description": "Mapping Configuration Schema" }, "MappingConfigurationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MappingConfigurationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "MappingConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MappingConfigurationDto" } ], "description": "Mapping Configuration Schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "MappingDto": { "type": "object", "properties": { "ruleSets": { "type": "array", "items": { "$ref": "#/components/schemas/MappingRuleSetDto" }, "description": "The list that contains all the mapping rules for a provider\r\nIt can be for request or result mapping configuration", "nullable": true } }, "additionalProperties": false, "description": "The schema for mapping configuration request and result" }, "MappingRuleDto": { "type": "object", "properties": { "order": { "type": "integer", "description": "This order will be used to generate mapping Path", "format": "int32" }, "propertyName": { "type": "string", "description": "Property Name", "nullable": true }, "isArrayProperty": { "type": "boolean" }, "includingNestedPath": { "type": "boolean", "description": "If true, it will find all properties (including nested properties) with this Property Name" } }, "additionalProperties": false, "description": "The mapping rule schema" }, "MappingRuleSetDto": { "type": "object", "properties": { "mappingRules": { "type": "array", "items": { "$ref": "#/components/schemas/MappingRuleDto" }, "description": "The list that contains all of the mapping rules", "nullable": true }, "targetProperty": { "type": "string", "description": "The targetProperty for mapping destination", "nullable": true, "example": "address" }, "targetPropertyFriendlyName": { "type": "string", "description": "The targetProperty friendly name for display", "nullable": true, "example": "address" }, "nestedMappingRules": { "allOf": [ { "$ref": "#/components/schemas/MappingDto" } ], "description": "The nested mapping rules for mapping a nested object", "nullable": true }, "targetPropertyType": { "type": "string", "description": "The type of the targetProperty", "nullable": true, "example": "String" } }, "additionalProperties": false, "description": "The schema that contains info of designated property" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "PropertyDto": { "type": "object", "properties": { "type": { "type": "string", "description": "The property Type", "nullable": true, "example": "Single" }, "discriminator": { "type": "string", "description": "The property discriminator", "nullable": true, "example": "Single" }, "value": { "type": "string", "description": "The property value", "nullable": true, "example": "Australia" } }, "additionalProperties": false, "description": "Defines the metadata type" }, "ProviderConfigurationDetailsDto": { "type": "object", "properties": { "description": { "type": "string", "description": "Configuration property description", "nullable": true, "example": "Address line 1" }, "friendlyName": { "type": "string", "description": "The display name for the property", "nullable": true, "example": "Address" }, "mandatory": { "type": "boolean", "description": "Flag to set if property is mandatory", "example": false }, "name": { "type": "string", "description": "Name", "nullable": true, "example": "Address" }, "type": { "type": "string", "description": "The tpye of the property", "nullable": true, "example": "String" }, "value": { "type": "string", "description": "The value of the property", "nullable": true, "example": "George Street" }, "maskRequired": { "type": "boolean", "description": "Flag to set if property needs to be masked", "example": false } }, "additionalProperties": false, "description": "Provider Configuration Schema" }, "ProviderConfigurationDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "Provider Id", "format": "uuid" }, "configurationList": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigurationDetailsDto" }, "description": "List of Configuration Details Schema", "nullable": true }, "adapterConfiguration": { "allOf": [ { "$ref": "#/components/schemas/AdapterConfigurationDto" } ], "description": "Schema of Adapter Configuration", "nullable": true }, "providerConfigurationSecurityKeys": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationSecurityKeysDto" } ], "description": "Configuration keys for provider", "nullable": true } }, "additionalProperties": false, "description": "Provider Configuration top layer schema" }, "ProviderConfigurationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigurationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationDto" } ], "description": "Provider Configuration top layer schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSecurityKeysDto": { "type": "object", "properties": { "authenticationKey": { "type": "string", "nullable": true }, "encryptionKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSummaryDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" }, "mappingStatus": { "type": "string", "nullable": true }, "adapterStatus": { "type": "string", "nullable": true }, "authenticationStatus": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "isCustom": { "type": "boolean" }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSummaryDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSummaryDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationSummaryDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderTestResultDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the Provider being tested.", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "tenantId": { "type": "string", "description": "Id of the Tenant", "nullable": true, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" }, "status": { "type": "string", "description": "The validation status.", "nullable": true, "example": "Completed" } }, "additionalProperties": false, "description": "Provider Test Result" }, "ProviderTestResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderTestResultDto" } ], "description": "Provider Test Result", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RegexRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Requirement": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32", "nullable": true }, "separator": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "SchemaDto": { "type": "object", "properties": { "initiateAutomatedCreditAssessmentRequest": { "allOf": [ { "$ref": "#/components/schemas/SchemaEntryDto" } ], "description": "Adapter Configuration request schema \r\nIt contains list of fields", "nullable": true }, "initiateAutomatedCreditAssessmentResult": { "allOf": [ { "$ref": "#/components/schemas/SchemaEntryDto" } ], "description": "Adapter Configuration result schema \r\nIt contains list of fields", "nullable": true } }, "additionalProperties": false, "description": "Adapter Configuration Schema Detail" }, "SchemaEntryDto": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "description": "The list of all Fields", "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SnapshotSet": { "type": "object", "properties": { "creditAssessmentId": { "type": "string", "description": "Credit Assessment Id", "format": "uuid", "example": "cc91d893-7643-433a-9b7c-00813178dc76" }, "versionNumber": { "type": "integer", "description": "Version number of the credit assessment", "format": "int32", "example": 1 }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/Requirement" }, "description": "List of requirements", "nullable": true }, "assessmentOutcome": { "allOf": [ { "$ref": "#/components/schemas/Requirement" } ], "description": "Rquirements for assessment outcome", "nullable": true }, "groupRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRequirement" }, "description": "List of Group Requirements", "nullable": true } }, "additionalProperties": false }, "SnapshotSetServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SnapshotSet" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "ValidationRuleDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "setId": { "type": "string", "format": "uuid" }, "propertyId": { "type": "string", "format": "uuid" }, "dataGroupId": { "type": "string", "format": "uuid", "nullable": true }, "isDataGroup": { "type": "boolean" }, "propertyName": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "validationType": { "type": "string", "nullable": true }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "VersionedJurisdictionDto": { "type": "object", "properties": { "jurisdiction": { "type": "string", "description": "Jurisdiction Name", "nullable": true, "example": "Global" }, "versionId": { "type": "string", "description": "Jurisdiction Version Id", "format": "uuid", "example": "254428e9-d232-4738-81c9-151409b296a3" } }, "additionalProperties": false, "description": "Defines the jurisdiction requirement for the credit assessment" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }