Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula CreditAssessment Command",
"description": "**CreditAssessment Command API**:\n\n<br> 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<br> **CreditAssessment Command API provides**:<br><ul><li> The ability to perform automated credit assessment for Individual and Company Legal Entities.</li><li> The ability to trigger asynchronous automated credit assessment requests to different providers.</li><li> The ability to create, update, delete related objects of automated credit assessment - Including providers, providers configurations, mapping configurations and adapter schemas.</li><li> The ability to create and update related objects of Manual Credit Assessments. Includes Manual Credit Assessment sets and versions.</li></ul>",
"version": "1.0"
},
"servers": [
{
"url": "/creditassessmentcommand"
}
],
"paths": {
"/api/auto": {
"post": {
"tags": [
"AutomatedCreditAssessment"
],
"summary": "Create a new Automated Credit Assessment Enquiry",
"description": "<ul>\r\n <li>This method creates an automated credit assessment request that triggers asynchronous requests to different assessment providers.</li>\r\n <li>The method returns the automated credit assessment request DTO created in the system.</li>\r\n</ul><br /><br /><b>Required permissions:</b><br />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": "<ul>\r\n <li>This method deletes an automated credit assessment request.</li>\r\n <li>The method returns the automated credit assessment request DTO created in the system.</li>\r\n</ul><br /><br /><b>Required permissions:</b><br />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<br /><br /><b>Required permissions:</b><br />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<br /><br /><b>Required permissions:</b><br />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<br /><br /><b>Required permissions:</b><br />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<br /><br /><b>Required permissions:</b><br />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.<br /><br /><b>Required permissions:</b><br />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
# --- truncated at 32 KB (159 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-creditassessmentcommand-v1-0-openapi.json