Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula CreditScreening Command",
"description": "**CreditScreening Command API**:\n\n<br> Credit Screening Command API provides both configurational and operational methods related to the client's credit screenings. Use the Credit Screening Command API to create, update and delete credit screenings and related aggregates. Use the Query API to retrieve credit screenings and other related aggregates.\n\n<br> **CreditScreening Command API provides**:<br><ul><li> The ability to perform credit screening for Individual and Company Legal Entities.</li><li> The ability to trigger asynchronous credit screening requests to different providers.</li><li> The ability to create, update, delete related objects of credit screening - Including providers, providers configurations, mapping configurations and adapter schemas.</li><li> The ability to create and update related objects of Manual Credit Screenings. Includes Manual Credit Screening sets and versions.</li></ul>",
"version": "1.0"
},
"servers": [
{
"url": "/creditscreeningcommand"
}
],
"paths": {
"/api/creditscreening": {
"post": {
"tags": [
"CreditScreening"
],
"summary": "Create a new Credit Screening Enquiry",
"description": "<ul>\r\n <li>This method creates a credit screening request that triggers asynchronous requests to different screening providers.</li>\r\n <li>The method returns the credit screening request DTO created in the system.</li>\r\n</ul><br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningAccess",
"operationId": "CreditScreening",
"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 Screening request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditScreeningRequestDtoServiceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreditScreeningRequestDtoServiceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreditScreeningRequestDtoServiceRequest"
}
}
}
},
"responses": {
"202": {
"description": "Success. Request created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/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": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/creditscreening/{id}": {
"delete": {
"tags": [
"CreditScreening"
],
"summary": "Delete a Credit Screening Enquiry",
"description": "<ul>\r\n <li>This method deletes a credit screening request.</li>\r\n <li>The method returns the credit screening request DTO created in the system.</li>\r\n</ul><br /><br /><b>Required permissions:</b><br />Following permissions are required: CreditScreeningDelete",
"operationId": "DeleteCreditScreening",
"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": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/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": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/providers": {
"post": {
"tags": [
"CreditScreeningProvider"
],
"summary": "Create a new Credit Screening Provider",
"description": "\nThis method creates new Credit ScreeningProvider.\r\n\nThe new provider initializes with the DTO data and is set to disable as default.<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit",
"operationId": "CreateCreditScreeningProvider",
"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/ProviderDtoServiceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted for processing",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/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": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/providers/{providerId}": {
"put": {
"tags": [
"CreditScreeningProvider"
],
"summary": "Update an existing Credit Screening Provider",
"description": "\nThis method updates a Credit ScreeningProvider.<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit",
"operationId": "UpdateCreditScreeningProvider",
"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/ProviderDtoServiceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted for processing",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProviderDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/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": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"CreditScreeningProvider"
],
"summary": "Delete a Credit Screening Provider and all related configurations.",
"description": "\nThis method deletes a Credit Screening Provider.\r\n\nIt also deletes the configuration, mapping configuration and adapter schema\r\n\nthat are related to this provider.<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete",
"operationId": "DeleteCreditScreeningProvider",
"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": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/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": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/providers/{providerId}/enabled": {
"put": {
"tags": [
"CreditScreeningProvider"
],
"summary": "Update if a provider is Enabled",
"description": "\nThis method updates a credit screening provider if they are inactive/active.<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit",
"operationId": "UpdateCreditScreeningProviderEnabled",
"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/EnabledDtoServiceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EnabledDtoServiceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/EnabledDtoServiceRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted for processing",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EnabledDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnabledDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EnabledDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/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": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/providers/{providerId}/configuration": {
"post": {
"tags": [
"CreditScreeningProvider"
],
"summary":
# --- truncated at 32 KB (187 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-creditscreeningcommand-v1-0-openapi.json