{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula External Data Command",
"description": "**External Data Command API**:\n\n
External Data Command API allows to import information about clients, their associated parties, documents from external providers. Use External Data Command API to perform the import action and External Data Query API to retrieve results. \n\n
**External Data Command API provides**:
- The ability to save providers configuration.
- The ability to request documents from external data providers.
- The ability to request data import of external data entry.
- The ability to trigger search of External Data
- The ability to request ultimate beneficial owners from external providers
- The ability to save mapping configuration for external data providers.
- The ability to subscribe and unsubscribe of ongoing monitoring.",
"version": "1.0"
},
"servers": [
{
"url": "/externaldatacommand"
}
],
"paths": {
"/api/aggregation/saveDataAggregationResults": {
"post": {
"tags": [
"Aggregation"
],
"summary": "Save Data Aggregation Results",
"description": "\nThis method will save Data Aggregation results.\n\nThe method will return the status.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"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": "Save Data Aggregation Results request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataAggregationHeaderDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Import request created"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/providersconfiguration/provider/{providerId}/status": {
"put": {
"tags": [
"Providers Configuration"
],
"summary": "Save Provider status",
"description": " - This method allows to save external provider status active/inactive
\n- It validates if the status can be changed, e.g. if any other provider is active at the same time.
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit",
"operationId": "SaveProviderStatusV2",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "ID of External Data Provider",
"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": "Request with the boolean value of status to set.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/providersconfiguration/provider/{providerId}/mapping/status": {
"put": {
"tags": [
"Providers Configuration"
],
"summary": "Save enabled entity type status",
"description": "- This method allows to save mapping status for specific entity type for provider - active/inactive
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit",
"operationId": "SaveEntityTypeStatus",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "ID of External Data Provider",
"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": "Request with the entity type and boolean value of status to set.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EntityTypeStatusDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/providersconfiguration/provider/{providerId}/configuration": {
"put": {
"tags": [
"Providers Configuration"
],
"summary": "Save External Data Provider Configuration",
"description": "- This method allows to save external provider configuration
\n- It includes saving version, ongoing monitoring status
\n- It also saves the provider authentication details - Encryption Key, Authentication Key
\n- It saves any custom configuration for specific provider on key/value basis
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit",
"operationId": "SaveProviderConfigurationV2",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "ID of External Data Provider",
"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": "The request with provider configuration delivered as key/value collection",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderConfigurationDtoV2ServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Provider added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveProviderConfigurationResponseDtoV2ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/providersconfiguration/customProvider": {
"post": {
"tags": [
"Providers Configuration"
],
"summary": "Add custom provider",
"description": "- This method allows to add custom provider
\n- It includes saving provider name, url, authentication details, ongoing monitoring status
Required permissions:
Following permissions are required: ExternalDataConfiguratorCreate
Required permissions:
Following permissions are required: ExternalDataConfiguratorCreate",
"operationId": "AddCustomProviderV2",
"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": "Request with details of custom provider.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CustomProviderDtoV2ServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Provider added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCustomProviderResponseDtoV2ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/providersconfiguration/customProvider/{providerId}": {
"put": {
"tags": [
"Providers Configuration"
],
"summary": "Update custom provider",
"description": "- This method allows to update existing custom provider details
\n- It includes saving provider name, url, authentication data, ongoing monitoring status
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit",
"operationId": "UpdateCustomProviderV2",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "ID of External Data Provider",
"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": "Request with details of custom provider.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CustomProviderDtoV2ServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Provider updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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": [
"Providers Configuration"
],
"summary": "Delete custom provider",
"description": "
Required permissions:
Following permissions are required: ExternalDataConfiguratorDelete
Required permissions:
Following permissions are required: ExternalDataConfiguratorDelete",
"operationId": "DeleteCustomProviderV2",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "ID of External Data Provider",
"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. Provider removed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/providersconfiguration/flowProvider": {
"post": {
"tags": [
"Providers Configuration"
],
"summary": "Create flow provide",
"description": "
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit",
"operationId": "CreateFlowProvider",
"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": "Request with details of flow provider.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateFlowProviderRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Provider updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFlowProviderResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/providersconfiguration/flowProvider/{providerId}": {
"put": {
"tags": [
"Providers Configuration"
],
"summary": "Update flow provider",
"description": "- This method allows to update existing custom provider details
\n- It includes saving provider name, url, authentication data, ongoing monitoring status
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit
Required permissions:
Following permissions are required: ExternalDataConfiguratorEdit",
"operationId": "UpdateFlowProvider",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "ID of External Data Provider",
"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": "Request with details of custom provider.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateFlowProviderRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Provider updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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": [
"Providers Configuration"
],
"summary": "Delete flow provider",
"description": "- This method allows to delete existing custom provider details
\n- It includes saving provider name, url, authentication data, ongoing monitoring status
Required permissions:
Following permissions are required: ExternalDataConfiguratorDelete
Required permissions:
Following permissions are required: ExternalDataConfiguratorDelete",
"operationId": "DeleteFlowProvider",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "ID of External Data Provider",
"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. Provider deleted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/datadocs/saveDataDocsResult": {
"post": {
"tags": [
"Data & Docs Collection"
],
"summary": "Save Data&Doc collection",
"description": "\nThis method will save Data&Doc collection.\n\nThe method will return the status.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "SaveDataDocsResult",
"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": "Save Data&Doc collection",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsHeaderDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Save Data & Docs request created"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/datadocs/saveDataDocsTaskStatusResult": {
"post": {
"tags": [
"Data & Docs Collection"
],
"summary": "Save Data&Doc collection Task State",
"description": "\nThis method will save Data&Doc collection task state.\n\nThe method will return the task state.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "SaveDataDocsTaskStatusResult",
"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": "Save Data&Doc collection task status",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsTaskStatusDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Save Data & Docs task state request created"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/datadocs/processDataDocsSummarisation": {
"post": {
"tags": [
"Data & Docs Collection"
],
"summary": "Process Data&Doc summarisation",
"description": "\nThis method processes the Data&Doc global summary for the supplied task.\n\nThe request starts or retries summarisation processing.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "ProcessDataDocsSummarisation",
"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": "Process Data&Doc summarisation request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProcessDataDocsSummarisationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Success. Summarisation processing completed."
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/datadocs/saveDataDocsEntityDetails": {
"post": {
"tags": [
"Data & Docs Entity Details"
],
"summary": "Save Data&Doc entity details",
"description": "\nThis method will save Data&Doc entity details.\n\nThe method will return the status.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "SaveDataDocsEntityDetails",
"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": "Save Data&Doc entity details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsEntityDetailsDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Save Data & Docs request created"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/datadocs/saveDataDocsRelatedParties": {
"post": {
"tags": [
"Data & Docs Related Parties"
],
"summary": "Save Data&Doc Related Parties",
"description": "\nThis method will save Data&Doc Related Parties.\n\nThe method will return the status.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "SaveDataDocsRelatedParties",
"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": "Save Data&Doc Related Parties",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsRelatedPartiesHeaderDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Save Data & Docs request created"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/datadocs/saveDataDocsDocuments": {
"post": {
"tags": [
"Data & Docs Documents"
],
"summary": "Save Data&Doc Documents status",
"description": "\nThis method will save Data&Doc Documents status.\n\nThe method will return the status.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "SaveDataDocsDocument",
"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": "Save Data&Doc Documents status",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsDocumentsStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Save Data & Docs request created"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/datadocs/importDataDocsEntityDetails": {
"post": {
"tags": [
"Data & Docs Entity Details"
],
"summary": "Import Data&Doc entity details",
"description": "\nThis method will import Data&Doc entity details.\n\nThe method will return the status.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "ImportDocsDataEntityDetails",
"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": "Import Data&Doc entity details",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsImportDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Import Data & Docs request created"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/datadocs/importDataDocsDocuments": {
"post": {
"tags": [
"Data & Docs Documents"
],
"summary": "Import Data&Doc documents",
"description": "\nThis method will import Data&Doc documents.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "ImportDataDocsDocuments",
"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": "Import Data&Doc documents",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsImportDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataDocsDocumentImportResultsDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"202": {
"description": "Success. Import Data & Docs request created"
},
"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/datadocs/import": {
"post": {
"tags": [
"Data & Docs Collection"
],
"summary": "Starts Import process for Data&Doc documents. Entity data, related parties and documents will be imported in a single request.\nStatus of process can be monitored using query endpoints.",
"description": "\nThis method will import data.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "importDataDocs",
"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": "Import Data&Doc documents",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsImportDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Import request received"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/document": {
"post": {
"tags": [
"Document"
],
"summary": "Create new document retrieval request",
"description": "This endpoint is obsolete and will be terminated on 2027-01-12. Use POST /externaldatabff/api/processes/{contextType}/{contextId}/gets/{getId}/document instead.
\nThis method will create a document retrieval request that will trigger asynchronous requests to different external data providers.\n\nThe method will return the document request ID created in the system.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"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 document retrieval request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Document retrieval request created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentRequestCreatedDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/api/document/saveDocumentsStatuses": {
"post": {
"tags": [
"Document"
],
"summary": "Reject/Reset documents status",
"description": "This endpoint is obsolete and will be terminated on 2027-01-12. Use PATCH /externaldatabff/api/processes/{contextType}/{contextId}/gets/{getId}/document instead.
\nThis method will reject/reset status of specific document/documents
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"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 document reject/reset status",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Document status rejected/reseted"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/api/import": {
"post": {
"tags": [
"Import"
],
"summary": "Create new import request",
"description": "This endpoint is obsolete and will be terminated on 2027-01-12. Use /externaldatabff/api/processes/{contextType}/{contextId}/get instead.
\nThis method will create an import request that will trigger asynchronous requests to different external data providers.\n\nThe method will return the import request ID created in the system. \n This import request ID can be used in the ExternalData Query Api to check the status of the request and to get the import results.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"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 import request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ImportRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Import request created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportRequestCreatedDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/api/import/saveDeduplicationResults": {
"post": {
"tags": [
"Import"
],
"summary": "Save Associated Parties Deduplicate",
"description": "\nThis method will save Associated Parties Deduplicate.\n\nThe method will return the status.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"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 save Associated Parties Deduplication request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AssociatedPartyDeduplicationHeaderDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Import request created"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/mapping/provider/{providerId}": {
"put": {
"tags": [
"Mapping"
],
"summary": "Create or replace mapping",
"description": "\nThis method creates or replaces mapping between provider adapter schema and the FenX policy.
Required permissions:
Following permissions are required: ExternalDataMapperEdit
Required permissions:
Following permissions are required: ExternalDataMapperEdit",
"operationId": "PutMapping",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "Provider ID",
"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": {
"description": "Create or replace mapping request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderMappingDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success."
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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": [
"Mapping"
],
"summary": "Delete Mappings",
"description": "\nThis method deletes mapping for a provider.
Required permissions:
Following permissions are required: ExternalDataMapperEdit
Required permissions:
Following permissions are required: ExternalDataMapperEdit",
"operationId": "DeleteMapping",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "Provider Id where mapping will be deleted",
"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": "Success."
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/mapping/provider/{providerId}/operation": {
"put": {
"tags": [
"Mapping"
],
"summary": "Create or replace Operation Mapping",
"description": "\nThis method creates or replaces operation mapping for a provider.\n Mapping is saved for specific operation type.
Required permissions:
Following permissions are required: ExternalDataMapperEdit
Required permissions:
Following permissions are required: ExternalDataMapperEdit",
"operationId": "PutOperationMapping",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "Provider ID",
"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": {
"description": "Create or replace operation mapping request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/OperationMappingDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success."
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/ongoingmonitoring/unsubscribe": {
"post": {
"tags": [
"OngoingMonitoring"
],
"summary": "Unsubscribe from ongoing monitoring",
"description": "\nThis method will unsubscribe from ongoing monitoring.\n The unsubscribe works on the combination of SubscriptionId and EntityId.\n SubscriptionId is the unique identifier of the subscription, generated when ongoing monitoring was subscribed for an entity.\n External Data Provider has to support ongoing monitoring and Entity has to be subscribed before it can be unsubscribed.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "UnsubscribeFromOngoingMonitoring",
"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 unsubscription request, containing SubscriptionId and EntityId",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UnsubscriptionRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Unsubscribe request created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/publish": {
"post": {
"tags": [
"Publish"
],
"summary": "Publish data to downstream system",
"description": "
Required permissions:
Following permissions are required: ExternalDataApprove
Required permissions:
Following permissions are required: ExternalDataApprove",
"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": "Request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PublishOrchestratorDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success."
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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/search": {
"post": {
"tags": [
"Search"
],
"summary": "Create new search request",
"description": "This endpoint is obsolete and will be terminated on 2027-01-12. Use /externaldatabff/api/processes/{contextType}/search instead.
\nThis method will create a search request that will trigger asynchronous requests to different external data providers.\n\nThe method will return the search request ID created in the system. \n This search request ID can be used in the ExternalData Query Api to check the status of the request and to get the screening results.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"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 search request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SearchRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Search request created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequestCreatedDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/api/ubo": {
"post": {
"tags": [
"UltimateBeneficialOwner"
],
"summary": "Create Ultimate Beneficial Owner discovery request",
"description": "This endpoint is obsolete and will be terminated on 2027-01-12. Use /externaldatabff/api/processes/{contextType}/{contextId}/ubo instead.
\nThis method will create a ultimate beneficial owner discovery request that will trigger asynchronous requests to different external data providers.\n\nThe method will return the ultimate beneficial owner discovery request ID created in the system.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"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 ultimate beneficial owner discovery request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UltimateBeneficialOwnerRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Ultimate beneficial owner discovery request created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UltimateBeneficialOwnerRequestCreatedDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
},
"deprecated": true
}
}
},
"components": {
"schemas": {
"AccessLayerDto": {
"type": "object",
"properties": {
"geographic": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of geographic access layers",
"nullable": true
},
"businessRelated": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of business related access layers",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing access layers attached"
},
"AddCustomProviderResponseDtoV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"AddCustomProviderResponseDtoV2ServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AddCustomProviderResponseDtoV2"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"AiSummaryDto": {
"type": "object",
"properties": {
"totalGroups": {
"type": "integer",
"format": "int32"
},
"duplicateGroups": {
"type": "integer",
"format": "int32"
},
"uniqueGroups": {
"type": "integer",
"format": "int32"
},
"overview": {
"type": "string",
"nullable": true
},
"assistanceDateTime": {
"type": "string",
"format": "date-time"
},
"keyIdentifier": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"reasoning": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ApprovedNewAssociation": {
"type": "object",
"properties": {
"parentId": {
"type": "string",
"format": "uuid"
},
"associationType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Identifies a specific non-snapshot association proposed by Outreach that the reviewer has\napproved for creation. Both ParentId and AssociationType must match for the\nassociation to be created during import."
},
"AssociatedPartyDeduplicationDto": {
"required": [
"deduplicationState",
"externalId",
"providerId"
],
"type": "object",
"properties": {
"providerId": {
"minLength": 1,
"type": "string",
"description": "ID of the added External Data Provider",
"example": "f47b539d-ffb8-4cf2-bf68-1af79e3b0040"
},
"externalId": {
"minLength": 1,
"type": "string",
"description": "Id of the entity in External Data system",
"example": "PL610188202"
},
"deduplicationState": {
"minLength": 1,
"enum": [
"Rejected",
"NewEntity",
"ReviewMatches",
"DismissAllMatches",
"LinkedToExisting"
],
"type": "string",
"description": "Deduplication state of Association.",
"example": "LinkedToExisting"
},
"linkedLegalEntityId": {
"type": "string",
"description": "Id of Entity, to which Association is linked",
"nullable": true,
"example": "dc443c9f-55f3-4c7e-aa11-3d7ef472c49a"
},
"deduplicationRejectMethod": {
"enum": [
"Manual",
"Auto",
"InvalidAssociation"
],
"type": "string",
"description": "Information, how Association was rejected.",
"nullable": true,
"example": "Auto"
},
"duplicationSearchResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DuplicationSearchResultDto"
},
"description": "List of Duplication Search Results",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent deduplication state of Association"
},
"AssociatedPartyDeduplicationHeaderDto": {
"required": [
"importId"
],
"type": "object",
"properties": {
"importId": {
"minLength": 1,
"type": "string",
"description": "ID of the created Import request",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"associatedPartyDeduplicationList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssociatedPartyDeduplicationDto"
},
"description": "List of Associations with Deduplication statuses",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent deduplication statuses for all Associations"
},
"AssociatedPartyDeduplicationHeaderDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AssociatedPartyDeduplicationHeaderDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"BooleanServiceRequest": {
"type": "object",
"properties": {
"data": {
"type": "boolean",
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CreateFlowProviderRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"endpointsConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowProviderEndpointConfigurationDto"
},
"nullable": true
},
"ongoingMonitoringEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreateFlowProviderRequestDtoServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateFlowProviderRequestDto"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CreateFlowProviderResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"CreateFlowProviderResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateFlowProviderResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"CreatedDocumentDto": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"messages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublishEntityPropertyDto"
},
"nullable": true
},
"publishType": {
"type": "string",
"nullable": true
},
"failedDependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublishedEntityDto"
},
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CustomProviderDtoV2": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of External Data Provider.",
"nullable": true,
"example": "Mock Provider"
},
"url": {
"type": "string",
"description": "Base url of the external data adapter which will be used to make the requests.",
"nullable": true,
"example": "https://api.fenergox.com/externaldatamock"
},
"authenticationKey": {
"type": "string",
"description": "Authentication key that allows the external data adapter to authenticate the requests.",
"nullable": true
},
"encryptionKey": {
"type": "string",
"description": "Encryption key to authenticate the requests.",
"nullable": true
},
"skipPolicyValidation": {
"type": "boolean",
"description": "Defines if the validations related to policy mapping will run for this External Data Provider.",
"example": false
},
"ongoingMonitoringEnabled": {
"type": "boolean",
"description": "Defines if ongoing monitoring feature is enabled for this External Data Provider.",
"example": true
},
"documentSupportEnabled": {
"type": "boolean",
"description": "Defines if documents feature is enabled for this External Data Provider.",
"example": true
}
},
"additionalProperties": false,
"description": "Class to represent a single custom External Data Provider configuration."
},
"CustomProviderDtoV2ServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CustomProviderDtoV2"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DataAggregationFieldDto": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
},
"dataGroupValue": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/DataAggregationFieldDto"
}
},
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"sourceProviderId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataAggregationHeaderDto": {
"required": [
"dataAggregationFieldList",
"getId",
"profilesIds",
"taskId"
],
"type": "object",
"properties": {
"getId": {
"minLength": 1,
"type": "string",
"description": "ID of the created Import request",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"taskId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey task",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"profilesIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "List of profiles ids for aggregation import"
},
"dataAggregationFieldList": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/DataAggregationFieldDto"
},
"description": "List of Associations with Deduplication statuses"
}
},
"additionalProperties": false,
"description": "Class to represent deduplication statuses for all Associations"
},
"DataAggregationHeaderDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataAggregationHeaderDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DataDocsCollectorStageBaseDto": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsStageStatus"
}
],
"description": "Represents the processing status of a data document stage."
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsCurrentStageType"
}
],
"description": "Represents the stage type in the data docs ."
}
},
"additionalProperties": false
},
"DataDocsCollectorStateDto": {
"type": "object",
"properties": {
"baseStagesInit": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataDocsCollectorStageBaseDto"
},
"nullable": true
},
"currentStageType": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsCurrentStageType"
}
],
"description": "Represents the stage type in the data docs ."
},
"documentsEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DataDocsCurrentStageType": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"description": "Represents the stage type in the data docs .",
"format": "int32"
},
"DataDocsDocumentImportResultsDto": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreatedDocumentDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"DataDocsDocumentImportResultsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsDocumentImportResultsDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"DataDocsDocumentStatus": {
"enum": [
"Available",
"Initiated",
"Requested",
"Completed",
"Rejected",
"FailedInitiation",
"FailedRequest"
],
"type": "string"
},
"DataDocsDocumentStatusRequestDto": {
"required": [
"documentId",
"status"
],
"type": "object",
"properties": {
"documentId": {
"type": "string",
"format": "uuid"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsDocumentStatus"
}
]
}
},
"additionalProperties": false
},
"DataDocsDocumentsStatusRequestDto": {
"required": [
"documents",
"importRequestId",
"journeyId",
"taskId"
],
"type": "object",
"properties": {
"importRequestId": {
"minLength": 1,
"type": "string",
"format": "uuid"
},
"journeyId": {
"minLength": 1,
"type": "string",
"format": "uuid"
},
"taskId": {
"minLength": 1,
"type": "string",
"format": "uuid"
},
"documents": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/DataDocsDocumentStatusRequestDto"
}
}
},
"additionalProperties": false
},
"DataDocsDocumentsStatusRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsDocumentsStatusRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DataDocsEntityDetailFieldsDto": {
"type": "object",
"properties": {
"singleDataFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SingleDataFieldDto"
},
"description": "List of single data fields",
"nullable": true
},
"dataGroupFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataGroupFieldDto"
},
"description": "List of datagroups fields",
"nullable": true
}
},
"additionalProperties": false
},
"DataDocsEntityDetailsDto": {
"required": [
"journeyId",
"taskId"
],
"type": "object",
"properties": {
"taskId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey task",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"fields": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsEntityDetailFieldsDto"
}
],
"description": "List of Fields, single and datagroup fields supported",
"nullable": true
},
"journeyId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey",
"format": "uuid",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
}
},
"additionalProperties": false,
"description": "DTO representing Data Docs Entity Details Request"
},
"DataDocsEntityDetailsDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsEntityDetailsDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DataDocsHeaderDto": {
"required": [
"journeyId",
"taskId"
],
"type": "object",
"properties": {
"taskId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey task",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"fields": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsResultDto"
}
],
"description": "List of Fields, currently only aggregated fields supported",
"nullable": true
},
"journeyId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey",
"format": "uuid",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
}
},
"additionalProperties": false,
"description": "Class to represent deduplication statuses for all Associations"
},
"DataDocsHeaderDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsHeaderDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DataDocsImportDto": {
"required": [
"journeyId",
"taskId"
],
"type": "object",
"properties": {
"taskId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey task",
"format": "uuid",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"journeyId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey",
"format": "uuid",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
}
},
"additionalProperties": false,
"description": "DTO representing Data Docs Entity Details Request"
},
"DataDocsImportDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsImportDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DataDocsRelatedPartiesDetailsLightDto": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyGroupLightDto"
},
"description": "A collection of related party groups.",
"nullable": true
}
},
"additionalProperties": false
},
"DataDocsRelatedPartiesHeaderDto": {
"required": [
"journeyId",
"taskId"
],
"type": "object",
"properties": {
"taskId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey task",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"fields": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsRelatedPartiesDetailsLightDto"
}
],
"description": "List of Fields, currently only aggregated fields supported",
"nullable": true
},
"journeyId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey",
"format": "uuid",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
}
},
"additionalProperties": false,
"description": "Class to represent deduplication statuses for all Associations"
},
"DataDocsRelatedPartiesHeaderDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsRelatedPartiesHeaderDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DataDocsResultDto": {
"type": "object",
"properties": {
"aggregatedFields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldSource"
},
"nullable": true
},
"description": "List of fields",
"nullable": true
}
},
"additionalProperties": false
},
"DataDocsStageStatus": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "Represents the processing status of a data document stage.",
"format": "int32"
},
"DataDocsTaskStatusDto": {
"required": [
"dataDocsCollectorState",
"journeyId",
"taskId"
],
"type": "object",
"properties": {
"journeyId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey",
"format": "uuid",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"taskId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey task",
"format": "uuid",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"dataDocsCollectorState": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsCollectorStateDto"
}
],
"description": "Current status for the data&docs states"
}
},
"additionalProperties": false,
"description": "Class to represent data&docs states"
},
"DataDocsTaskStatusDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsTaskStatusDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DataGroupFieldDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"dataGroupId": {
"type": "string",
"nullable": true
},
"reviewRequired": {
"type": "boolean"
},
"isOverridden": {
"type": "boolean"
},
"isAiAssisted": {
"type": "boolean"
},
"isAiResolved": {
"type": "boolean"
},
"aiSummary": {
"allOf": [
{
"$ref": "#/components/schemas/AiSummaryDto"
}
],
"nullable": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentRequestCreatedDto": {
"type": "object",
"properties": {
"documentRequestId": {
"type": "string",
"description": "ID of the created Document request",
"nullable": true,
"example": "495669fb-e3c5-4538-8457-4dcbcb720578"
}
},
"additionalProperties": false,
"description": "Response DTO representing the created Search request"
},
"DocumentRequestCreatedDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentRequestCreatedDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"DocumentRequestDataDto": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "The id of the document",
"nullable": true,
"example": "c5b6cf1d-e00b-4b96-b1f2-fc2884c543bc"
},
"name": {
"type": "string",
"description": "The name of the document",
"nullable": true
},
"type": {
"type": "string",
"description": "The type of the document",
"nullable": true,
"example": "Driver license"
},
"status": {
"type": "string",
"description": "The status of the document",
"nullable": true
},
"accessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayerDto"
}
],
"description": "Document access layers.",
"nullable": true
},
"documentCriteria": {
"description": "Document Criteria that we want to order",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentRequestDto": {
"required": [
"documentData"
],
"type": "object",
"properties": {
"importRequestId": {
"type": "string",
"description": "ID of the created Import request",
"format": "uuid",
"example": "86fa2093-f161-4231-b1f5-8d6fd6049f96"
},
"documentData": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentRequestDataDto"
},
"description": "Additional fields for Document request"
}
},
"additionalProperties": false
},
"DocumentRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DocumentStatusRequestDataDto": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "Id of specific document",
"nullable": true,
"example": "86fa2093-f161-4231-b1f5-8d6fd6049f96"
},
"status": {
"enum": [
"Rejected",
"Retrieved"
],
"type": "string",
"description": "Document status.",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentStatusRequestDto": {
"required": [
"documentStatuses"
],
"type": "object",
"properties": {
"importRequestId": {
"type": "string",
"description": "ID of the created Import request",
"format": "uuid",
"example": "86fa2093-f161-4231-b1f5-8d6fd6049f96"
},
"documentStatuses": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentStatusRequestDataDto"
},
"description": "Additional fields for Document Status request"
}
},
"additionalProperties": false
},
"DocumentStatusRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatusRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DuplicationSearchResultDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true,
"example": "621d68ef-ab6d-4dd3-befb-ff48c687e561"
},
"type": {
"type": "string",
"description": "Type of the entity",
"nullable": true,
"example": "Company"
},
"policyJurisdiction": {
"type": "string",
"description": "Is Policy Jurisdiction",
"nullable": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"description": "Search result values",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent deduplication search result"
},
"EntityTypeStatusDto": {
"type": "object",
"properties": {
"entityType": {
"type": "string",
"description": "Type of entity.",
"nullable": true,
"example": "Company"
},
"isActive": {
"type": "boolean",
"description": "Defines if mapping for above entity type is enabled.",
"example": false
}
},
"additionalProperties": false
},
"EntityTypeStatusDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EntityTypeStatusDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ExternalDataOutreach": {
"type": "object",
"properties": {
"approvedVerifiedAssociationIdsRemoval": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "IDs of verified associations approved for removal by the reviewer; they will be deleted\nvia RemoveVerifiedAssociation during import.",
"nullable": true
},
"approvedUnverifiedAssociationIdsRemoval": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "IDs of unverified associations approved for removal by the reviewer; they will be deleted\nvia RemoveUnverifiedAssociation during import.",
"nullable": true
},
"approvedNewAssociations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApprovedNewAssociation"
},
"description": "Approved (parentId, associationType) pairs for non-snapshot associations proposed by Outreach.\nOnly non-snapshot associations matching both ParentId and AssociationType in this list will be\ncreated during import; all others are silently skipped.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Association-level approval decisions within an outreach review publish (AB#545441)."
},
"FieldSource": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
},
"provider": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FlowProviderEndpointConfigurationDto": {
"type": "object",
"properties": {
"requestType": {
"type": "string",
"nullable": true
},
"flowId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImportRequestCreatedDto": {
"type": "object",
"properties": {
"importRequestId": {
"type": "string",
"description": "ID of the created Import request",
"nullable": true,
"example": "86fa2093-f161-4231-b1f5-8d6fd6049f96"
}
},
"additionalProperties": false,
"description": "Response DTO representing the created Import request"
},
"ImportRequestCreatedDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ImportRequestCreatedDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ImportRequestDto": {
"required": [
"entityName",
"externalId",
"providerId"
],
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "Id of the entity in External Data system",
"example": "PL610188202"
},
"journeyId": {
"type": "string",
"description": "Id of the Journey instance that will be connected to this Import request",
"nullable": true,
"example": "c0c7b87d-1fc3-4127-b87d-c5b76a13d159"
},
"taskId": {
"type": "string",
"description": "Id of the Task connected to this Journey instance",
"nullable": true,
"example": "2c4e5dce-0ac1-4f24-8e21-9b0a4b8070f5"
},
"providerId": {
"type": "string",
"description": "Id of the provider from which we want to Import the data from",
"example": "f47b539d-ffb8-4cf2-bf68-1af79e3b0040"
},
"entityName": {
"type": "string",
"description": "Name of Imported entity",
"example": "Example entity"
},
"additionalRequestData": {
"description": "Additional fields for Import request",
"nullable": true
},
"entityType": {
"enum": [
"Company",
"Individual"
],
"type": "string",
"description": "Entity Type",
"nullable": true,
"example": "Company"
}
},
"additionalProperties": false,
"description": "Request DTO Class create Import request"
},
"ImportRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ImportRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"JurisdictionDto": {
"type": "object",
"properties": {
"jurisdiction": {
"type": "string",
"description": "Name of the Jurisdiction",
"nullable": true,
"example": "Global"
},
"jurisdictionVersion": {
"type": "string",
"description": "Version of the Jurisdiction",
"format": "uuid",
"nullable": true,
"example": "8fd3739b-555c-49d8-9ab4-eb442480d852"
}
},
"additionalProperties": false
},
"LoVArrayMap": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"map": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"LoVMap": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"map": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"Map": {
"type": "object",
"properties": {
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mapping"
},
"nullable": true
},
"loVMaps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoVMap"
},
"nullable": true
},
"loVArrayMaps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoVArrayMap"
},
"nullable": true
}
},
"additionalProperties": false
},
"MapDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Map Name",
"nullable": true,
"example": "Example Map"
},
"map": {
"allOf": [
{
"$ref": "#/components/schemas/Map"
}
],
"description": "Map defining source to target fields transformations",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent Source - Target Map"
},
"Mapping": {
"type": "object",
"properties": {
"source": {
"type": "string",
"nullable": true
},
"target": {
"type": "string",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/MappingType"
}
]
},
"loVMapName": {
"type": "string",
"nullable": true
},
"toArray": {
"type": "boolean"
},
"displaySource": {
"type": "boolean"
},
"constantValue": {
"type": "string",
"nullable": true
},
"objectToTextProperties": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectToTextProperties"
}
],
"nullable": true
},
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mapping"
},
"nullable": true
}
},
"additionalProperties": false
},
"MappingType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"type": "integer",
"format": "int32"
},
"ObjectField": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"isLoV": {
"type": "boolean"
},
"loVMapName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectSelector": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ObjectToTextProperties": {
"type": "object",
"properties": {
"separator": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectField"
},
"nullable": true
},
"selector": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectSelector"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"OperationMappingDto": {
"required": [
"maps",
"operation",
"operationType"
],
"type": "object",
"properties": {
"operation": {
"minLength": 1,
"enum": [
"Search",
"Get"
],
"type": "string",
"description": "Operation for which mapping is defined.",
"example": "Search"
},
"operationType": {
"minLength": 1,
"enum": [
"Request",
"Response"
],
"type": "string",
"description": "Operation Type where mapping will be applied.",
"example": "Request"
},
"entityType": {
"enum": [
"Company",
"Individual"
],
"type": "string",
"description": "Entity Type details which mapping will be defined.",
"nullable": true,
"example": "Company"
},
"maps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MapDto"
},
"description": "Set of Maps"
}
},
"additionalProperties": false,
"description": "Class to represent mapping for single operation"
},
"OperationMappingDtoServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/OperationMappingDto"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"OutreachAmendmentApproval": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"format": "uuid"
},
"approvedFieldKeys": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"OutreachApprovals": {
"type": "object",
"properties": {
"amendmentApprovals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OutreachAmendmentApproval"
},
"description": "Per-entity, per-field amendment approvals. Only the listed fields are written to\nentity drafts; fields absent from the list are left unchanged.",
"nullable": true
},
"associations": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalDataOutreach"
}
],
"description": "Association-level approval decisions (removals and new associations).",
"nullable": true
}
},
"additionalProperties": false,
"description": "Outreach-review approval decisions carried with a publish message (AB#545441).\nNull when the publish was not triggered from an outreach review context."
},
"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": { }
},
"ProcessDataDocsSummarisationDto": {
"required": [
"journeyId",
"taskId"
],
"type": "object",
"properties": {
"taskId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey task",
"format": "uuid",
"example": "300e2046-f78c-49d2-b326-afba28dc301c"
},
"journeyId": {
"minLength": 1,
"type": "string",
"description": "ID of the journey",
"format": "uuid",
"example": "400e3046-f78c-49d2-b326-afba28dc301d"
},
"currentStageType": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsCurrentStageType"
}
],
"description": "Current stage type - optional for manual retry requests and defaults to Summary when omitted",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing Process Data Docs Summarisation Request"
},
"ProcessDataDocsSummarisationDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProcessDataDocsSummarisationDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"PropertyDto": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value of the property",
"nullable": true,
"example": "Example value"
},
"type": {
"type": "string",
"description": "Type of property",
"nullable": true,
"example": "Single"
},
"customTypeId": {
"type": "string",
"description": "Id of custom type",
"format": "uuid",
"example": "bf8488ac-dcc9-42ba-97f1-471f4f735572"
},
"isValid": {
"type": "boolean",
"description": "The is valid flag",
"example": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"description": "Dictionary of properties",
"nullable": true
}
},
"additionalProperties": false,
"description": "Abstraction that represents properties"
},
"ProviderConfigurationDtoV2": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Version of the configuration.",
"format": "int32",
"example": 1
},
"skipPolicyValidation": {
"type": "boolean",
"description": "Defines if the validations related to policy mapping will run for this External Data Provider.",
"example": false
},
"enabledEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines if what type of entity is enabled for configuration mapping.",
"nullable": true
},
"configuration": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the configuration of a single External Data Provider."
},
"ProviderConfigurationDtoV2ServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderConfigurationDtoV2"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ProviderMappingDto": {
"required": [
"operationsMappings"
],
"type": "object",
"properties": {
"operationsMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OperationMappingDto"
},
"description": "Set of Operation Mappings (Search Request, Search Response, Get Request, Get Response)"
}
},
"additionalProperties": false,
"description": "Class to represent mappings set for Provider"
},
"ProviderMappingDtoServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderMappingDto"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"PublishEntityPropertyDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PublishOrchestratorDto": {
"required": [
"draftId",
"entityId",
"externalDataProviderId",
"externalId",
"importId",
"journeyId",
"searchId"
],
"type": "object",
"properties": {
"tenant": {
"type": "string",
"description": "Id of the Tenant",
"nullable": true,
"example": "20a58964-c4aa-4dcf-980d-fa0e6f2b51d2"
},
"journeyId": {
"type": "string",
"description": "Id of the Journey (Needed to update EntityDraft for the root legal entity)",
"example": "c0c7b87d-1fc3-4127-b87d-c5b76a13d159"
},
"searchId": {
"type": "string",
"description": "Id of the Search Request",
"example": "495669fb-e3c5-4538-8457-4dcbcb720578"
},
"externalId": {
"type": "string",
"description": "ExternalId of the root Legal Entity",
"example": "PL610188202"
},
"importId": {
"type": "string",
"description": "Id of the External Data Import",
"example": "86fa2093-f161-4231-b1f5-8d6fd6049f96"
},
"entityId": {
"type": "string",
"description": "EntityId of the root Legal Entity",
"example": "c9476631-df14-4c26-8feb-9bde7091a4a1"
},
"externalDataProviderId": {
"type": "string",
"description": "Id of the External Data Provider",
"example": "f47b539d-ffb8-4cf2-bf68-1af79e3b0040"
},
"draftId": {
"type": "string",
"description": "DraftId of the root Legal Entity",
"example": "8fd3739b-555c-49d8-9ab4-eb442480d852"
},
"jurisdictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JurisdictionDto"
},
"description": "List of drafts jurisdictions",
"nullable": true
},
"ongoingMonitoring": {
"type": "boolean",
"description": "If subscribe to ongoing monitoring"
},
"ongoingMonitoringData": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"description": "Ongoing Monitoring Subscription Data",
"nullable": true
},
"relatedPartiesBusinessCategory": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of categories for related parties",
"nullable": true
},
"taskId": {
"type": "string",
"description": "Id of the journey task that triggered this import",
"nullable": true
},
"providerName": {
"type": "string",
"description": "Display name of the external data provider, resolved at enqueue time and recorded as the\nacting user on downstream writes so the audit trail attributes imported data to its source\n(AB#544623). Empty for in-flight messages enqueued before this field existed, in which case\nthe orchestrator falls back to the provider name from the global configuration.",
"nullable": true
},
"outreachApprovals": {
"allOf": [
{
"$ref": "#/components/schemas/OutreachApprovals"
}
],
"description": "Outreach-review approval decisions; null when this publish was not triggered from an\noutreach review context (AB#545441).",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the publish external data process"
},
"PublishOrchestratorDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/PublishOrchestratorDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"PublishedEntityDto": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"messages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublishEntityPropertyDto"
},
"nullable": true
},
"publishType": {
"type": "string",
"nullable": true
},
"failedDependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublishedEntityDto"
},
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RelatedPartyGroupLightDto": {
"type": "object",
"properties": {
"groupId": {
"type": "string",
"description": "The unique identifier of the related party group.",
"format": "uuid"
},
"selectedForImport": {
"type": "boolean",
"description": "Indicates whether this record is selected for import or rejected"
},
"selectedForImportId": {
"type": "string",
"description": "Id of related party selected for import from PotentialDuplicates or Parties",
"nullable": true
},
"sourceProviderId": {
"type": "string",
"description": "Source Provider Id selected by user from source column.",
"nullable": true
},
"isDuplicated": {
"type": "boolean",
"description": "think if this flag is needed - used to indicate if record is selected from 'Potential Duplicates' list"
},
"status": {
"type": "string",
"description": "The status of the related party record (e.g., \"ReviewRequired\").",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a single related party group."
},
"SaveProviderConfigurationResponseDtoV2": {
"type": "object",
"properties": {
"status": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SaveProviderConfigurationResponseDtoV2ServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SaveProviderConfigurationResponseDtoV2"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"SearchRequestCreatedDto": {
"type": "object",
"properties": {
"searchRequestId": {
"type": "string",
"description": "ID of the created Search request",
"nullable": true,
"example": "495669fb-e3c5-4538-8457-4dcbcb720578"
}
},
"additionalProperties": false,
"description": "Response DTO representing the created Search request"
},
"SearchRequestCreatedDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SearchRequestCreatedDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"SearchRequestDto": {
"required": [
"searchCriteria"
],
"type": "object",
"properties": {
"searchCriteria": {
"description": "Search Criteria that we want to search for",
"example": {
"legalEntityName": "Fenergo",
"countryOfIncorporation": "Ireland"
}
},
"journeyId": {
"type": "string",
"description": "Id of the Journey instance that will be connected to this Search request",
"nullable": true,
"example": "c0c7b87d-1fc3-4127-b87d-c5b76a13d159"
}
},
"additionalProperties": false,
"description": "Request DTO to create a Search request"
},
"SearchRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SearchRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The message",
"nullable": true,
"example": "Success"
},
"type": {
"type": "string",
"description": "Type of the message\nOne of Info, Warning, Error, Forbidden",
"nullable": true,
"example": "Info"
},
"errorCode": {
"type": "string",
"description": "Error Code",
"nullable": true,
"example": "INTERNAL_SERVER_ERROR"
}
},
"additionalProperties": false,
"description": "The message associated to the service response"
},
"SingleDataFieldDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldSource"
},
"nullable": true
},
"reviewRequired": {
"type": "boolean"
},
"isOverridden": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"propertyType": {
"type": "string",
"nullable": true
},
"propertyTypeId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"StringServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"UltimateBeneficialOwnerRequestCreatedDto": {
"type": "object",
"properties": {
"ultimateBeneficialOwnerRequestId": {
"type": "string",
"description": "ID of the created Ultimate beneficial owner discovery request",
"nullable": true,
"example": "f93e5f78-bef6-4d48-954d-800a8edb5aa0"
}
},
"additionalProperties": false,
"description": "Response DTO representing the created Ultimate beneficial owner discovery request"
},
"UltimateBeneficialOwnerRequestCreatedDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UltimateBeneficialOwnerRequestCreatedDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"UltimateBeneficialOwnerRequestDto": {
"required": [
"entityId",
"importRequestId"
],
"type": "object",
"properties": {
"importRequestId": {
"minLength": 1,
"type": "string",
"description": "ID of the created Import request",
"format": "uuid",
"example": "86fa2093-f161-4231-b1f5-8d6fd6049f96"
},
"entityId": {
"minLength": 1,
"type": "string",
"description": "The id of the entity",
"example": "c5b6cf1d-e00b-4b96-b1f2-fc2884c543bc"
}
},
"additionalProperties": false
},
"UltimateBeneficialOwnerRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UltimateBeneficialOwnerRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UnsubscriptionRequestDto": {
"required": [
"entityId",
"subscriptionId"
],
"type": "object",
"properties": {
"entityId": {
"minLength": 1,
"type": "string",
"description": "The Entity Id"
},
"subscriptionId": {
"minLength": 1,
"type": "string",
"description": "The Subscription Id"
}
},
"additionalProperties": false,
"description": "Request DTO to unsubscribe from ongoing monitoring"
},
"UnsubscriptionRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UnsubscriptionRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UpdateFlowProviderRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"endpointsConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowProviderEndpointConfigurationDto"
},
"nullable": true
},
"ongoingMonitoringEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"UpdateFlowProviderRequestDtoServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateFlowProviderRequestDto"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}