{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula CreditAssessment Command", "description": "**CreditAssessment Command API**:\n\n
Credit Assessment Command API provides both configurational and operational methods related to the client's credit assessments. Use the Credit Assessment Command API to create, update and delete credit assessments and related aggregates. Use the Query API to retrieve credit assessments and other related aggregates.\n\n
**CreditAssessment Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/creditassessmentcommand" } ], "paths": { "/api/auto": { "post": { "tags": [ "AutomatedCreditAssessment" ], "summary": "Create a new Automated Credit Assessment Enquiry", "description": "

Required permissions:
Following permissions are required: AutomatedCreditAssessmentEdit", "operationId": "AutomatedCreditAssessment", "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" } ], "requestBody": { "description": "The Create Automated Assessment request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomatedCreditAssessmentRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Request created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomatedCreditAssessmentRequestDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "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}": { "delete": { "tags": [ "AutomatedCreditAssessment" ], "summary": "Delete an Automated Credit Assessment Enquiry", "description": "

Required permissions:
Following permissions are required: AutomatedCreditAssessmentDelete", "operationId": "DeleteAutomatedCreditAssessment", "parameters": [ { "name": "id", "in": "path", "description": "The request id that needs to be updated", "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": "Success. Batch created" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "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": { "post": { "tags": [ "CreditAssessment" ], "summary": "Create a Credit Assessment set", "description": "\nCreates a new Credit Assessment set which is tied to a specific journey

Required permissions:
Following permissions are required: CreditAssessmentEdit", "operationId": "CreateCreditAssessmentSet", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.CreditAssessment.Command.Application.Dto.CreditAssessmentSet.CreditAssessmentSetRequestDto to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentSetRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Credit Assessment set created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentSetResponseDtoServiceResponse" } } } }, "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/{setId}": { "delete": { "tags": [ "CreditAssessment" ], "summary": "Delete a Credit Assessment set and all of its assessments", "description": "\nDeletes the specified Credit Assessment set and all its assessments

Required permissions:
Following permissions are required: CreditAssessmentDelete", "operationId": "DeleteCreditAssessmentSet", "parameters": [ { "name": "setId", "in": "path", "description": "Credit Assessment set to be deleted", "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": "Success. Credit Assessment set deleted" }, "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. The specified Credit Assessment set 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/{setId}/assessment": { "post": { "tags": [ "CreditAssessment" ], "summary": "Create a new Credit Assessment", "description": "\nThis method creates a new Credit Assessment in the selected Set

Required permissions:
Following permissions are required: CreditAssessmentEdit", "operationId": "CreateCreditAssessment", "parameters": [ { "name": "setId", "in": "path", "description": "Credit Assessment set to create new Credit Assessment in", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.CreditAssessment.Command.Application.Dto.CreditAssessment.CreditAssessmentDto to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Credit Assessment created", "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. The specified Credit Assessment set 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/{setId}/assessment/{assessmentId}/version": { "post": { "tags": [ "CreditAssessment" ], "summary": "Create a new Credit Assessment version", "description": "\nThis method creates a new Credit Assessment version based on the latest existing version\r\n\nA new version can only be created if the status of the latest version is completed or rejected

Required permissions:
Following permissions are required: CreditAssessmentEdit", "operationId": "CreateNewCreditAssessmentVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Credit Assessment set the assessment belongs to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "path", "description": "Credit Assessment to create a new version for", "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": "Success. New Credit Assessment version created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentVersionDtoServiceResponse" } } } }, "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. The specified Credit Assessment set/assessment 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" } ] } } } } } }, "put": { "tags": [ "CreditAssessment" ], "summary": "Update an existing Credit Assessment version", "description": "\nThis method updates a Credit Assessment version\r\n\nThe Credit Assessment version being updated must be in a draft status\r\n\nThe version data must be compliant with validation rules.

Required permissions:
Following permissions are required: CreditAssessmentEdit", "operationId": "UpdateCreditAssessmentVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Credit Assessment set the assessment belongs to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "path", "description": "Credit Assessment set the version belongs to", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.CreditAssessment.Command.Application.Dto.CreditAssessmentVersion.CreditAssessmentVersionDto to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Credit Assessment version updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentVersionDtoServiceResponse" } } } }, "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. The specified Credit Assessment set/assessment/version 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/{setId}/assessment/{assessmentId}/version/{versionNumber}/complete": { "put": { "tags": [ "CreditAssessment" ], "summary": "Complete an existing Credit Assessment version", "description": "

Required permissions:
Following permissions are required: CreditAssessmentEdit", "operationId": "CompleteCreditAssessmentVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Credit Assessment Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "path", "description": "Credit Assessment Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "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": { "202": { "description": "Success. Credit Assessment version updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertiesValidatorResponseServiceResponse" } } } }, "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. The specified Credit Assessment set/assessment/version 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/{setId}/assessment/{assessmentId}/version/{versionNumber}/snapshot": { "post": { "tags": [ "CreditAssessment" ], "summary": "Create a manual credit assessment snapshot", "description": "

Required permissions:
Following permissions are required: CreditAssessmentEdit", "operationId": "CreateCreditAsssessmentSnapshot", "parameters": [ { "name": "setId", "in": "path", "description": "Credit Assessment Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "path", "description": "Credit Assessment Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "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" } ], "requestBody": { "description": "Manual Credit Assessment Snapshot data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceRequest" } } } }, "responses": { "202": { "description": "Success. Credit Assessment version updated", "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. The specified Credit Assessment assessmentId/version 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/providers": { "post": { "tags": [ "CreditAssessmentProvider" ], "summary": "Create a new Automated CreditAssessment Provider", "description": "\nThis method creates new Automated CreditAssessment Provider.\r\n\nThe new provider initializes with the DTO data and is set to disable as default.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationCreate", "operationId": "CreateCreditAssessmentProvider", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentProviderDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentProviderDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "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}": { "put": { "tags": [ "CreditAssessmentProvider" ], "summary": "Update an Automated CreditAssessment Provider", "description": "\nThis method updates an Automated CreditAssessment Provider.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit", "operationId": "UpdateCreditAssessmentProvider", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentProviderDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentProviderDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "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" } ] } } } } } }, "delete": { "tags": [ "CreditAssessmentProvider" ], "summary": "Delete an Automated CreditAssessment Provider", "description": "\nThis method delete an Automated CreditAssessment Provider and associated configurations.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentDelete, CreditAssessmentConfigurationDelete", "operationId": "DeleteCreditAssessmentProvider", "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 for processing" }, "400": { "description": "Invalid request", "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}/enabled": { "put": { "tags": [ "CreditAssessmentProvider" ], "summary": "Update whether an Automated CreditAssessment Provider is enabled", "description": "\nThis method updates whether an Automated CreditAssessment Provider is enabled.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit", "operationId": "UpdateCreditAssessmentProviderEnabled", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentProviderDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAssessmentProviderDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "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}/configuration": { "post": { "tags": [ "CreditAssessmentProvider" ], "summary": "Save a new Automated CreditAssessment Provider Configuration", "description": "\nThis method saves new Automated CreditAssessment Provider Configuration.\r\n\nThe configuration initializes with the DTO data consists a list configuration properties.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationCreate", "operationId": "CreateProviderConfiguration", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "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" } ] } } } } } }, "put": { "tags": [ "CreditAssessmentProvider" ], "summary": "Update an existing Automated CreditAssessment Provider Configuration", "description": "\nThis method update an existing Automated CreditAssessment Provider Configuration.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit", "operationId": "UpdateProviderConfiguration", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "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" } ] } } } } } }, "delete": { "tags": [ "CreditAssessmentProvider" ], "summary": "Delete a new Automated CreditAssessment Provider Configuration", "description": "\nThis method delete existing Automated CreditAssessment Provider Configuration.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentDelete, CreditAssessmentConfigurationDelete", "operationId": "DeleteProviderConfiguration", "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 for processing" }, "400": { "description": "Invalid request", "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}/mappingconfiguration": { "post": { "tags": [ "CreditAssessmentProvider" ], "summary": "Save a new AutomatedCreditAssessment Mapping Configuration", "description": "\nThis method saves new Mapping Configuration.\r\n\nThe new configuration initializes with the DTO data and has the resquest and result\r\n mapping rules stored inside.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationCreate", "operationId": "CreateMappingConfiguration", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "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}/mappingconfiguration/{mappingId}": { "put": { "tags": [ "CreditAssessmentProvider" ], "summary": "Update an existing Automated Credit Assessment Mapping Configuration", "description": "\nThis method updates an existing Mapping Configuration.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit", "operationId": "UpdateMappingConfiguration", "parameters": [ { "name": "mappingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "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" } ] } } } } } }, "delete": { "tags": [ "CreditAssessmentProvider" ], "summary": "Delete an existing Automated Credit Assessment Mapping Configuration", "description": "\nThis method deletes an existing Mapping Configuration.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentDelete, CreditAssessmentConfigurationDelete", "operationId": "DeleteMappingConfiguration", "parameters": [ { "name": "mappingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "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 for processing" }, "400": { "description": "Invalid request", "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}/adapterSchema": { "post": { "tags": [ "CreditAssessmentProvider" ], "summary": "Create a new Adapter Schema", "description": "\nThis method saves new Automated CreditAssessment Provider Adapter Schema.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationCreate", "operationId": "CreateAdapterSchema", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "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}/adapterSchema/{id}": { "put": { "tags": [ "CreditAssessmentProvider" ], "summary": "Update a new Adapter Schema", "description": "\nThis method update an existing Automated CreditAssessment Provider Adapter Schema.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit", "operationId": "UpdateAdapterSchema", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "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" } ] } } } } } }, "delete": { "tags": [ "CreditAssessmentProvider" ], "summary": "Delete an existing Adapter Schema", "description": "\nThis method delete an existing Automated CreditAssessment Provider Adapter Schema.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentDelete, CreditAssessmentConfigurationDelete", "operationId": "DeleteAdapterSchema", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "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}/test": { "post": { "tags": [ "CreditAssessmentProvider" ], "summary": "Test mock adapter endpoint", "description": "\nThis method triggers a mock adapter endpoint.

