openapi: 3.2.0 info: title: Fenergo Nebula External Data BFF Process API description: '**External Data BFF API**: External Data BFF API allows to search, retrieve and import information about clients, their associated parties, documents from external providers. Use External Data BFF API to perform the import action.' version: '1.0' servers: - url: /externaldatabff security: - Bearer: [] tags: - name: Process paths: /api/processes/{contextType}/search: post: tags: - Process summary: Create new search request description: 'This method will create a search request that will trigger asynchronous requests to different external data providers. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: RequestSearch parameters: - name: contextType in: path description: '' 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: The process search request content: application/json: schema: allOf: - $ref: '#/components/schemas/NewRequestSearchRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Search request created content: application/json: schema: $ref: '#/components/schemas/NewRequestSearchResponseDtoServiceResponse' '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/processes/newRequest/{contextId}/search: post: tags: - Process summary: Create new search request for existing context description: 'This method will create a search request that will trigger asynchronous requests to different external data providers. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: RequestNewRequestSearch parameters: - name: contextId in: path description: '' 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 process search request content: application/json: schema: allOf: - $ref: '#/components/schemas/NewRequestSearchRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Search request created content: application/json: schema: $ref: '#/components/schemas/NewRequestSearchResponseDtoServiceResponse' '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/processes/newRequest/{contextId}: get: tags: - Process summary: Get process data by context type and id description: 'This method will return process data for given context type and id Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetNewRequest parameters: - name: contextId in: path description: Id from which the request originated from required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExternalDataNewRequestDtoServiceResponse' '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/processes/{contextType}/{contextId}/search: post: tags: - Process summary: Create new search request description: 'This method will create a search request that will trigger asynchronous requests to different external data providers. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: RequestProcessSearch parameters: - name: contextType in: path description: '' required: true schema: type: string - name: contextId in: path description: '' 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 process search request content: application/json: schema: allOf: - $ref: '#/components/schemas/ProcessSearchRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Search request created '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/processes/{contextType}/{contextId}/get: post: tags: - Process summary: Create new get request description: 'This method will create a get request that will trigger asynchronous requests to different external data providers. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: RequestProcessGet parameters: - name: contextType in: path description: '' required: true schema: type: string - name: contextId in: path description: '' 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 process get request content: application/json: schema: allOf: - $ref: '#/components/schemas/ProcessGetRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Get request created '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/processes/{contextType}/{contextId}/ubo: post: tags: - Process summary: Create Ultimate Beneficial Owner discovery request description: 'This method will create a ultimate beneficial owner discovery request that will trigger asynchronous requests to different external data providers. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: RequestProcessUbo parameters: - name: contextType in: path description: '' required: true schema: type: string - name: contextId in: path description: '' 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 process ubo request content: application/json: schema: allOf: - $ref: '#/components/schemas/ProcessUboRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Ultimate beneficial owner discovery request created '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/processes/newRequest/{contextId}/gets: post: tags: - Process summary: Create new get request description: 'This method will create a get request that will trigger asynchronous requests to different external data providers. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: RequestNewRequestGet parameters: - name: contextId in: path description: '' 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 process get request content: application/json: schema: allOf: - $ref: '#/components/schemas/NewRequestGetRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Get request created '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/processes/newRequest/{contextId}/import: post: tags: - Process summary: Create new import request description: 'This method will create an import request that will create an entity from external data. Required permissions: Following permissions are required: ExternalDataApprove Required permissions: Following permissions are required: ExternalDataApprove' operationId: RequestNewRequestImport parameters: - name: contextId in: path description: '' 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 process import request content: application/json: schema: allOf: - $ref: '#/components/schemas/NewRequestImportRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Import request created '400': description: Bad request. The import 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/processes/{contextType}/{contextId}/import: post: tags: - Process summary: Create new import request description: 'This method will create an import request that will trigger asynchronous import to FenX. Required permissions: Following permissions are required: ExternalDataApprove Required permissions: Following permissions are required: ExternalDataApprove' operationId: RequestProcessImport parameters: - name: contextType in: path description: '' required: true schema: type: string - name: contextId in: path description: '' 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 process import request content: application/json: schema: allOf: - $ref: '#/components/schemas/ProcessImportRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Import request created '400': description: Bad request. The import 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/processes/{contextType}/{contextId}/gets/{getId}/document: post: tags: - Process summary: Create new document retrieval request description: 'This method will create a document retrieval request that will trigger asynchronous requests to different external data providers. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: RequestProcessGetDocument parameters: - name: contextType in: path description: '' required: true schema: type: string - name: contextId in: path description: '' required: true schema: type: string format: uuid - name: getId in: path description: '' 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 process import request content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentsRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Document request created '400': description: Bad request. The document 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 patch: tags: - Process summary: Create new Reject/Reset documents status request description: 'This method allow to reject document or reset the document rejection Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: UpdateDocuments parameters: - name: contextType in: path description: '' required: true schema: type: string - name: contextId in: path description: '' required: true schema: type: string format: uuid - name: getId in: path description: '' 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 document reject/reset status content: application/json: schema: allOf: - $ref: '#/components/schemas/DocumentsStatusRequestDtoServiceRequest' 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 /api/processes/{contextType}/{contextId}: get: tags: - Process summary: Get process data by context type and id description: 'This method will return process data for given context type and id Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetProcess parameters: - name: contextType in: path description: type of the context from which the request originated from required: true schema: type: string - name: contextId in: path description: Id from which the request originated from required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExternalDataProcessDtoServiceResponse' '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/processes/{contextType}/{contextId}/gets/{getId}: get: tags: - Process summary: Get process get data by id description: 'This method will return process get data for given id Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetProcessGet parameters: - name: contextType in: path description: type of the context from which the request originated from required: true schema: type: string - name: contextId in: path description: Id from which the request originated from required: true schema: type: string format: uuid - name: getId in: path description: Id of the get required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExternalDataProcessGetDtoServiceResponse' '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 components: schemas: MonitoringRecordDto: type: object properties: id: type: string format: uuid importId: type: string format: uuid externalId: type: - string - 'null' status: allOf: - $ref: '#/components/schemas/MonitoringStatus' failReason: allOf: - $ref: '#/components/schemas/MonitoringInitiationFailReason' deletionFailReason: allOf: - $ref: '#/components/schemas/MonitoringDeletionInitiationFailReason' errorMessage: type: - string - 'null' deletionErrorMessage: type: - string - 'null' created: type: string format: date-time additionalProperties: false ProviderNewRequestImportRecordsDto: type: object properties: providerId: type: string format: uuid recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/NewRequestImportRecordDto' additionalProperties: false NewRequestSearchResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/NewRequestSearchResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ProcessSearchRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ProcessSearchRequestDto' description: The service request DTO additionalProperties: false description: Service request data EntityValidationDetails: type: object properties: entityName: type: - string - 'null' messages: type: - array - 'null' items: type: string targetEntity: type: - string - 'null' additionalProperties: false ExternalDataProcessGetDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ExternalDataProcessGetDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DocumentRequestDataDto: required: - name - type type: object properties: name: minLength: 1 type: string type: minLength: 1 type: string accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' additionalProperties: false DocumentsStatusRequestDto: required: - documents type: object properties: documents: type: array items: $ref: '#/components/schemas/DocumentStatusRequestDto' additionalProperties: false ProcessStatus: enum: - Unknown - Active - Invalid type: string NewRequestImportRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/NewRequestImportRequestDto' description: The service request DTO additionalProperties: false description: Service request data ImportRecordsDto: type: object properties: getId: type: string format: uuid recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/ImportRecordDto' additionalProperties: false ImportRecordDto: type: object properties: id: type: string format: uuid getId: type: string format: uuid status: allOf: - $ref: '#/components/schemas/ImportStatus' failReason: allOf: - $ref: '#/components/schemas/ImportFailReason' created: type: string format: date-time errorMessage: type: - string - 'null' validationMessages: type: - array - 'null' items: $ref: '#/components/schemas/EntityValidationDetails' additionalProperties: false AccessLayerDto: type: object properties: geographic: uniqueItems: true type: - array - 'null' items: type: string businessRelated: uniqueItems: true type: - array - 'null' items: type: string additionalProperties: false ImportFailReason: enum: - None - ProviderNotEnabled - InternalError type: string NewRequestGetRecordsDto: type: object properties: externalId: type: - string - 'null' recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/NewRequestGetRecordDto' additionalProperties: false NewRequestImportRecordDto: type: object properties: id: type: string format: uuid searchId: type: string format: uuid externalId: type: - string - 'null' overwrittenData: {} journeyTypes: type: - array - 'null' items: $ref: '#/components/schemas/JourneyTypeDto' accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' contextData: allOf: - $ref: '#/components/schemas/NewRequestImportContextDataDto' status: allOf: - $ref: '#/components/schemas/ImportStatus' failReason: allOf: - $ref: '#/components/schemas/ImportFailReason' created: type: string format: date-time additionalProperties: false GetRecordsDto: type: object properties: externalId: type: - string - 'null' recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/GetRecordDto' additionalProperties: false MonitoringStatus: enum: - None - Initiated - Requested - Active - SkippedAlreadyActive - DeletionInitiated - DeletionRequested - Deleted - FailedInitiation - FailedRequest - FailedDeletionInitiation - FailedDeletionRequest type: string DocumentsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentsRequestDto' description: The service request DTO additionalProperties: false description: Service request data ProviderGetRecordsDto: type: object properties: providerId: type: string format: uuid recentRecordId: type: - string - 'null' records: type: - array - 'null' items: $ref: '#/components/schemas/GetRecordsDto' additionalProperties: false ImportStatus: enum: - None - Initiated - Completed - CompletedWithWarnings - Failed type: string SearchInitiationFailReason: enum: - None - ProviderNotEnabled - DraftNotFound - InternalError - EntityTypeUnsupported type: string ProcessGetRequestDto: required: - externalId - providerId - searchId type: object properties: searchId: type: string format: uuid providerId: type: string format: uuid externalId: minLength: 1 type: string documentCollectionProviderIds: type: - array - 'null' items: type: string taskId: type: - string - 'null' format: uuid additionalProperties: false DocumentStatus: enum: - Available - Initiated - Requested - Completed - Rejected - FailedInitiation - FailedRequest type: string DocumentRecordDto: type: object properties: id: type: string format: uuid externalId: type: - string - 'null' status: allOf: - $ref: '#/components/schemas/DocumentStatus' failReason: allOf: - $ref: '#/components/schemas/DocumentInitiationFailReason' created: type: string format: date-time additionalProperties: false SearchRecordDto: type: object properties: id: type: string format: uuid status: allOf: - $ref: '#/components/schemas/SearchStatus' failReason: allOf: - $ref: '#/components/schemas/SearchInitiationFailReason' created: type: string format: date-time taskId: type: - string - 'null' format: uuid additionalProperties: false NewRequestSearchRequestDto: required: - entityType - providersIds - searchCriteria type: object properties: providersIds: type: array items: type: string format: uuid searchCriteria: {} entityType: allOf: - $ref: '#/components/schemas/EntityType' additionalProperties: false ExternalDataNewRequestDto: type: object properties: id: type: string format: uuid context: allOf: - $ref: '#/components/schemas/ExternalDataProcessContextDto' status: allOf: - $ref: '#/components/schemas/ProcessStatus' searches: type: - array - 'null' items: $ref: '#/components/schemas/ProviderNewRequestSearchRecordsDto' imports: type: - array - 'null' items: $ref: '#/components/schemas/ProviderNewRequestImportRecordsDto' gets: type: - array - 'null' items: $ref: '#/components/schemas/ProviderNewRequestGetRecordsDto' created: type: string format: date-time additionalProperties: false ProcessImportRequestDto: required: - getId type: object properties: getId: type: string format: uuid additionalProperties: false DocumentStatusRequestDto: required: - documentId - status type: object properties: documentId: type: string format: uuid status: allOf: - $ref: '#/components/schemas/DocumentStatus' additionalProperties: false NewRequestSearchResponseDto: required: - id type: object properties: id: type: string format: uuid additionalProperties: false NewRequestGetRecordDto: type: object properties: id: type: string format: uuid externalId: type: - string - 'null' searchId: type: string format: uuid status: allOf: - $ref: '#/components/schemas/GetStatus' failReason: allOf: - $ref: '#/components/schemas/GetInitiationFailReason' created: type: string format: date-time additionalProperties: false NewRequestImportContextDataDto: type: object properties: entityId: type: string format: uuid journeysIds: type: - array - 'null' items: type: string format: uuid additionalProperties: false ProviderNewRequestSearchRecordsDto: type: object properties: providerId: type: string format: uuid recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/NewRequestSearchRecordDto' additionalProperties: false NewRequestGetRequestDto: required: - externalId - providerId - searchId type: object properties: searchId: type: string format: uuid providerId: type: string format: uuid externalId: minLength: 1 type: string additionalProperties: false SearchStatus: enum: - Initiated - Requested - Completed - FailedInitiation - FailedRequest type: string MonitoringInitiationFailReason: enum: - None - ProviderNotEnabled - InternalError type: string ProcessImportRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ProcessImportRequestDto' description: The service request DTO additionalProperties: false description: Service request data ExternalDataProcessGetDto: type: object properties: id: type: string format: uuid isLargePayload: type: boolean s3FileLocation: type: - string - 'null' documents: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRecordsDto' additionalProperties: false ProviderSearchRecordsDto: type: object properties: providerId: type: string format: uuid recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/SearchRecordDto' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ExternalDataNewRequestDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ExternalDataNewRequestDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ProcessGetRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ProcessGetRequestDto' description: The service request DTO additionalProperties: false description: Service request data DocumentRequestDto: required: - data - id type: object properties: id: type: string format: uuid data: allOf: - $ref: '#/components/schemas/DocumentRequestDataDto' additionalProperties: false ProcessUboRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ProcessUboRequestDto' description: The service request DTO additionalProperties: false description: Service request data NewRequestSearchRecordDto: type: object properties: id: type: string format: uuid status: allOf: - $ref: '#/components/schemas/SearchStatus' criteria: {} entityType: allOf: - $ref: '#/components/schemas/EntityType' failReason: allOf: - $ref: '#/components/schemas/SearchInitiationFailReason' created: type: string format: date-time additionalProperties: false NewRequestImportRequestDto: required: - accessLayers - externalId - journeyTypes - overwrittenData - searchId type: object properties: searchId: type: string format: uuid externalId: minLength: 1 type: string overwrittenData: {} journeyTypes: type: array items: $ref: '#/components/schemas/JourneyTypeDto' accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' additionalProperties: false UboRecordDto: type: object properties: id: type: string format: uuid getId: type: string format: uuid status: allOf: - $ref: '#/components/schemas/UboStatus' failReason: allOf: - $ref: '#/components/schemas/UboInitiationFailReason' created: type: string format: date-time additionalProperties: false JourneyTypeDto: required: - type type: object properties: type: minLength: 1 type: string additionalProperties: false ContextType: enum: - Empty - Journey - NewRequest type: string DocumentRecordsDto: type: object properties: externalId: type: - string - 'null' recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/DocumentRecordDto' additionalProperties: false EntityType: enum: - Unknown - Company - Individual type: string ProcessUboRequestDto: required: - getId type: object properties: getId: type: string format: uuid additionalProperties: false ProviderMonitoringRecordsDto: type: object properties: providerId: type: string format: uuid recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/MonitoringRecordDto' additionalProperties: false ExternalDataProcessContextDto: type: object properties: type: allOf: - $ref: '#/components/schemas/ContextType' id: type: string format: uuid additionalProperties: false NewRequestSearchRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/NewRequestSearchRequestDto' description: The service request DTO additionalProperties: false description: Service request data DocumentInitiationFailReason: enum: - None - ProviderNotEnabled - InternalError type: string ExternalDataProcessDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ExternalDataProcessDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UboInitiationFailReason: enum: - None - ProviderNotEnabled - InternalError type: string ProcessSearchRequestDto: required: - providersIds type: object properties: providersIds: type: array items: type: string format: uuid taskId: type: - string - 'null' format: uuid additionalProperties: false GetRecordDto: type: object properties: id: type: string format: uuid externalId: type: - string - 'null' searchId: type: string format: uuid status: allOf: - $ref: '#/components/schemas/GetStatus' failReason: allOf: - $ref: '#/components/schemas/GetInitiationFailReason' created: type: string format: date-time taskId: type: - string - 'null' format: uuid additionalProperties: false UboRecordsDto: type: object properties: getId: type: string format: uuid recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/UboRecordDto' additionalProperties: false UboStatus: enum: - Initiated - Requested - Completed - FailedInitiation - FailedRequest type: string ExternalDataProcessDto: type: object properties: id: type: string format: uuid context: allOf: - $ref: '#/components/schemas/ExternalDataProcessContextDto' status: allOf: - $ref: '#/components/schemas/ProcessStatus' searches: type: - array - 'null' items: $ref: '#/components/schemas/ProviderSearchRecordsDto' gets: type: - array - 'null' items: $ref: '#/components/schemas/ProviderGetRecordsDto' ubos: type: - array - 'null' items: $ref: '#/components/schemas/UboRecordsDto' imports: type: - array - 'null' items: $ref: '#/components/schemas/ProviderImportRecordsDto' monitorings: type: - array - 'null' items: $ref: '#/components/schemas/ProviderMonitoringRecordsDto' created: type: string format: date-time additionalProperties: false MonitoringDeletionInitiationFailReason: enum: - None - ProviderNotEnabled - InternalError type: string GetStatus: enum: - Initiated - Requested - Completed - FailedInitiation - FailedRequest type: string ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response GetInitiationFailReason: enum: - None - ProviderNotEnabled - InternalError type: string DocumentsRequestDto: required: - documents type: object properties: documents: type: array items: $ref: '#/components/schemas/DocumentRequestDto' additionalProperties: false NewRequestGetRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/NewRequestGetRequestDto' description: The service request DTO additionalProperties: false description: Service request data ProviderNewRequestGetRecordsDto: type: object properties: providerId: type: string format: uuid recentRecordId: type: - string - 'null' records: type: - array - 'null' items: $ref: '#/components/schemas/NewRequestGetRecordsDto' additionalProperties: false DocumentsStatusRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/DocumentsStatusRequestDto' description: The service request DTO additionalProperties: false description: Service request data ProviderImportRecordsDto: type: object properties: providerId: type: string format: uuid recentRecordId: type: string format: uuid records: type: - array - 'null' items: $ref: '#/components/schemas/ImportRecordsDto' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header