openapi: 3.2.0 info: title: Fenergo Configuration API version: '1.0' description: 'Operations tagged Configuration across 14 of this provider''s published API definitions: fenergo-dataprotectioncommand-v1-0-openapi.json, fenergo-dataprotectionquery-v1-0-openapi.json, fenergo-digitalidvcommand-v1-0-openapi.json, fenergo-digitalidvcommand-v2-0-openapi.json, fenergo-digitalidvquery-v1-0-openapi.json, fenergo-digitalidvquery-v2-0-openapi.json, fenergo-documentmanagementcommand-v2-0-openapi.json, fenergo-financialanalysiscommand-v1-0-openapi.json…' servers: - url: /dataprotectioncommand - url: /dataprotectionquery - url: /digitalidvcommand - url: /digitalidvquery - url: /documentmanagementcommand - url: /financialanalysiscommand - url: /financialanalysisquery - url: /newrequest - url: /screeningcommand - url: /screeningquery security: - Bearer: [] tags: - name: Configuration paths: /api/configuration: post: tags: - Configuration summary: Create data protection configuration description: 'Creates a new configuration Creates a new data protection configuration. Returns the created configuration id. Required permissions: Following permissions are required: DataProtectionCreate' operationId: CreateConfiguration 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: Create data protection configuration content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateConfigurationDtoServiceRequest' description: Service request data responses: '202': description: Success. Data protection configuration created content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - Configuration summary: Get configuration description: 'Returns configuration if exists. Required permissions: Following permissions are required: DataProtectionAccess' operationId: GetConfiguration 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 responses: '200': description: Success. The configuration is returned. content: application/json: schema: $ref: '#/components/schemas/ConfigurationDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT put: tags: - Configuration summary: Save Configuration description: 'This save configuration for a given tenant. Required permissions: Following permissions are required: NewEntityConfigurationEdit Required permissions: Following permissions are required: NewEntityConfigurationEdit' operationId: SaveConfiguration 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: Configuration request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateConfigurationRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Configuration saved '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 servers: - url: /dataprotectioncommand /api/configuration/{id}: put: tags: - Configuration summary: Update data protection configuration description: 'Updates data protection configuration Required permissions: Following permissions are required: DataProtectionEdit' operationId: UpdateConfiguration parameters: - name: id in: path description: Data protection configuration id 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: Update data protection configuration request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateConfigurationDtoServiceRequest' description: Service request data responses: '202': description: Success. Data protection regime updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Data protection configuration with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dataprotectioncommand /api/configuration/automatic-reonboarding/{id}: put: tags: - Configuration description: 'Required permissions: Following permissions are required: DataProtectionAutomaticReOnboardingEdit' operationId: UpdateConfigurationAutomaticReOnboarding parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateConfigurationAutomaticReOnboardingDtoServiceRequest' description: Service request data responses: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Update configuration automatic re onboarding x-summary-source: derived servers: - url: /dataprotectioncommand /api/configuration/automatic-reonboarding/status: get: tags: - Configuration summary: Get Automatic Re-onboarding status description: Returns automatic reonboarding status. operationId: GetAutomaticReOnboardingStatus 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 responses: '200': description: Success. The configuration is returned. content: application/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /dataprotectionquery /api/configuration/provider/{providerId}/status: put: tags: - Configuration summary: Save Provider status description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: SaveProviderStatus parameters: - name: providerId 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: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/BooleanServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/BooleanServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/BooleanServiceRequest' description: Service request data responses: '202': description: Accepted '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /digitalidvcommand /api/configuration/provider/{providerId}/configuration: put: tags: - Configuration summary: Save Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: SaveProviderConfiguration parameters: - name: providerId 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: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' description: Service request data responses: '202': description: Success. Provider added content: text/plain: schema: $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /digitalidvcommand /api/v2/configuration/provider/{providerId}/status: put: tags: - Configuration summary: Save Provider status description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: putApiV2ConfigurationProviderByProviderIdStatus parameters: - name: providerId 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: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/BooleanServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/BooleanServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/BooleanServiceRequest' description: Service request data responses: '202': description: Accepted '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 x-operation-id-source: normalized x-operation-id-original: SaveProviderStatus servers: - url: /digitalidvcommand /api/v2/configuration/provider/{providerId}/configuration: put: tags: - Configuration summary: Save Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: putApiV2ConfigurationProviderByProviderIdConfiguration parameters: - name: providerId 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: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' description: Service request data responses: '202': description: Success. Provider added content: text/plain: schema: $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 x-operation-id-source: normalized x-operation-id-original: SaveProviderConfiguration servers: - url: /digitalidvcommand /api/configuration/provider/{providerId}: get: tags: - Configuration summary: Get provider configuration description: 'This method returns specific Digital IDV provider Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: GetProviderConfiguration parameters: - name: providerId in: path description: The ID of 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: '200': description: Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.ProviderConfigurationDto class containing provider configuration information. content: text/plain: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse' '400': description: Invalid request. content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There is no provider with given id 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 servers: - url: /digitalidvquery /api/v2/configuration: get: tags: - Configuration summary: Get Configuration description: 'Required permissions: Following permissions are required: DigitalIdvAccess' operationId: getApiV2Configuration 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 responses: '200': description: Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.ConfigurationDto class containing configuration information. content: text/plain: schema: $ref: '#/components/schemas/ConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ConfigurationDtoServiceResponse' '400': description: Invalid request. content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 x-operation-id-source: normalized x-operation-id-original: GetConfiguration put: summary: Update document configuration description: 'Updates the configuration Required permissions: Following permissions are required: DocumentConfigurationEdit' operationId: putApiV2Configuration 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: Update configuration request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateDocumentConfigurationRequestDtoServiceRequest' responses: '202': description: Success. Configuration updated '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_2' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2' '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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT tags: - Configuration x-operation-id-source: normalized x-operation-id-original: UpdateConfiguration post: tags: - Configuration summary: Create a new Screening Configuration description: 'This method creates the configuration V2 for a tenant with default providers Required permissions: Following permissions are required: ScreeningConfigurationCreate, ScreeningConfigurationAccess' operationId: CreateConfigurationV2 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 responses: '202': description: Success. Configuration created '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT patch: tags: - Configuration summary: Update part of an existing Screening Configuration description: 'This method updates part of an existing screening configuration Please note that currently only the ''CommentsMandatory'' property can be updated with this endpoint To update other parameters specific to a particular provider, please refer to the other endpoints in this API Any fields in the request that are not sent or are sent as null will keep their current value. As mentioned, this currently only applies to the ''CommentsMandatory'' property Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: PatchConfigurationV2 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: Data with which to update the Screening Configuration content: application/json: schema: allOf: - $ref: '#/components/schemas/PatchConfigurationV2DtoServiceRequest' responses: '202': description: Success. Configuration updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvquery /api/v2/configuration/provider/{providerId}: get: tags: - Configuration summary: Get provider configuration description: 'This method returns specific Digital IDV provider Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: getApiV2ConfigurationProviderByProviderId parameters: - name: providerId in: path description: The ID of 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: '200': description: Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.ProviderConfigurationDto class containing provider configuration information. content: text/plain: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse_2' '400': description: Invalid request. content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There is no provider with given id 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 x-operation-id-source: normalized x-operation-id-original: GetProviderConfiguration patch: tags: - Configuration summary: Update part of the Provider Configuration inside a specific provider description: 'This method updates part of the configuration of a specified provider Credential and Ongoing Screening properties must be null or empty for non ''Out Of The Box'' providers The fields in the request model that are not sent or are sent as null will keep their current value Only properties'' values can be modified Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: PatchProviderV2 parameters: - name: providerId in: path description: Id of the provider 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: Data of the provider to be updated content: application/json: schema: allOf: - $ref: '#/components/schemas/PatchProviderDtoV2ServiceRequest' responses: '202': description: Success. Configuration updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - Configuration summary: Delete a Provider from an Existing Configuration description: 'This method deletes a provider from the existing configuration ''Out Of The Box'' providers cannot be deleted Required permissions: Following permissions are required: ScreeningConfigurationDelete, ScreeningConfigurationAccess' operationId: DeleteProviderV2 parameters: - name: providerId in: path description: Id of provider to be deleted from configuration 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. Provider deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvquery /api/configuration/{configurationId}: delete: tags: - Configuration summary: Delete Financial Analysis Configuration and all it's versions description: 'This method deletes an existing Financial Analysis Configuration as well as all its versions. Required permissions: Following permissions are required: FinancialAnalysisConfigurationDelete' operationId: DeleteConfiguration parameters: - name: configurationId in: path description: Configuration Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Configuration with given ID does not exists 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT post: tags: - Configuration summary: Create a new Version for an existing Financial Analysis Configuration description: 'This method creates a new Financial Analysis Configuration version. The new version initializes with the DTO data. It is assigned the next available version number, the default status of Draft and the Author as the only required Signee. Required permissions: Following permissions are required: FinancialAnalysisConfigurationCreate' operationId: CreateConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the new version data content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Financial Analysis Configuration with given ID does not exists 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - Configuration summary: Get an active version of an existing Configuration by ID description: 'This method returns the active, currently in effect, published version for a given configuration Required permissions: Following permissions are required: FinancialAnalysisConfigurationAccess' operationId: GetConfigurationById parameters: - name: configurationId in: path description: The id of the configuration to retrieve 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: '200': description: Success. A Configuration is returned content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_4' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_4' example: data: {} messages: - message: Not Found. Configuration with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_4' 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_4' 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_4' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/configuration/{configurationId}/version/{versionNumber}/clone: post: tags: - Configuration summary: Clone a Financial Analysis Configuration description: 'Clones the selected version of existing configuration and creates a new model with a single version The new version contain all the data of the original selected one, will have the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: FinancialAnalysisConfigurationEdit' operationId: CloneConfiguration parameters: - name: configurationId in: path description: Configuration Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to clone required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Clone Configuration version request content: application/json: schema: $ref: '#/components/schemas/ConfigurationCloneRequestDtoServiceRequest' responses: '202': description: Success. Configuration cloned content: application/json: schema: $ref: '#/components/schemas/ConfigurationClonedResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Not Found. Configuration with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/configuration/{configurationId}/version/{versionNumber}: put: tags: - Configuration summary: Updates an existing Version of a Financial Analysis Configuration description: 'This method updates an existing Financial Analysis Configuration version. Only Draft and Rejected versions are allowed to be updated. Required permissions: Following permissions are required: FinancialAnalysisConfigurationEdit' operationId: UpdateConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: Number of version to update required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the updated version data content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceRequest' responses: '202': description: Accepted for processing '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Configuration with given ID does not exists 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - Configuration summary: Get a specific version of an existing Configuration description: 'This method returns the specified by number version of a given configuration Required permissions: Following permissions are required: FinancialAnalysisConfigurationAccess' operationId: GetConfigurationVersionByVersionNumber parameters: - name: configurationId in: path description: The Id of existing model required: true schema: type: string - name: versionNumber in: path description: The version number to retrieve required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A Configuration version is returned content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_4' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_4' example: data: {} messages: - message: Not Found. Configuration with given version number does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_4' 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_4' 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_4' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/configuration/{configurationId}/version/{versionNumber}/submit-for-approval: put: tags: - Configuration summary: Submit an existing Version of a Financial Analysis Configuration for Approval description: 'This method submits the selected version of an existing Configuration for Approval. Required permissions: Following permissions are required: FinancialAnalysisConfigurationCreate' operationId: SubmitConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to submit required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Configuration with given ID does not exists 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/configuration/{configurationId}/version/{versionNumber}/sign: put: tags: - Configuration summary: Sign an existing Version of a Financial Analysis Configuration description: 'This method signs the selected version of an existing Financial Analysis Configuration. The Status of the version changes according to the action sent (Approve/Reject). Required permissions: Following permissions are required: FinancialAnalysisConfigurationApprove' operationId: SignConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to sign required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data content: application/json: schema: $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/ConfigurationVersionSignedResponseDtoServiceResponse' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Configuration with given ID does not exists 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/configuration/{configurationId}/version/{versionNumber}/archive: put: tags: - Configuration summary: Archive an existing Version of a Financial Analysis Configuration description: 'This method archives the selected version of an existing Financial Analysis Configuration. Required permissions: Following permissions are required: FinancialAnalysisConfigurationArchive' operationId: ArchiveConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to archive required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Configuration with given ID does not exists 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/v2/configuration/provider: post: tags: - Configuration summary: Add a non 'Out Of The Box' Provider to an Existing Configuration description: 'This method adds a new provider to an existing configuration Required to add a configuration set that will be added as the default one Schema requirements: The additionalSettingsSchema must match the addicionalSettings inside the deafultConfigurationSet. A `Toggle'' cannot be mandatory. All fields enabled by any other field should be of type ''TextInput''. All fields used in EnabledBy should be of type ''Toggle''. Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: AddProviderV2 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: Add provider request content: application/json: schema: allOf: - $ref: '#/components/schemas/AddProviderDtoServiceRequest' responses: '202': description: Success. Provider added '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v2/configuration/provider/{providerId}/settings-schema: put: tags: - Configuration summary: Update the Provider Configuration Additional Settings Schema inside a specific… description: 'This method updates the additional settings schema of a specified provider Schema requirements: A `Toggle'' cannot be mandatory. All fields enabled by any other field should be of type ''TextInput''. All fields used in EnabledBy should be of type ''Toggle''. Adding a new property to the schema will set its value in the configuration set to the default (depending on the type) in all configuration sets. Removing a property from the schema will remove it from all the configuration sets. The options for the type are ''Toggle'' or ''TextInput''. Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: UpdateProviderSettingsSchemaV2 parameters: - name: providerId in: path description: Id of the provider 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: Data of the schema to be updated content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateSettingsSchemaDtoServiceRequest' responses: '202': description: Success. Configuration updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v2/configuration/provider/{providerId}/configuration-set: post: tags: - Configuration summary: Add a Configuration Set to an Existing Provider Configuration description: 'This method adds a new configuration set to an existing provider AdditionalSettings must match the AdditionalSettingsSchema Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: AddConfigurationSetV2 parameters: - name: providerId in: path description: Id of the provider 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: Add configuration set request content: application/json: schema: allOf: - $ref: '#/components/schemas/ConfigurationSetDtoServiceRequest' responses: '202': description: Success. Provider added content: application/json: schema: $ref: '#/components/schemas/AddConfigurationSetResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v2/configuration/provider/{providerId}/configuration-set/{configurationSetId}: patch: tags: - Configuration summary: Update part of a Configuration Set from an Existing Provider Configuration description: 'This method patches part of an existing configuration set of an existing provider AdditionalSettings must match the AdditionalSettingsSchema Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: PatchConfigurationSetV2 parameters: - name: providerId in: path description: Id of the provider required: true schema: type: string - name: configurationSetId in: path description: Id of the configuration set 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: Patch configuration set request content: application/json: schema: allOf: - $ref: '#/components/schemas/PatchConfigurationSetDtoServiceRequest' responses: '202': description: Success. Provider added '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - Configuration summary: Delete a Configuration Set in a Provider from an Existing Configuration description: 'This method deletes a configuration set in a specific provider from the existing configuration The default configuration set cannot be deleted If you want to delete the default configuration set, set another one as default first Required permissions: Following permissions are required: ScreeningConfigurationDelete, ScreeningConfigurationAccess' operationId: DeleteConfigurationSetV2 parameters: - name: providerId in: path description: Id of provider which contains the configuration set to be deleted from configuration required: true schema: type: string - name: configurationSetId in: path description: Id of the configuration set 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. Configuration set deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v2/configuration/provider/{providerId}/test: post: tags: - Configuration summary: Test provider credentials and connection description: 'This method checks if the given provider credentials and default configuration set are correct and a connection to the provider can be made Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: TestProviderV2 parameters: - name: providerId in: path description: Id of the provider required: true schema: type: string - name: configurationSetId in: query description: "Id of the configurationSet that will be used to do the test request to the adapter.\n If it's not provided, the default configuration set will be used" 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. Test requested content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v2/configuration/screening-results-view: post: tags: - Configuration summary: Add new screening results view configuration description: 'Required permissions: Following permissions are required: ScreeningConfigurationCreate, ScreeningConfigurationAccess' operationId: AddScreeningResultsViewConfiguration 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: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ScreeningResultsViewDtoServiceRequest' responses: '202': description: Success. Screening results view configuration added content: application/json: schema: $ref: '#/components/schemas/AddScreeningResultsViewResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/AddScreeningResultsViewResponseDto' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v2/configuration/screening-results-view/{entityType}/user-selection: post: tags: - Configuration summary: Add or update the user selected view description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: SaveScreeningResultsViewUserSelection parameters: - name: entityType in: path description: Individual or Company 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: Selected screening results view id content: application/json: schema: allOf: - $ref: '#/components/schemas/SaveScreeningResultsViewUserSelectionDto' responses: '202': description: Success. Screening results view configuration added content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - Configuration summary: Deletes the view selected by the user, reverting the configuration back to the… description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: DeleteScreeningResultsViewUserSelection parameters: - name: entityType in: path description: Individual or Company 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. Screening results view user selection has been deleted. '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: The requested resource was not found because the request parameters are missing or invalid. type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v2/configuration/screening-results-view/{screeeningResultsViewId}: put: tags: - Configuration summary: Update selected screening results view configuration description: 'Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: EditScreeningResultsViewConfiguration parameters: - name: screeeningResultsViewId in: path description: View Id 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: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateScreeningResultsViewDtoServiceRequest' responses: '202': description: Success. Screening results view configuration updated. content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - Configuration summary: Delete selected screening results view configuration description: 'Required permissions: Following permissions are required: ScreeningConfigurationDelete, ScreeningConfigurationAccess' operationId: DeleteScreeningResultsViewConfiguration parameters: - name: screeeningResultsViewId in: path description: View Id 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. Screening results view configuration deleted. '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_3' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_5' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_5' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v3/configuration: post: tags: - Configuration summary: Create a new Screening Configuration description: 'This method creates the configuration V2 for a tenant with default providers Required permissions: Following permissions are required: ScreeningConfigurationCreate, ScreeningConfigurationAccess' operationId: postApiV3Configuration 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 responses: '202': description: Success. Configuration created '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateConfigurationV2 patch: tags: - Configuration summary: Update part of an existing Screening Configuration description: 'This method updates part of an existing screening configuration Please note that currently only the ''CommentsMandatory'' property can be updated with this endpoint To update other parameters specific to a particular provider, please refer to the other endpoints in this API Any fields in the request that are not sent or are sent as null will keep their current value. As mentioned, this currently only applies to the ''CommentsMandatory'' property Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: patchApiV3Configuration 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: Data with which to update the Screening Configuration content: application/json: schema: allOf: - $ref: '#/components/schemas/PatchConfigurationV2DtoServiceRequest' responses: '202': description: Success. Configuration updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: PatchConfigurationV2 get: tags: - Configuration summary: Get data of an existing configuration description: 'This method gets all the configuration data for a given tenant ID. The method returns the configuration object. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: GetConfigurationV3 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 responses: '200': description: Success. The configuration data is returned content: application/json: schema: $ref: '#/components/schemas/ConfigurationDtoV2ServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: Not found. The configuration couldn't be found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_7' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v3/configuration/provider: post: tags: - Configuration summary: Add a non 'Out Of The Box' Provider to an Existing Configuration description: 'This method adds a new provider to an existing configuration Required to add a configuration set that will be added as the default one Schema requirements: The additionalSettingsSchema must match the addicionalSettings inside the deafultConfigurationSet. A `Toggle'' cannot be mandatory. All fields enabled by any other field should be of type ''TextInput''. All fields used in EnabledBy should be of type ''Toggle''. Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: postApiV3ConfigurationProvider 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: Add provider request content: application/json: schema: allOf: - $ref: '#/components/schemas/AddProviderDtoServiceRequest' responses: '202': description: Success. Provider added '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: AddProviderV2 servers: - url: /screeningcommand /api/v3/configuration/provider/{providerId}: patch: tags: - Configuration summary: Update part of the Provider Configuration inside a specific provider description: 'This method updates part of the configuration of a specified provider Credential and Ongoing Screening properties must be null or empty for non ''Out Of The Box'' providers The fields in the request model that are not sent or are sent as null will keep their current value Only properties'' values can be modified Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: patchApiV3ConfigurationProviderByProviderId parameters: - name: providerId in: path description: Id of the provider 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: Data of the provider to be updated content: application/json: schema: allOf: - $ref: '#/components/schemas/PatchProviderDtoV2ServiceRequest' responses: '202': description: Success. Configuration updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: PatchProviderV2 delete: tags: - Configuration summary: Delete a Provider from an Existing Configuration description: 'This method deletes a provider from the existing configuration ''Out Of The Box'' providers cannot be deleted Required permissions: Following permissions are required: ScreeningConfigurationDelete, ScreeningConfigurationAccess' operationId: deleteApiV3ConfigurationProviderByProviderId parameters: - name: providerId in: path description: Id of provider to be deleted from configuration 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. Provider deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteProviderV2 get: tags: - Configuration summary: Get provider from configuration description: 'This method gets a specific configuration for a given provider and tenant ID. The method returns the provider configuration object. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: GetProviderV3 parameters: - name: providerId in: path description: The ID of provider 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProviderDtoV2ServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_7' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v3/configuration/provider/{providerId}/settings-schema: put: tags: - Configuration summary: Update the Provider Configuration Additional Settings Schema inside a specific… description: 'This method updates the additional settings schema of a specified provider Schema requirements: A `Toggle'' cannot be mandatory. All fields enabled by any other field should be of type ''TextInput''. All fields used in EnabledBy should be of type ''Toggle''. Adding a new property to the schema will set its value in the configuration set to the default (depending on the type) in all configuration sets. Removing a property from the schema will remove it from all the configuration sets. The options for the type are ''Toggle'' or ''TextInput''. Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: putApiV3ConfigurationProviderByProviderIdSettingsSchema parameters: - name: providerId in: path description: Id of the provider 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: Data of the schema to be updated content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateSettingsSchemaDtoServiceRequest' responses: '202': description: Success. Configuration updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateProviderSettingsSchemaV2 servers: - url: /screeningcommand /api/v3/configuration/provider/{providerId}/configuration-set: post: tags: - Configuration summary: Add a Configuration Set to an Existing Provider Configuration description: 'This method adds a new configuration set to an existing provider AdditionalSettings must match the AdditionalSettingsSchema Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: postApiV3ConfigurationProviderByProviderIdConfigurationSet parameters: - name: providerId in: path description: Id of the provider 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: Add configuration set request content: application/json: schema: allOf: - $ref: '#/components/schemas/ConfigurationSetDtoServiceRequest' responses: '202': description: Success. Provider added content: application/json: schema: $ref: '#/components/schemas/AddConfigurationSetResponseDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: AddConfigurationSetV2 servers: - url: /screeningcommand /api/v3/configuration/provider/{providerId}/configuration-set/{configurationSetId}: patch: tags: - Configuration summary: Update part of a Configuration Set from an Existing Provider Configuration description: 'This method patches part of an existing configuration set of an existing provider AdditionalSettings must match the AdditionalSettingsSchema Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: patchApiV3ConfigurationProviderByProviderIdConfigurationSetByConfigurationSetId parameters: - name: providerId in: path description: Id of the provider required: true schema: type: string - name: configurationSetId in: path description: Id of the configuration set 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: Patch configuration set request content: application/json: schema: allOf: - $ref: '#/components/schemas/PatchConfigurationSetDtoServiceRequest' responses: '202': description: Success. Provider added '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: PatchConfigurationSetV2 delete: tags: - Configuration summary: Delete a Configuration Set in a Provider from an Existing Configuration description: 'This method deletes a configuration set in a specific provider from the existing configuration The default configuration set cannot be deleted If you want to delete the default configuration set, set another one as default first Required permissions: Following permissions are required: ScreeningConfigurationDelete, ScreeningConfigurationAccess' operationId: deleteApiV3ConfigurationProviderByProviderIdConfigurationSetByConfigurationSetId parameters: - name: providerId in: path description: Id of provider which contains the configuration set to be deleted from configuration required: true schema: type: string - name: configurationSetId in: path description: Id of the configuration set 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. Configuration set deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteConfigurationSetV2 servers: - url: /screeningcommand /api/v3/configuration/provider/{providerId}/test: post: tags: - Configuration summary: Test provider credentials and connection description: 'This method checks if the given provider credentials and default configuration set are correct and a connection to the provider can be made Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: postApiV3ConfigurationProviderByProviderIdTest parameters: - name: providerId in: path description: Id of the provider required: true schema: type: string - name: configurationSetId in: query description: "Id of the configurationSet that will be used to do the test request to the adapter.\n If it's not provided, the default configuration set will be used" 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. Test requested content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: TestProviderV2 servers: - url: /screeningcommand /api/v3/configuration/screening-results-view: post: tags: - Configuration summary: Add new screening results view configuration description: 'Required permissions: Following permissions are required: ScreeningConfigurationCreate, ScreeningConfigurationAccess' operationId: postApiV3ConfigurationScreeningResultsView 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: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ScreeningResultsViewDtoServiceRequest' responses: '202': description: Success. Screening results view configuration added content: application/json: schema: $ref: '#/components/schemas/AddScreeningResultsViewResponseDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/AddScreeningResultsViewResponseDto' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: AddScreeningResultsViewConfiguration servers: - url: /screeningcommand /api/v3/configuration/screening-results-view/{entityType}/user-selection: post: tags: - Configuration summary: Add or update the user selected view description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: postApiV3ConfigurationScreeningResultsViewByEntityTypeUserSelection parameters: - name: entityType in: path description: Individual or Company 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: Selected screening results view id content: application/json: schema: allOf: - $ref: '#/components/schemas/SaveScreeningResultsViewUserSelectionDto' responses: '202': description: Success. Screening results view configuration added content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SaveScreeningResultsViewUserSelection delete: tags: - Configuration summary: Deletes the view selected by the user, reverting the configuration back to the… description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: deleteApiV3ConfigurationScreeningResultsViewByEntityTypeUserSelection parameters: - name: entityType in: path description: Individual or Company 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. Screening results view user selection has been deleted. '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: The requested resource was not found because the request parameters are missing or invalid. type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteScreeningResultsViewUserSelection get: tags: - Configuration summary: Return view details, including selected fields, that is selected for the user… description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: GetScreeningResultsUserViewSelection parameters: - name: entityType in: path description: Individual or Company 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScreeningResultsViewDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_7' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v3/configuration/screening-results-view/{screeeningResultsViewId}: put: tags: - Configuration summary: Update selected screening results view configuration description: 'Required permissions: Following permissions are required: ScreeningConfigurationEdit, ScreeningConfigurationAccess' operationId: putApiV3ConfigurationScreeningResultsViewByScreeeningResultsViewId parameters: - name: screeeningResultsViewId in: path description: View Id 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: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateScreeningResultsViewDtoServiceRequest' responses: '202': description: Success. Screening results view configuration updated. content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: EditScreeningResultsViewConfiguration delete: tags: - Configuration summary: Delete selected screening results view configuration description: 'Required permissions: Following permissions are required: ScreeningConfigurationDelete, ScreeningConfigurationAccess' operationId: deleteApiV3ConfigurationScreeningResultsViewByScreeeningResultsViewId parameters: - name: screeeningResultsViewId in: path description: View Id 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. Screening results view configuration deleted. '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_4' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_6' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_6' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteScreeningResultsViewConfiguration get: tags: - Configuration summary: Return view details, including selected fields, by view Id description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: GetScreeningResultsViewById parameters: - name: screeeningResultsViewId in: path description: view Id 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/ScreeningResultsViewDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_7' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningcommand /api/v3/configuration/lite: get: tags: - Configuration summary: Get a lite version of the data of an existing configuration description: 'This method gets a lite version of the the configuration data for a given tenant ID. The method returns the configuration lite object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetConfigurationLiteV3 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 responses: '200': description: Success. The configuration data is returned content: application/json: schema: $ref: '#/components/schemas/ConfigurationLiteDtoV2ServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: Not found. The configuration couldn't be found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_7' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningquery /api/v3/configuration/screening-results-view/{entityType}: get: tags: - Configuration summary: Return list of all views for Individual or Company description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: GetAllScreeningResultsViewsConfiguration parameters: - name: entityType in: path description: Individual or Company 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScreeningResultsViewDtoIEnumerableServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_7' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningquery /api/v3/configuration/screening-results-view/{entityType}/available-fields: get: tags: - Configuration summary: Return list of available fields for Individual or Company description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: GetScreeningResultsViewAvailableFields parameters: - name: entityType in: path description: Individual or Company 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScreeningResultsFieldConfigDtoIEnumerableServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_7' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_7' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningquery /api/v4/configuration: get: tags: - Configuration summary: Get data of an existing configuration description: 'This method gets all the configuration data for a given tenant ID. The method returns the configuration object. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: getApiV4Configuration 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 responses: '200': description: Success. The configuration data is returned content: application/json: schema: $ref: '#/components/schemas/ConfigurationDtoV2ServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_6' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not found. The configuration couldn't be found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetConfigurationV3 servers: - url: /screeningquery /api/v4/configuration/lite: get: tags: - Configuration summary: Get a lite version of the data of an existing configuration description: 'This method gets a lite version of the the configuration data for a given tenant ID. The method returns the configuration lite object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV4ConfigurationLite 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 responses: '200': description: Success. The configuration data is returned content: application/json: schema: $ref: '#/components/schemas/ConfigurationLiteDtoV2ServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_6' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not found. The configuration couldn't be found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetConfigurationLiteV3 servers: - url: /screeningquery /api/v4/configuration/provider/{providerId}: get: tags: - Configuration summary: Get provider from configuration description: 'This method gets a specific configuration for a given provider and tenant ID. The method returns the provider configuration object. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: getApiV4ConfigurationProviderByProviderId parameters: - name: providerId in: path description: The ID of provider 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProviderDtoV2ServiceResponse_2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_6' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetProviderV3 servers: - url: /screeningquery /api/v4/configuration/screening-results-view/{entityType}: get: tags: - Configuration summary: Return list of all views for Individual or Company description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV4ConfigurationScreeningResultsViewByEntityType parameters: - name: entityType in: path description: Individual or Company 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScreeningResultsViewDtoIEnumerableServiceResponse_2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_6' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAllScreeningResultsViewsConfiguration servers: - url: /screeningquery /api/v4/configuration/screening-results-view/{screeeningResultsViewId}: get: tags: - Configuration summary: Return view details, including selected fields, by view Id description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV4ConfigurationScreeningResultsViewByScreeeningResultsViewId parameters: - name: screeeningResultsViewId in: path description: view Id 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/ScreeningResultsViewDtoServiceResponse_2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_6' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetScreeningResultsViewById servers: - url: /screeningquery /api/v4/configuration/screening-results-view/{entityType}/available-fields: get: tags: - Configuration summary: Return list of available fields for Individual or Company description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV4ConfigurationScreeningResultsViewByEntityTypeAvailableFields parameters: - name: entityType in: path description: Individual or Company 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScreeningResultsFieldConfigDtoIEnumerableServiceResponse_2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_6' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetScreeningResultsViewAvailableFields servers: - url: /screeningquery /api/v4/configuration/screening-results-view/{entityType}/user-selection: get: tags: - Configuration summary: Return view details, including selected fields, that is selected for the user… description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV4ConfigurationScreeningResultsViewByEntityTypeUserSelection parameters: - name: entityType in: path description: Individual or Company 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: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ScreeningResultsViewDtoServiceResponse_2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_6' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetScreeningResultsUserViewSelection servers: - url: /screeningquery components: schemas: ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' 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 example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code CreateConfigurationResponseDto: type: object properties: id: type: string format: uuid additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error CreateConfigurationResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateConfigurationResponseDto' 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 UpdateConfigurationAutomaticReOnboardingDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateConfigurationAutomaticReOnboardingDto' description: The service request DTO additionalProperties: false description: Service request data 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 UpdateConfigurationAutomaticReOnboardingDto: type: object properties: automaticReOnboarding: type: boolean additionalProperties: false UpdateConfigurationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateConfigurationDto' description: The service request DTO additionalProperties: false description: Service request data UpdateConfigurationDto: type: object properties: automaticOffboarding: type: boolean additionalProperties: false 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 ConfigurationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationDto' 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 ConfigurationDto: type: object properties: id: type: - string - 'null' format: uuid automaticOffboarding: type: boolean automaticReOnboarding: type: boolean additionalProperties: false BooleanServiceResponse: type: object properties: data: type: boolean 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 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 SaveProviderConfigurationResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/SaveProviderConfigurationResponseDto' 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 BooleanServiceRequest: type: object properties: data: type: boolean description: The service request DTO additionalProperties: false description: Service request data ProviderConfigurationDto: type: object properties: configuration: type: - object - 'null' additionalProperties: {} additionalProperties: false SaveProviderConfigurationResponseDto: type: object properties: status: type: - string - 'null' enabled: type: boolean additionalProperties: false ProviderConfigurationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderConfigurationDto' description: The service request DTO additionalProperties: false description: Service request data ValueType: enum: - String - Number type: string ConfigurationDto_2: type: object properties: providersConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationDto_2' additionalProperties: false SchemaEntry: type: object properties: name: type: - string - 'null' friendlyName: type: - string - 'null' value: {} type: allOf: - $ref: '#/components/schemas/ValueType' masked: type: boolean nullable: type: boolean mandatory: type: boolean additionalProperties: false ProviderConfigurationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderConfigurationDto_2' 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 ProviderConfigurationDto_2: type: object properties: id: type: string format: uuid name: type: - string - 'null' status: type: - string - 'null' enabled: type: boolean localConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/SchemaEntry' globalConfiguration: type: - object - 'null' additionalProperties: {} additionalProperties: false ConfigurationDto_3: type: object properties: providersConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationDto_3' additionalProperties: false ProviderConfigurationDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderConfigurationDto_3' 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 ProviderConfigurationDto_3: type: object properties: id: type: string format: uuid name: type: - string - 'null' status: type: - string - 'null' enabled: type: boolean localConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/SchemaEntry' globalConfiguration: type: - object - 'null' additionalProperties: {} additionalProperties: false ValidationErrorModelListServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code UpdateDocumentConfigurationRequestDto: type: object properties: isWaiveCommentMandatory: type: boolean description: The status of waive mandatory comments isDeferCommentMandatory: type: boolean description: The status of defer mandatory comments additionalDocumentMetadataColumnsDataKeys: type: - array - 'null' items: type: string description: List of data keys for additional document metadata columns that can be configured and displayed example: - isThisDocumentIgoNigo - nameOfSignatory1 expiryDateDataKeys: type: - array - 'null' items: type: string description: List of data keys for expiry date fields in document metadata example: - dateOfExpiry restrictedDocumentFileTypes: type: - array - 'null' items: type: string description: List of restricted document file type extensions that are blocked from upload example: - .pptx - .mp4 - .msg maximumFileSizeMb: type: - integer - 'null' description: Maximum allowed file size in megabytes. Null means no limit. format: int32 example: 25 additionalProperties: false description: Document configuration update request model. ValidationErrorModel_2: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ServiceResponseMessage_2: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UpdateDocumentConfigurationRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateDocumentConfigurationRequestDto' description: Document configuration update request model. additionalProperties: false ObjectServiceResponse_2: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false StringServiceResponse_2: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false ConfigurationDtoServiceResponse_2: type: object properties: data: $ref: '#/components/schemas/ConfigurationDto_4' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false ConfigurationVersionSignedResponseDto: type: object properties: configurationId: type: string description: The Id of the configuration the version belongs to format: uuid versionNumber: type: integer description: The version number that has been signed format: int32 status: $ref: '#/components/schemas/VersionStatus' additionalProperties: false description: Contains the new version Status, after a version sign operation Signee: type: object properties: subject: type: - string - 'null' successor: $ref: '#/components/schemas/Approver' action: $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false ConfigurationClonedResponseDto: type: object properties: configurationId: type: string description: Id of cloned configuration format: uuid example: c18a8634-b259-46fc-90c2-19ff2b24d85e additionalProperties: false description: Configuration Clone response data ConfigurationClonedResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/ConfigurationClonedResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false ConfigurationDto_4: type: object properties: id: type: string description: Financial Analysis Configuration Id format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 versionNumber: type: integer description: Version Number format: int32 example: 1 name: type: - string - 'null' description: Financial Configuration's name example: Version 1 periodType: type: - string - 'null' description: Type of Period example: Year numberOfPreviousPeriods: type: integer description: Number of previous periods format: int32 example: 5 startDate: type: string description: Start date of period references format: date-time example: '2022-10-10T00:00:00.000Z' prefix: type: - string - 'null' description: Prefix you want to set before period references example: FY dataGroups: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupDto' description: List of data groups conditionOperators: type: - array - 'null' items: $ref: '#/components/schemas/ConditionOperatorDto' description: List of scoping conditions effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2022-10-10T00:00:00.000Z' created: type: string description: The creation date of the version (Read-only) Configuration format: date-time signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees/approvals of the version financialAnalysisType: type: - string - 'null' description: Determines the configuration is for Actual or Scenario minimumColumns: type: - integer - 'null' description: Minimum number of period columns. This will be applied only for Scenario. format: int32 maximumColumns: type: - integer - 'null' description: Maximum number of period columns. This will be applied only for Scenario. format: int32 additionalProperties: false description: Financial Group Configuration Representation ConfigurationDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/ConfigurationDto_4' additionalProperties: false DataGroupDto: type: object properties: dataGroupId: type: string description: Data group Id format: uuid example: c92b1280-8457-4082-ae8b-4c9e6678a49d versionNumber: type: integer description: Version of the data group format: int32 example: 1 additionalProperties: false description: Set of properties which define a data group ConditionOperatorDto: type: object properties: id: type: string description: Id format: uuid example: 38c8bc5c-364a-4213-a1e9-7fc5541de823 logicalOperator: type: - string - 'null' description: Logical operator example: And conditionName: type: - string - 'null' description: Condition Name example: APAC Agricultural Company conditionDescription: type: - string - 'null' description: Condition Description example: Entity type and company requirements conditionOperatorItems: type: - array - 'null' items: $ref: '#/components/schemas/ConditionOperatorItemDto' description: Condition Operator Items additionalProperties: false description: Set of properties which define a Scoping Condition Operator ServiceResponse_2: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false ConfigurationVersionSignedResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/ConfigurationVersionSignedResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false Decision: enum: - Approve - Reject type: string ConfigurationCloneRequestDto: type: object properties: name: type: - string - 'null' description: Name of cloned configuration example: Configuration Clone additionalProperties: false description: Configuration Clone response data ApproveActionServiceRequest: type: object properties: data: $ref: '#/components/schemas/ApproveAction' additionalProperties: false ConfigurationVersionDto: type: object properties: configurationId: type: string description: Financial Analysis Configuration Id format: uuid example: 22bf9ef9-0535-4d9b-a61e-9945cdf508cb name: type: - string - 'null' description: Financial Configuration's name example: F1 periodType: type: - string - 'null' description: Type of Period example: Year numberOfPreviousPeriods: type: integer description: Number of previous periods format: int32 example: 5 startDate: type: string description: Start date of period references format: date-time example: '2022-10-10T00:00:00.000Z' prefix: type: - string - 'null' description: Prefix you want to set before period references example: FY dataGroups: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupDto' description: List of data groups conditionOperators: type: - array - 'null' items: $ref: '#/components/schemas/ConditionOperatorDto' description: List of scoping conditions versionNumber: type: integer description: Version Number format: int32 example: 2 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-12-12T15:55:00.000Z' signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees/approvals of the version financialAnalysisType: type: - string - 'null' description: Determines the configuration is for Actual or Scenario minimumColumns: type: - integer - 'null' description: Minimum number of period columns. This will be applied only for Scenario. format: int32 maximumColumns: type: - integer - 'null' description: Maximum number of period columns. This will be applied only for Scenario. format: int32 additionalProperties: false description: Set of properties which define new version of Financial Group Configuration ObjectServiceResponse_3: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false StringServiceResponse_3: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false Approver: type: object properties: subject: type: - string - 'null' successor: $ref: '#/components/schemas/Approver' action: $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false ValidationErrorModelListServiceResponse_3: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_3' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConditionOperatorItemDto: type: object properties: id: type: string description: Id format: uuid example: 8be001f1-2120-49ff-b4ca-87cb279ae7b7 dataSource: type: - string - 'null' description: 'Source of Datakey: currentEntity' example: currentEntity dataKey: type: - string - 'null' description: Datakey example: entityType logicalOperator: type: - string - 'null' description: 'Logical Operator includes: Equals, NotEquals, In, NotIn, Defined, NotDefined' example: Equals value: type: - array - 'null' items: type: string description: Assigned Value example: - Company valueType: type: - string - 'null' description: 'Value Type: text, select, multiselect, number, date' example: text additionalProperties: false description: Set of properties which define a Condition Operator Item ValidationErrorModel_3: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string ServiceResponseMessage_3: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConfigurationCloneRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/ConfigurationCloneRequestDto' additionalProperties: false ConfigurationVersionDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/ConfigurationVersionDto' additionalProperties: false ApproveAction: type: object properties: comment: type: - string - 'null' decision: $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false ConfigurationVersionDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/ConfigurationVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false Approver_2: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver_2' action: allOf: - $ref: '#/components/schemas/ApproveAction_2' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false ValidationErrorModelListServiceResponse_4: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_4' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConfigurationDto_5: type: object properties: id: type: string description: Configuration Id format: uuid example: df484b73-eadb-40af-8f61-2a6ca7e9d6d6 versions: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationVersionDto_2' description: List of available configuration versions additionalProperties: false description: Configuration Data ConfigurationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationDto_5' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false ValidationErrorModel_4: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ServiceResponseMessage_4: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false Signee_2: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver_2' action: allOf: - $ref: '#/components/schemas/ApproveAction_2' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false ApproveAction_2: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false ConfigurationVersionDto_2: type: object properties: id: type: string description: The UiD of the version format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 configurationId: type: string description: Financial Analysis Configuration Id format: uuid example: 22bf9ef9-0535-4d9b-a61e-9945cdf508cb name: type: - string - 'null' description: Financial Configuration's name example: F1 periodType: type: - string - 'null' description: Type of Period example: Year numberOfPreviousPeriods: type: integer description: Number of previous periods format: int32 example: 5 startDate: type: string description: Start date of period references format: date-time example: '2022-10-10T00:00:00.000Z' prefix: type: - string - 'null' description: Prefix you want to set before period references example: FY dataGroups: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupDto' description: List of data groups example: - expenseType - incomeType - assetType conditionOperators: type: - array - 'null' items: $ref: '#/components/schemas/ConditionOperatorDto' description: List of scooping conditions versionNumber: type: integer description: Version Number format: int32 example: 2 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-12-12T15:55:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-12-12T15:55:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft created: type: string description: The creation date of the version format: date-time example: '2021-12-12T15:55:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s active version at the time of the query' example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee_2' description: The defined list of signees/approvals of the version financialAnalysisType: type: - string - 'null' description: Determines the configuration is for Actual or Scenario minimumColumns: type: - integer - 'null' description: Minimum number of period columns. This will be applied only for Scenario. format: int32 maximumColumns: type: - integer - 'null' description: Maximum number of period columns. This will be applied only for Scenario. format: int32 additionalProperties: false description: Instance of Configuration Version ConfigurationVersionDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationVersionDto_2' description: Instance of Configuration Version messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false ObjectServiceResponse_4: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false StringServiceResponse_4: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false ConfigurationDto_6: type: object properties: id: type: string format: uuid tenant: type: - string - 'null' stages: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationStageDto' created: type: string format: date-time defaultEntityType: allOf: - $ref: '#/components/schemas/EntityType' userExperienceType: allOf: - $ref: '#/components/schemas/UserExperience' overwrittenStages: type: - object - 'null' properties: Individual: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' Company: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' Other: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' EntityGroup: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' Product: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' additionalProperties: false additionalProperties: false UserExperience: enum: - Standard - ExternalProviderEnhanced type: string CreateConfigurationRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateConfigurationRequestDto' description: The service request DTO additionalProperties: false description: Service request data CreateConfigurationRequestDto: type: object properties: stages: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationStageDto' defaultEntityType: allOf: - $ref: '#/components/schemas/EntityType' userExperienceType: allOf: - $ref: '#/components/schemas/UserExperience' overwrittenStages: type: - object - 'null' properties: Individual: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' Company: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' Other: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' EntityGroup: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' Product: type: array items: $ref: '#/components/schemas/ConfigurationStageDto' additionalProperties: false additionalProperties: false ConfigurationStageType: enum: - ClientDetails - DuplicateCheck - ExternalDataCheck - Confirmation type: string EntityType: enum: - Individual - Company - Other - EntityGroup - Product type: string ConfigurationStageDto: type: object properties: type: allOf: - $ref: '#/components/schemas/ConfigurationStageType' name: type: - string - 'null' order: type: integer format: int32 data: {} additionalProperties: false ConfigurationSetPropertyDto: type: object properties: fieldId: type: - string - 'null' description: Internal name used to identify the Configuration Set property example: AcceptListId value: type: - string - 'null' description: Value of Configuration Set property example: '123' additionalProperties: false description: Class to represent Configuration Set property associated with the Provider AddConfigurationSetResponseDto: type: object properties: configurationSetId: type: string description: The UiD of the configuration set created format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 additionalProperties: false description: DTO representing the response data of the AddConfigurationSet endpoint PatchProviderDtoV2: type: object properties: name: type: - string - 'null' description: Name of the Screening Provider example: ProviderName adapterConfiguration: allOf: - $ref: '#/components/schemas/PatchAdapterConfigurationDtoV2' description: Adapter Configuration associated with Screening Provider secondaryIdentifiers: allOf: - $ref: '#/components/schemas/PatchSecondaryIdentifiersDto' description: Configuration to set which fields will be sent in the SearchCriteria of a new Screening request via the Screening Request task supportingDocumentConfiguration: allOf: - $ref: '#/components/schemas/PatchSupportingDocumentConfigurationDto' description: Supporting document configuration associated with the Screening Provider defaultConfigurationSetId: type: - string - 'null' description: The Default Configuration Set Id for the Screening Provider example: 12194f6f-feea-4929-8d8e-ed48d47494e5 active: type: - boolean - 'null' description: If the Provider is active example: true additionalProperties: false PatchSupportingDocumentConfigurationDto: type: object properties: entityActionItem: allOf: - $ref: '#/components/schemas/PatchEntityActionItemConfigDto' description: Entity action item supporting document configuration. Null means it is turned off. hitField: allOf: - $ref: '#/components/schemas/PatchHitFieldConfigDto' description: Hit field supporting document configuration. Null means it is turned off. additionalProperties: false description: 'Supporting document configuration associated with the screening provider. Omitting this object entirely from the patch request (leaving it null) leaves the existing supporting document configuration untouched. Supplying the object with both Fenergo.Nebula.Screening.Command.Application.Dto.Configuration.PatchSupportingDocumentConfigurationDto.EntityActionItem and Fenergo.Nebula.Screening.Command.Application.Dto.Configuration.PatchSupportingDocumentConfigurationDto.HitField null (an empty object) is treated as an explicit instruction to clear the entire supporting document configuration for the provider. ' ConfigurationSetDto: required: - description - name type: object properties: name: minLength: 1 type: string description: Name used to identify the Configuration Set example: Default description: minLength: 1 type: string description: Description of the Configuration Set example: Default Configuration Set additionalSettings: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetPropertyDto' description: Additional Settings for the Configuration Set additionalProperties: false description: Class to represent a Configuration Set associated with the Provider PatchAdapterConfigurationDtoV2: type: object properties: url: type: - string - 'null' description: URL address of the Screening Adapter example: https://api.fenergonebula.com/lnadaptercommand authenticationActive: type: - boolean - 'null' description: Flag to indicate if the Adapter authentication is enabled example: false authenticationKey: allOf: - $ref: '#/components/schemas/SecurityKeyPatchDto' description: Base64 encoded key that will be used to authenticate the requests to / from the adapters encryptionKey: allOf: - $ref: '#/components/schemas/SecurityKeyPatchDto' description: Base64 encoded key that will be used to encrypt / decrypt the requests to / from the adapters credentialProperties: type: - array - 'null' items: $ref: '#/components/schemas/PatchProviderConfigurationPropertyDto' description: List of credential properties associated with the Screening Provider ongoingScreeningConfiguration: allOf: - $ref: '#/components/schemas/PatchOngoingScreeningConfigurationDto' description: List of Ongoing Screening Configuration associated with the Screening Provider additionalProperties: false AddEntityActionItemConfigDto: type: object properties: requirement: type: - string - 'null' description: Requirement level for the supporting document. example: Required documentType: type: - array - 'null' items: type: string description: Document types that can be uploaded. example: - Screening Evidence additionalProperties: false description: Entity action item supporting document configuration for add-provider requests. PatchConfigurationV2DtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PatchConfigurationV2Dto' additionalProperties: false SecurityKeyDto: required: - key type: object properties: key: minLength: 1 type: string description: Unique base64 encoded key example: HgyUHIO81m0FcZfPS1lnUw== additionalProperties: false description: Represents the security key that will be used to authenticate the requests to / from the adapters PatchProviderDtoV2ServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PatchProviderDtoV2' additionalProperties: false AddScreeningResultsViewResponseDto: type: object properties: screeningResultViewId: type: string format: uuid additionalProperties: false PatchEntityActionItemConfigDto: type: object properties: requirement: type: - string - 'null' description: Requirement level for the supporting document. example: Required documentType: type: - array - 'null' items: type: string description: Document types that can be uploaded. example: - Screening Evidence additionalProperties: false description: Entity action item supporting document configuration for patch-provider requests. UpdateSettingsSchemaDto: type: object properties: additionalSettingsSchema: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetPropertySchemaDto' description: Schema that describes any fields that should be configured as part of the AdditionalSettings in a ConfigurationSet for the Screening Provider additionalProperties: false ScreeningResultsViewColumnDto: type: object properties: accessor: type: - string - 'null' label: type: - string - 'null' visible: type: boolean order: type: integer format: int32 renderer: type: - string - 'null' additionalProperties: false AddScreeningResultsViewResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AddScreeningResultsViewResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false UpdateScreeningResultsViewDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScreeningResultsViewDto' additionalProperties: false AddProviderDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/AddProviderDto' description: 'Class to represent the request for AddProvider Contains required parameters to define AddProvider' additionalProperties: false AddSupportingDocumentConfigurationDto: type: object properties: entityActionItem: allOf: - $ref: '#/components/schemas/AddEntityActionItemConfigDto' description: Entity action item supporting document configuration. Null means it is turned off. hitField: allOf: - $ref: '#/components/schemas/AddHitFieldConfigDto' description: Hit field supporting document configuration. Null means it is turned off. additionalProperties: false description: Supporting document configuration associated with the screening provider. PatchOngoingScreeningConfigurationDto: type: object properties: active: type: - boolean - 'null' description: If Ongoing Screening is active example: true ongoingScreeningProperties: type: - array - 'null' items: $ref: '#/components/schemas/PatchProviderConfigurationPropertyDto' description: List of Ongoing Screening properties associated with the Screening Provider additionalProperties: false PatchConfigurationSetDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PatchConfigurationSetDto' description: Class to represent a Configuration Set associated with the Provider additionalProperties: false PatchSecondaryIdentifiersDto: type: object properties: firstName: type: - boolean - 'null' description: Whether the Individual's first name will be sent example: true middleName: type: - boolean - 'null' description: Whether the Individual's middle name will be sent example: false lastName: type: - boolean - 'null' description: Whether the Individual's last name will be sent example: true fullName: type: - boolean - 'null' description: Whether the Individual's full name will be sent example: false dateOfBirth: type: - boolean - 'null' description: Whether the Individual's date of birth will be sent example: false gender: type: - boolean - 'null' description: Whether the Individual's gender will be sent example: false address: allOf: - $ref: '#/components/schemas/PatchSecondaryIdentifiersAddressDto' description: Whether the Individual's Residential address or the Company's Registered address will be sent nationality: type: - boolean - 'null' description: Whether the Individual's nationality will be sent example: false placeOfBirth: type: - boolean - 'null' description: Whether the Individual's place of birth will be sent example: false citizenship: type: - boolean - 'null' description: Whether the Individual's citizenship will be sent example: false registeredCountry: type: - boolean - 'null' description: Whether the Company's registered country will be sent example: false uniqueId: type: - boolean - 'null' description: Whether the UniqueId will be sent example: false otherInformation: type: - boolean - 'null' description: Whether the Individual's or Company's other information will be sent example: false passportNumber: type: - boolean - 'null' description: Whether the Individual's passport number will be sent example: false socialSecurityNumber: type: - boolean - 'null' description: Whether the Individual's Social Security Number (SSN) will be sent example: false driversLicense: type: - boolean - 'null' description: Whether the Individual's driving license will be sent example: false employerIdentificationNumber: type: - boolean - 'null' description: Whether the Company's Employer Identification Number (EIN) will be sent example: false additionalProperties: false description: 'Class to represent the configuration for which fields will be sent in SearchCriteria on create new request via Screening Request task' PatchSecondaryIdentifiersAddressDto: type: object properties: addressLine1: type: - boolean - 'null' description: Whether the Address line 1 will be sent example: false addressLine2: type: - boolean - 'null' description: Whether the Address line 2 will be sent example: false city: type: - boolean - 'null' description: Whether the Address city will be sent example: false postalCode: type: - boolean - 'null' description: Whether the Address postal code will be sent example: false country: type: - boolean - 'null' description: Whether the Address country will be sent example: false stateProvince: type: - boolean - 'null' description: Whether the Address state province will be sent example: false type: type: - boolean - 'null' description: Whether the Address type will be sent example: false additionalProperties: false description: Represent the address fields that will be sent in SearchCriteria ServiceResponse_3: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false AddAdapterConfigurationDto: required: - url type: object properties: url: minLength: 1 type: string description: URL address of the Screening Adapter example: https://api.fenergonebula.com/lnadaptercommand authenticationActive: type: boolean description: Flag to indicate if the Adapter authentication is enabled example: false authenticationKey: allOf: - $ref: '#/components/schemas/SecurityKeyDto' description: Base64 encoded key that will be used to authenticate the requests to / from the adapters encryptionKey: allOf: - $ref: '#/components/schemas/SecurityKeyDto' description: Base64 encoded key that will be used to encrypt / decrypt the requests to / from the adapters ongoingScreeningConfiguration: allOf: - $ref: '#/components/schemas/AddOngoingScreeningConfigurationDto' description: Ongoing Screening Configuration associated with the Screening Provider additionalProperties: false description: Class to represent the Add Adapter Configuration SecondaryIdentifiersAddressDto: type: object properties: addressLine1: type: boolean description: Whether the Address line 1 will be sent example: false addressLine2: type: boolean description: Whether the Address line 2 will be sent example: false city: type: boolean description: Whether the Address city will be sent example: false postalCode: type: boolean description: Whether the Address postal code will be sent example: false country: type: boolean description: Whether the Address country will be sent example: false stateProvince: type: boolean description: Whether the Address state province will be sent example: false type: type: boolean description: Whether the Address type will be sent example: false additionalProperties: false description: Represent the address fields that will be sent in SearchCriteria ScreeningResultsViewDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ScreeningResultsViewDto' additionalProperties: false AddConfigurationSetResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AddConfigurationSetResponseDto' description: DTO representing the response data of the AddConfigurationSet endpoint messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false SecondaryIdentifiersDto: required: - address type: object properties: firstName: type: boolean description: Whether the Individual's first name will be sent example: true middleName: type: boolean description: Whether the Individual's middle name will be sent example: false lastName: type: boolean description: Whether the Individual's last name will be sent example: true fullName: type: boolean description: Whether the Individual's full name will be sent example: false dateOfBirth: type: boolean description: Whether the Individual's date of birth will be sent example: false gender: type: boolean description: Whether the Individual's gender will be sent example: false address: allOf: - $ref: '#/components/schemas/SecondaryIdentifiersAddressDto' description: Whether the Individual's Residential address or the Company's Registered address will be sent nationality: type: boolean description: Whether the Individual's nationality will be sent example: false placeOfBirth: type: boolean description: Whether the Individual's place of birth will be sent example: false citizenship: type: boolean description: Whether the Individual's citizenship will be sent example: false registeredCountry: type: boolean description: Whether the Company's registered country will be sent example: false uniqueId: type: boolean description: Whether the UniqueId will be sent example: false otherInformation: type: boolean description: Whether the Individual's or Company's other information will be sent example: false passportNumber: type: boolean description: Whether the individual's passport number will be sent example: false socialSecurityNumber: type: boolean description: Whether the Individual's Social Security Number (SSN) will be sent example: false driversLicense: type: boolean description: Whether the Individual's driving license will be sent example: false employerIdentificationNumber: type: boolean description: Whether the Company's Employer Identification Number (EIN) will be sent example: false additionalProperties: false description: 'Class to represent the configuration for which fields will be sent in SearchCriteria on create new request via Screening Request task' SecurityKeyPatchDto: required: - key type: object properties: key: minLength: 1 type: string description: Unique base64 encoded key example: HgyUHIO81m0FcZfPS1lnUw== additionalProperties: false description: Represents the security key that will be used to authenticate the requests to / from the adapters UpdateSettingsSchemaDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateSettingsSchemaDto' additionalProperties: false PatchProviderConfigurationPropertyDto: required: - fieldId - value type: object properties: fieldId: minLength: 1 type: string description: Internal name used to identify the Provider Configuration property example: ClientId value: minLength: 1 type: string description: Value of the Provider Configuration property example: xyz12345 additionalProperties: false PatchConfigurationV2Dto: type: object properties: commentsMandatory: type: - boolean - 'null' description: Setting to specify whether comments should be mandatory or optional for all UI interactions with Providers in the Screening Configuration example: true additionalProperties: false ObjectServiceResponse_5: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false StringServiceResponse_5: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false AddHitFieldConfigDto: type: object properties: documentType: type: - array - 'null' items: type: string description: Document types that can be uploaded. example: - Supporting Document additionalProperties: false description: Hit field supporting document configuration for add-provider requests. PatchHitFieldConfigDto: type: object properties: documentType: type: - array - 'null' items: type: string description: Document types that can be uploaded. example: - Supporting Document additionalProperties: false description: Hit field supporting document configuration for patch-provider requests. PatchConfigurationSetDto: type: object properties: name: type: - string - 'null' description: Name used to identify the Configuration Set example: Default description: type: - string - 'null' description: Description of the Configuration Set example: Default Configuration Set additionalSettings: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetPropertyDto' description: Additional Settings for the Configuration Set additionalProperties: false description: Class to represent a Configuration Set associated with the Provider AddProviderDto: required: - defaultConfigurationSet - id - name type: object properties: id: minLength: 1 type: string description: Id of the Screening Provider example: ProviderId name: minLength: 1 type: string description: Name of the Screening Provider example: ProviderName adapterConfiguration: allOf: - $ref: '#/components/schemas/AddAdapterConfigurationDto' description: Adapter Configuration associated with Screening Provider secondaryIdentifiers: allOf: - $ref: '#/components/schemas/SecondaryIdentifiersDto' description: Configuration to set which fields will be sent in the SearchCriteria of a new Screening request via the Screening Request task supportingDocumentConfiguration: allOf: - $ref: '#/components/schemas/AddSupportingDocumentConfigurationDto' description: Supporting document configuration associated with the Screening Provider additionalSettingsSchema: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetPropertySchemaDto' description: Schema that describes any fields that should be configured as part of the AdditionalSettings in a ConfigurationSet for the Screening Provider defaultConfigurationSet: allOf: - $ref: '#/components/schemas/ConfigurationSetDto' description: Configuration set that will be set as default additionalProperties: false description: 'Class to represent the request for AddProvider Contains required parameters to define AddProvider' AddOngoingScreeningConfigurationDto: type: object properties: active: type: boolean description: If Ongoing Screening is active example: true additionalProperties: false description: Class to represent Ongoing Screening Configuration associated with Provider ServiceResponseMessage_5: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false SaveScreeningResultsViewUserSelectionDto: type: object properties: screeningResultsViewId: type: - string - 'null' additionalProperties: false ConfigurationSetDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationSetDto' description: Class to represent a Configuration Set associated with the Provider additionalProperties: false ConfigurationSetPropertySchemaDto: required: - fieldId - name - type type: object properties: fieldId: minLength: 1 type: string description: Internal name used to identify the Configuration Set property example: AcceptListId name: minLength: 1 type: string description: Name of the Configuration Set property example: Accept List Id type: minLength: 1 type: string description: Type of the Configuration Set property example: TextInput enabledBy: type: - string - 'null' description: Field that enables the Configuration Set property example: AcceptList mandatory: type: boolean description: If the field is mandatory example: false additionalProperties: false description: Class to represent Configuration Set property schema associated with the Provider UpdateScreeningResultsViewDto: type: object properties: name: type: - string - 'null' columns: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningResultsViewColumnDto' additionalProperties: false ScreeningResultsViewDto: type: object properties: name: type: - string - 'null' entityType: type: - string - 'null' columns: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningResultsViewColumnDto' additionalProperties: false AddScreeningResultsViewResponseDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/AddScreeningResultsViewResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false ServiceResponse_4: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false AddConfigurationSetResponseDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/AddConfigurationSetResponseDto' description: DTO representing the response data of the AddConfigurationSet endpoint messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false ObjectServiceResponse_6: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false StringServiceResponse_6: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false ServiceResponseMessage_6: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false EntityActionItemConfigDto: type: object properties: requirement: type: - string - 'null' description: Requirement level for the supporting document. documentType: type: - array - 'null' items: type: string description: Document types that can be uploaded. additionalProperties: false description: Represents the entity action item supporting document configuration. ConfigurationSetPropertyDto_2: type: object properties: fieldId: type: - string - 'null' description: Unique field id used to identify entry example: AcceptListID value: type: - string - 'null' description: Value of entry example: '1234' additionalProperties: false description: Represents Configuration Set Property ScreeningResultsFieldConfigDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningResultsFieldConfigDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false ConfigurationSetDto_2: type: object properties: id: type: string description: Id of the Configuration Set format: uuid example: f52677f2-56b7-4289-a18b-d11cff3ad338 name: type: - string - 'null' description: Name of the the Configuration Set example: Default description: type: - string - 'null' description: Description of the the Configuration Set example: Default description additionalSettings: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetPropertyDto_2' description: Additional Settings associated with Screening Provider additionalProperties: false description: Represents Screening Configuration Set ProviderDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderDtoV2' description: 'Represents Provider Contains required parameters to define Provider' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false HitFieldConfigDto: type: object properties: documentType: type: - array - 'null' items: type: string description: Document types that can be uploaded. additionalProperties: false description: Represents the hit field supporting document configuration. ScreeningResultsViewDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ScreeningResultsViewDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false AdapterConfigurationDtoV2: required: - url type: object properties: url: minLength: 1 type: string description: URL address of the Screening Adapter example: https://api.fenergonebula.com/lnadaptercommand credentialProperties: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationPropertyDto' description: List of properties containing credentials ongoingScreeningConfiguration: allOf: - $ref: '#/components/schemas/OngoingScreeningConfigurationDtoV2' description: List of Ongoing Screening Provider Configuration associated with Screening Provider authenticationActive: type: boolean description: Flag to indicate if the Adapter authentication is enabled example: false authenticationKey: allOf: - $ref: '#/components/schemas/SecurityKeyDtoV2' description: Base64 encoded key that will be used to authenticate the requests to / from the adapters encryptionKey: allOf: - $ref: '#/components/schemas/SecurityKeyDtoV2' description: Base64 encoded key that will be used to encrypt / decrypt the requests to / from the adapters additionalProperties: false description: Represents Adapter Configuration associated with Provider ConfigurationDtoV2: required: - commentsMandatory - providers - tenant type: object properties: tenant: minLength: 1 type: string description: Tenant id for the Screening Configuration example: 1646d0ca-4050-4fa4-b515-f21cb9f74f48 commentsMandatory: type: boolean description: Setting to specify whether comments should be mandatory or optional for all UI interactions with Providers in the Screening Configuration providers: type: array items: $ref: '#/components/schemas/ProviderDtoV2' description: List of the Screening Providers inside the Screening Configuration additionalProperties: false description: Represents Screening Configuration ScreeningResultsViewDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningResultsViewDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false ServiceResponse_5: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false ProviderConfigurationPropertyDto: type: object properties: fieldId: type: - string - 'null' description: Unique field id used to identify entry example: ClientID name: type: - string - 'null' description: Name of entry example: Client ID value: type: - string - 'null' description: Value of entry example: Fenergo masked: type: boolean description: If the value is masked example: false additionalProperties: false description: Represents Provider Configuration Property SupportingDocumentConfigurationDto: type: object properties: entityActionItem: allOf: - $ref: '#/components/schemas/EntityActionItemConfigDto' description: Entity action item supporting document configuration. Null means the entity action item is turned off. hitField: allOf: - $ref: '#/components/schemas/HitFieldConfigDto' description: Hit field supporting document configuration. Null means the hit field is turned off. additionalProperties: false description: Represents supporting document configuration. ConfigurationDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationDtoV2' description: Represents Screening Configuration messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false SecondaryIdentifiersAddressDto_2: type: object properties: addressLine1: type: boolean description: Whether the Individual's Address line 1 will be sent example: false addressLine2: type: boolean description: Whether the Individual's Address line 2 will be sent example: false city: type: boolean description: Whether the Individual's Address city will be sent example: false postalCode: type: boolean description: Whether the Individual's Address postal code will be sent example: false country: type: boolean description: Whether the Individual's Address country will be sent example: false stateProvince: type: boolean description: Whether the Individual's Address state province will be sent example: false type: type: boolean description: Whether the Individual's Address type will be sent example: false additionalProperties: false description: Represents the address fields that will be sent in SearchCriteria ProviderDtoV2: required: - id - name type: object properties: id: minLength: 1 type: string description: Id of the Screening Provider example: ProviderId name: minLength: 1 type: string description: Name of the Screening Provider example: ProviderName isOutOfTheBox: type: boolean description: If the Provider is out of the box example: true active: type: boolean description: If the Provider is active example: true status: type: - string - 'null' description: Status of Screening Provider example: Not Verified adapterConfiguration: allOf: - $ref: '#/components/schemas/AdapterConfigurationDtoV2' description: Adapter Configuration associated with Screening Provider secondaryIdentifiers: allOf: - $ref: '#/components/schemas/SecondaryIdentifiersDto_2' description: Configuration for which fields will be sent in SearchCriteria on create new request via Screening Request task supportingDocumentConfiguration: allOf: - $ref: '#/components/schemas/SupportingDocumentConfigurationDto' description: Supporting document configuration associated with the Screening Provider configurationSets: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetDto_2' description: List of Provider Configuration Sets defaultConfigurationSetId: type: string description: Id of the Default Configuration Set Id for the Provider format: uuid additionalSettingsSchema: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetPropertySchemaDto_2' description: List of configuration set properties that set the additional settings schema additionalProperties: false description: 'Represents Provider Contains required parameters to define Provider' ScreeningResultsFieldConfigDto: type: object properties: accessor: type: - string - 'null' label: type: - string - 'null' visible: type: boolean order: type: integer format: int32 renderer: type: - string - 'null' additionalProperties: false SecondaryIdentifiersDto_2: required: - address type: object properties: firstName: type: boolean description: Whether the Individual's first name will be sent example: true middleName: type: boolean description: Whether the Individual's middle name will be sent example: true lastName: type: boolean description: Whether the Individual's last name will be sent example: true fullName: type: boolean description: Whether the Individual's full name will be sent example: false dateOfBirth: type: boolean description: Whether the Individual's date of birth will be sent example: false gender: type: boolean description: Whether the Individual's gender will be sent example: false address: allOf: - $ref: '#/components/schemas/SecondaryIdentifiersAddressDto_2' description: Whether each of the Individual's Address fields will be sent nationality: type: boolean description: Whether the Individual's nationality will be sent example: false placeOfBirth: type: boolean description: Whether the Individual's place of birth will be sent example: false citizenship: type: boolean description: Whether the Individual's citizenship will be sent example: false registeredCountry: type: boolean description: Whether the Company's registered country will be sent example: false uniqueId: type: boolean description: Whether the UniqueId will be sent example: false otherInformation: type: boolean description: Whether the entity's other information will be sent example: false passportNumber: type: boolean description: Whether the individual's passport number will be sent example: false socialSecurityNumber: type: boolean description: Whether the Individual's Social Security Number (SSN) will be sent example: false driversLicense: type: boolean description: Whether the Individual's driving license will be sent example: false employerIdentificationNumber: type: boolean description: Whether the Company's Employer Identification Number (EIN) will be sent example: false additionalProperties: false description: 'Represents the configuration for which fields will be sent in SearchCriteria on create new request via Screening Request task' ConfigurationLiteDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationLiteDtoV2' description: Represents a lite version of the Screening Configuration messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false OngoingScreeningConfigurationDtoV2: type: object properties: active: type: boolean description: If Ongoing Screening is active example: true ongoingScreeningProperties: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationPropertyDto' description: List of ongoing screening properties additionalProperties: false description: Represents Ongoing Screening Configuration SecurityKeyDtoV2: type: object properties: key: type: - string - 'null' description: The base64 encoded key example: HgyUHIO81m0FcZfPS1lnUw== lastUpdatedOn: type: - string - 'null' description: The last time that the key was updated format: date-time example: 2010/04/01T23:59:59.999999 additionalProperties: false description: 'Represents the security key that will be used to authenticate the requests to / from the adapters () Authentication key or Encryption Key' ObjectServiceResponse_7: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false StringServiceResponse_7: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false ProviderLiteDto: required: - id - name type: object properties: id: minLength: 1 type: string description: Id of the Screening Provider example: ProviderId name: minLength: 1 type: string description: Name of the Screening Provider example: ProviderName active: type: boolean description: If the Provider is active example: true additionalProperties: false description: 'Represents a lite version of a Provider Contains required parameters to define Provider' ServiceResponseMessage_7: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConfigurationSetPropertySchemaDto_2: type: object properties: fieldId: type: - string - 'null' description: Unique field id used to identify entry example: AcceptListID name: type: - string - 'null' description: Name of entry example: Accept List ID type: type: - string - 'null' description: 'Type of entry Could be TextInput or Toggle' example: TextInput enabledBy: type: - string - 'null' description: If it's enabled by a Toggle field, the id of it example: AcceptListToggle mandatory: type: boolean description: If it's mandatory example: true additionalProperties: false description: Represents Configuration Set Property Schema ScreeningResultsViewDto_2: type: object properties: id: type: string format: uuid name: type: - string - 'null' entityType: type: - string - 'null' columns: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningResultsViewColumnDto' additionalProperties: false ConfigurationLiteDtoV2: required: - commentsMandatory - providers - tenant type: object properties: tenant: minLength: 1 type: string description: Tenant id for the Screening Configuration example: 1646d0ca-4050-4fa4-b515-f21cb9f74f48 commentsMandatory: type: boolean description: Setting to specify whether comments should be mandatory or optional for all UI interactions with Providers in the Screening Configuration providers: type: array items: $ref: '#/components/schemas/ProviderLiteDto' description: List of the Screening Providers inside the Screening Configuration additionalProperties: false description: Represents a lite version of the Screening Configuration ConfigurationSetPropertyDto_3: type: object properties: fieldId: type: - string - 'null' description: Unique field id used to identify entry example: AcceptListID value: type: - string - 'null' description: Value of entry example: '1234' additionalProperties: false description: Represents Configuration Set Property ScreeningResultsFieldConfigDtoIEnumerableServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningResultsFieldConfigDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ConfigurationSetDto_3: type: object properties: id: type: string description: Id of the Configuration Set format: uuid example: f52677f2-56b7-4289-a18b-d11cff3ad338 name: type: - string - 'null' description: Name of the the Configuration Set example: Default description: type: - string - 'null' description: Description of the the Configuration Set example: Default description additionalSettings: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetPropertyDto_3' description: Additional Settings associated with Screening Provider additionalProperties: false description: Represents Screening Configuration Set ProviderDtoV2ServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderDtoV2_2' description: 'Represents Provider Contains required parameters to define Provider' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ScreeningResultsViewDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ScreeningResultsViewDto_3' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ScreeningResultsViewDtoIEnumerableServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningResultsViewDto_3' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ServiceResponse_6: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ConfigurationDtoV2ServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationDtoV2' description: Represents Screening Configuration messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false SecondaryIdentifiersAddressDto_3: type: object properties: addressLine1: type: boolean description: Whether the Individual's Address line 1 will be sent example: false addressLine2: type: boolean description: Whether the Individual's Address line 2 will be sent example: false city: type: boolean description: Whether the Individual's Address city will be sent example: false postalCode: type: boolean description: Whether the Individual's Address postal code will be sent example: false country: type: boolean description: Whether the Individual's Address country will be sent example: false stateProvince: type: boolean description: Whether the Individual's Address state province will be sent example: false type: type: boolean description: Whether the Individual's Address type will be sent example: false additionalProperties: false description: Represents the address fields that will be sent in SearchCriteria ProviderDtoV2_2: required: - id - name type: object properties: id: minLength: 1 type: string description: Id of the Screening Provider example: ProviderId name: minLength: 1 type: string description: Name of the Screening Provider example: ProviderName isOutOfTheBox: type: boolean description: If the Provider is out of the box example: true active: type: boolean description: If the Provider is active example: true status: type: - string - 'null' description: Status of Screening Provider example: Not Verified adapterConfiguration: allOf: - $ref: '#/components/schemas/AdapterConfigurationDtoV2' description: Adapter Configuration associated with Screening Provider secondaryIdentifiers: allOf: - $ref: '#/components/schemas/SecondaryIdentifiersDto_3' description: Configuration for which fields will be sent in SearchCriteria on create new request via Screening Request task supportingDocumentConfiguration: allOf: - $ref: '#/components/schemas/SupportingDocumentConfigurationDto' description: Supporting document configuration associated with the Screening Provider configurationSets: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetDto_3' description: List of Provider Configuration Sets defaultConfigurationSetId: type: string description: Id of the Default Configuration Set Id for the Provider format: uuid additionalSettingsSchema: type: - array - 'null' items: $ref: '#/components/schemas/ConfigurationSetPropertySchemaDto_3' description: List of configuration set properties that set the additional settings schema additionalProperties: false description: 'Represents Provider Contains required parameters to define Provider' SecondaryIdentifiersDto_3: required: - address type: object properties: firstName: type: boolean description: Whether the Individual's first name will be sent example: true middleName: type: boolean description: Whether the Individual's middle name will be sent example: true lastName: type: boolean description: Whether the Individual's last name will be sent example: true fullName: type: boolean description: Whether the Individual's full name will be sent example: false dateOfBirth: type: boolean description: Whether the Individual's date of birth will be sent example: false gender: type: boolean description: Whether the Individual's gender will be sent example: false address: allOf: - $ref: '#/components/schemas/SecondaryIdentifiersAddressDto_3' description: Whether each of the Individual's Address fields will be sent nationality: type: boolean description: Whether the Individual's nationality will be sent example: false placeOfBirth: type: boolean description: Whether the Individual's place of birth will be sent example: false citizenship: type: boolean description: Whether the Individual's citizenship will be sent example: false registeredCountry: type: boolean description: Whether the Company's registered country will be sent example: false uniqueId: type: boolean description: Whether the UniqueId will be sent example: false otherInformation: type: boolean description: Whether the entity's other information will be sent example: false passportNumber: type: boolean description: Whether the individual's passport number will be sent example: false socialSecurityNumber: type: boolean description: Whether the Individual's Social Security Number (SSN) will be sent example: false driversLicense: type: boolean description: Whether the Individual's driving license will be sent example: false employerIdentificationNumber: type: boolean description: Whether the Company's Employer Identification Number (EIN) will be sent example: false additionalProperties: false description: 'Represents the configuration for which fields will be sent in SearchCriteria on create new request via Screening Request task' ConfigurationLiteDtoV2ServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationLiteDtoV2' description: Represents a lite version of the Screening Configuration messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ObjectServiceResponse_8: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false StringServiceResponse_8: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ServiceResponseMessage_8: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConfigurationSetPropertySchemaDto_3: type: object properties: fieldId: type: - string - 'null' description: Unique field id used to identify entry example: AcceptListID name: type: - string - 'null' description: Name of entry example: Accept List ID type: type: - string - 'null' description: 'Type of entry Could be TextInput or Toggle' example: TextInput enabledBy: type: - string - 'null' description: If it's enabled by a Toggle field, the id of it example: AcceptListToggle mandatory: type: boolean description: If it's mandatory example: true additionalProperties: false description: Represents Configuration Set Property Schema ScreeningResultsViewDto_3: type: object properties: id: type: string format: uuid name: type: - string - 'null' entityType: type: - string - 'null' columns: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningResultsViewColumnDto' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-dataprotectioncommand-v1-0-openapi.json - fenergo-dataprotectionquery-v1-0-openapi.json - fenergo-digitalidvcommand-v1-0-openapi.json - fenergo-digitalidvcommand-v2-0-openapi.json - fenergo-digitalidvquery-v1-0-openapi.json - fenergo-digitalidvquery-v2-0-openapi.json - fenergo-documentmanagementcommand-v2-0-openapi.json - fenergo-financialanalysiscommand-v1-0-openapi.json - fenergo-financialanalysisquery-v1-0-openapi.json - fenergo-newrequest-v1-0-openapi.json - fenergo-screeningcommand-v2-0-openapi.json - fenergo-screeningcommand-v3-0-openapi.json - fenergo-screeningquery-v3-0-openapi.json - fenergo-screeningquery-v4-0-openapi.json