Required permissions:
At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit, CreditAssessmentConfigurationCreate", "operationId": "ProviderTest", "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 for processing" }, "400": { "description": "Invalid request", "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": { "$ref": "#/components/schemas/SchemaDto" } }, "additionalProperties": false, "description": "Adapter Configuration Schema" }, "AdapterSchemaDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdapterSchemaDto" } }, "additionalProperties": false }, "AdapterSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdapterSchemaDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AutomatedCreditAssessmentRequestDto": { "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" }, "searchCriteria": { "description": "Schema that contains attributes to be used for automated credit Assessment", "nullable": true }, "enquiryResult": { "$ref": "#/components/schemas/EnquiryResult" } }, "additionalProperties": false, "description": "The Credit Automated Assessment Schema" }, "AutomatedCreditAssessmentRequestDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedCreditAssessmentRequestDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AutomatedCreditAssessmentRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomatedCreditAssessmentRequestDto" } }, "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 Credit Decision set this 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 }, "version": { "$ref": "#/components/schemas/CreditAssessmentVersionDto" } }, "additionalProperties": false, "description": "DTO representing Credit Decision data" }, "CreditAssessmentDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditAssessmentDto" } }, "additionalProperties": false }, "CreditAssessmentDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditAssessmentDto" }, "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", "nullable": true, "example": false }, "internalIdentifier": { "type": "string", "description": "The internal identifier for a provider", "nullable": true, "example": "equifax-sample" } }, "additionalProperties": false, "description": "Provider Schema" }, "CreditAssessmentProviderDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditAssessmentProviderDto" } }, "additionalProperties": false }, "CreditAssessmentProviderDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditAssessmentProviderDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditAssessmentRequestDto": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Identifier of the Credit Decision task", "format": "uuid", "example": "53eeadd4-b177-451f-9a78-0311b52b3e72" }, "name": { "type": "string", "description": "Name of this Credit Assessment", "nullable": true, "example": "Credit Assessment Name" }, "taskDataKey": { "type": "string", "description": "Task DataKey", "nullable": true, "example": "Key One" }, "version": { "$ref": "#/components/schemas/CreditAssessmentVersionDto" } }, "additionalProperties": false, "description": "Request DTO containing Credit Decision data for use when creating a new set" }, "CreditAssessmentSetRequestDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "Journey Id which the Credit Decision set belongs to", "format": "uuid", "example": "549bfca3-1cc0-4186-b4c3-751be5fc2ced" }, "creditAssessment": { "$ref": "#/components/schemas/CreditAssessmentRequestDto" } }, "additionalProperties": false, "description": "Request DTO representing Credit Decision set data" }, "CreditAssessmentSetRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditAssessmentSetRequestDto" } }, "additionalProperties": false }, "CreditAssessmentSetResponseDto": { "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" }, "creditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentDto" }, "description": "List of credit assessments", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing Credit Decision set data" }, "CreditAssessmentSetResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditAssessmentSetResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditAssessmentVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the Credit Decision version", "format": "uuid", "example": "7f637116-814a-4430-b924-1d56ed024fc3" }, "versionNumber": { "type": "integer", "description": "Version number", "format": "int32" }, "status": { "type": "string", "description": "Status of the Credit Decision 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 comment 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 decision", "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 Decision metadata", "nullable": true }, "groupProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GroupDto" }, "description": "Credit Decision for grouped metadata", "nullable": true }, "approver": { "$ref": "#/components/schemas/CreditApproverDto" }, "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": "Jurisdiction metadata of Credit Assessment", "nullable": true } }, "additionalProperties": false, "description": "DTO representing Credit Decision version data" }, "CreditAssessmentVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditAssessmentVersionDto" } }, "additionalProperties": false }, "CreditAssessmentVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditAssessmentVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "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": "Address" }, "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", "nullable": true }, "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": { "$ref": "#/components/schemas/ValidationRuleDto" } }, "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": { "$ref": "#/components/schemas/ValidationRuleDto" } }, "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." }, "MappingConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of mapping configuration", "format": "uuid" }, "providerId": { "type": "string", "description": "The corresponding provider id of mapping configuration", "format": "uuid" }, "initiateAutomatedCreditAssessmentRequest": { "$ref": "#/components/schemas/MappingDto" }, "initiateAutomatedCreditAssessmentResult": { "$ref": "#/components/schemas/MappingDto" } }, "additionalProperties": false, "description": "Mapping Configuration Schema" }, "MappingConfigurationDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MappingConfigurationDto" } }, "additionalProperties": false }, "MappingConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MappingConfigurationDto" }, "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", "nullable": true }, "includingNestedPath": { "type": "boolean", "description": "If true, it will find all properties (including nested properties) with this Property Name", "nullable": true } }, "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": { "$ref": "#/components/schemas/MappingDto" }, "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 }, "PolicyValidationResponseError": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "propertyValue": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "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": { } }, "PropertiesValidatorResponse": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyValidationResponseError" }, "nullable": true } }, "additionalProperties": false }, "PropertiesValidatorResponseServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PropertiesValidatorResponse" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "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", "nullable": true, "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", "nullable": true, "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": { "$ref": "#/components/schemas/AdapterConfigurationDto" }, "providerConfigurationSecurityKeys": { "$ref": "#/components/schemas/ProviderConfigurationSecurityKeysDto" } }, "additionalProperties": false, "description": "Provider Configuration top layer schema" }, "ProviderConfigurationDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProviderConfigurationDto" } }, "additionalProperties": false }, "ProviderConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProviderConfigurationDto" }, "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 }, "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": { "$ref": "#/components/schemas/ValidationRuleDto" } }, "additionalProperties": false }, "SchemaDto": { "type": "object", "properties": { "initiateAutomatedCreditAssessmentRequest": { "$ref": "#/components/schemas/SchemaEntryDto" }, "initiateAutomatedCreditAssessmentResult": { "$ref": "#/components/schemas/SchemaEntryDto" } }, "additionalProperties": false, "description": "Adapter Configuration Schema Detail" }, "SchemaEntryDto": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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": { "$ref": "#/components/schemas/Requirement" }, "groupRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRequirement" }, "description": "List of Group Requirements", "nullable": true } }, "additionalProperties": false }, "SnapshotSetServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnapshotSet" } }, "additionalProperties": false }, "SnapshotSetServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnapshotSet" }, "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": { "$ref": "#/components/schemas/BasicRuleDto" }, "specialCharacters": { "$ref": "#/components/schemas/SpecialCharactersRuleDto" }, "noNumbers": { "$ref": "#/components/schemas/BasicRuleDto" }, "onlyInteger": { "$ref": "#/components/schemas/BasicRuleDto" }, "noNegative": { "$ref": "#/components/schemas/BasicRuleDto" }, "onlyDecimal": { "$ref": "#/components/schemas/BasicRuleDto" }, "regex": { "$ref": "#/components/schemas/RegexRuleDto" }, "characterLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "numberLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "noFutureDates": { "$ref": "#/components/schemas/BasicRuleDto" }, "noPastDates": { "$ref": "#/components/schemas/BasicRuleDto" }, "dateLimit": { "$ref": "#/components/schemas/DateLimitRuleDto" }, "multiSelectLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "collectionMinimumCount": { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" }, "collectionMaximumCount": { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" }, "externalProvider": { "$ref": "#/components/schemas/ExternalProviderRuleDto" } }, "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": { "$ref": "#/components/schemas/ValidationDataDto" } }, "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": [ ] } ] }