openapi: 3.2.0 info: title: Fenergo Credit Screening Provider API version: '1.0' description: 'Operations tagged CreditScreeningProvider across 2 of this provider''s published API definitions: fenergo-creditscreeningcommand-v1-0-openapi.json, fenergo-creditscreeningquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /creditscreeningcommand - url: /creditscreeningquery security: - Bearer: [] tags: - name: CreditScreeningProvider paths: /api/providers: post: tags: - CreditScreeningProvider summary: Create a new Credit Screening Provider description: 'This method creates new Credit ScreeningProvider. The new provider initializes with the DTO data and is set to disable as default. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit' operationId: CreateCreditScreeningProvider parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/ProviderDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/ProviderDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - CreditScreeningProvider summary: Get all Credit Screening Providers description: 'This method returns all Credit Screening Providers for given tenant Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetAllCreditScreeningProviders 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 list of CreditScreenings is returned content: text/plain: schema: $ref: '#/components/schemas/ProviderDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ProviderDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ProviderDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/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: /creditscreeningcommand /api/providers/{providerId}: put: tags: - CreditScreeningProvider summary: Update an existing Credit Screening Provider description: 'This method updates a Credit ScreeningProvider. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit' operationId: UpdateCreditScreeningProvider parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/ProviderDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/ProviderDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - CreditScreeningProvider summary: Delete a Credit Screening Provider and all related configurations description: 'This method deletes a Credit Screening Provider. It also deletes the configuration, mapping configuration and adapter schema that are related to this provider. Required permissions: At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete' operationId: DeleteCreditScreeningProvider parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - CreditScreeningProvider summary: Get a Credit Screening Providers by Id description: 'This method returns the Credit Screening Providers for given Provider Id. Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetCreditScreeningProvidersById parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A credit screening provider is returned content: text/plain: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/ProviderDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/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: /creditscreeningcommand /api/providers/{providerId}/enabled: put: tags: - CreditScreeningProvider summary: Update if a provider is Enabled description: 'This method updates a credit screening provider if they are inactive/active. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit' operationId: UpdateCreditScreeningProviderEnabled parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: $ref: '#/components/schemas/EnabledDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/EnabledDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/EnabledDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/EnabledDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/EnabledDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/EnabledDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/providers/{providerId}/configuration: post: tags: - CreditScreeningProvider summary: Create a new Credit Screening Provider Configuration description: 'This method saves new Credit ScreeningProvider Configuration. The configuration initializes with the DTO data consists a list configuration properties. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit' operationId: CreateCreditScreeningProviderConfiguration parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' responses: '202': description: Accepted for processing 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/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT put: tags: - CreditScreeningProvider summary: Update an existing Credit Screening Provider Configuration description: 'This method update an existing Credit Screening Provider Configuration. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit' operationId: UpdateCreditScreeningProviderConfiguration parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest' responses: '202': description: Accepted for processing 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/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - CreditScreeningProvider summary: Delete a Credit Screening Provider Configuration description: 'This method delete existing Credit Screening Provider Configuration. Required permissions: At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete' operationId: DeleteCreditScreeningProviderConfiguration parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - CreditScreeningProvider summary: Get a Credit Screening Provider Configuration by Provider Id description: 'This method returns the Credit Screening Providers for given Provider Id. Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetCreditScreeningProviderConfigurationById parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A credit screening provider is returned 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: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/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: /creditscreeningcommand /api/providers/{providerId}/mappingconfiguration: post: tags: - CreditScreeningProvider summary: Create a new Credit Screening Mapping Configuration description: 'This method saves new Mapping Configuration. The new configuration initializes with the DTO data and has the resquest and result mapping rules stored inside. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit' operationId: CreateCreditScreeningMappingConfiguration parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - CreditScreeningProvider summary: Get a Credit Screening Mapping Configuration by Provider Id description: 'This method returns the Credit Screening Mapping Configuration for given Provider Id. Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetCreditScreeningMappingConfigurationByProviderId parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A credit screening mapping configuration is returned content: text/plain: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/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: /creditscreeningcommand /api/providers/{providerId}/mappingconfiguration/{mappingId}: put: tags: - CreditScreeningProvider summary: Update an existing Credit Screening Mapping Configuration description: 'This method updates an existing Mapping Configuration. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit' operationId: UpdateCreditScreeningMappingConfiguration parameters: - name: mappingId in: path required: true schema: type: string format: uuid - name: providerId in: path 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: content: application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - CreditScreeningProvider summary: Delete an existing Credit Screening Mapping Configuration description: 'This method deletes an existing Mapping Configuration. Required permissions: At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete' operationId: DeleteCreditScreeningMappingConfiguration parameters: - name: mappingId in: path required: true schema: type: string format: uuid - name: providerId in: path 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: Accepted for processing '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/providers/{providerId}/adapterSchema: post: tags: - CreditScreeningProvider summary: Create a new Adapter Schema description: 'This method saves new Credit Screening Adapter Schema. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit' operationId: CreateCreditScreeningAdapterShcema parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - CreditScreeningProvider summary: Get a Credit Screening Adapter Schema by Provider Id description: 'This method returns the Credit Screening Adapter Schema for given Provider Id. Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetCreditScreeningAdapterSchemaByProviderId parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A credit screening adapter schema is returned content: text/plain: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/providers/{providerId}/adapterSchema/{id}: put: tags: - CreditScreeningProvider summary: Update an existing Adapter Schema description: 'This method update an existing Credit Screening Adapter Schema. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit' operationId: UpdateCreditScreeningAdapterShcema parameters: - name: providerId in: path required: true schema: type: string format: uuid - 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: $ref: '#/components/schemas/AdapterSchemaDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - CreditScreeningProvider summary: Delete an existing Adapter Schema description: 'This method delete an existing Credit Screening Adapter Schema. Required permissions: At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete' operationId: DeleteCreditScreeningAdapterShcema parameters: - name: providerId in: path required: true schema: type: string format: uuid - 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 responses: '202': description: Accepted for processing '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/providers/{providerId}/test: post: tags: - CreditScreeningProvider summary: Test mock adapter endpoint description: This method triggers a mock adapter endpoint. operationId: ProviderTest parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - CreditScreeningProvider summary: Get a test result for a Provider by Provider Id description: 'This method returns the Provider Test Result for given Provider Id. Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetProviderTestResult parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A Provider Test Result is returned content: text/plain: schema: $ref: '#/components/schemas/ProviderTestResultDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ProviderTestResultDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ProviderTestResultDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/providers/configurations: get: tags: - CreditScreeningProvider summary: Get all Credit Screening Providers Configurations description: 'This method returns all Credit Screening Providers Configuration for given tenant Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetAllCreditScreeningProvidersConfiguration 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 list of CreditScreenings is returned content: text/plain: schema: $ref: '#/components/schemas/ProviderConfigurationDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/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: /creditscreeningquery /api/providers/mappingconfigurations: get: tags: - CreditScreeningProvider summary: Get all Credit Screening Providers Mapping Configurations description: 'This method returns all Credit Screening Mapping Configuration for given tenant Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetAllCreditScreeningMappingConfiguration 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 list of Mapping Configuration is returned content: text/plain: schema: $ref: '#/components/schemas/MappingConfigurationDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/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: /creditscreeningquery /api/providers/{providerId}/configurationsummary: get: tags: - CreditScreeningProvider summary: Gets a summarised result of the statuses associated with a provider description: 'This method returns a summary of the provider which includes details about the provider itself, the configuration, mapping configuration and adapter schema statues for given Provider Id. Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetCreditScreeningProviderConfigurationSummaryByProviderId parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A Configuration Summary is returned content: text/plain: schema: $ref: '#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/providers/configurationsummary: get: tags: - CreditScreeningProvider summary: Gets a summarised result of the statuses associated with all provider that are… description: 'This method returns a summary of the provider which includes details about the provider itself, the configuration, mapping configuration and adapter schema statues for all providers.. Required permissions: At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess' operationId: GetCreditScreeningProviderConfigurationSummaries 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 list of configuration summaries is returned content: text/plain: schema: $ref: '#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery components: schemas: ProviderConfigurationSecurityKeysDto: type: object properties: authenticationKey: type: - string - 'null' encryptionKey: type: - string - 'null' additionalProperties: false EnabledDto: type: object properties: enabled: type: - boolean - 'null' description: Flag to check if provider is Enabled or not example: false additionalProperties: false SchemaEntryDto: type: object properties: fields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto' additionalProperties: false AdapterSchemaDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/AdapterSchemaDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AdapterConfigurationDto: type: object properties: url: type: - string - 'null' additionalProperties: false ProviderConfigurationDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/ProviderConfigurationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false MappingDto: type: object properties: ruleSets: type: - array - 'null' items: $ref: '#/components/schemas/MappingRuleSetDto' description: 'The list that contains all the mapping rules for a provider It can be for request or result mapping configuration' additionalProperties: false description: The schema for mapping configuration request and result SchemaDto: type: object properties: initiateCreditScreeningRequest: $ref: '#/components/schemas/SchemaEntryDto' initiateCreditScreeningResult: $ref: '#/components/schemas/SchemaEntryDto' additionalProperties: false description: Adapter Configuration Schema Detail MappingRuleDto: type: object properties: order: type: integer description: This order will be used to generate mapping Path format: int32 propertyName: type: - string - 'null' description: Property Name isArrayProperty: type: - boolean - 'null' includingNestedPath: type: - boolean - 'null' description: If true, it will find all properties (including nested properties) with this Property Name additionalProperties: false description: The mapping rule schema AdapterSchemaDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/AdapterSchemaDto' additionalProperties: false ProviderConfigurationDto: type: object properties: providerId: type: string description: Provider Id format: uuid configurationList: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationDetailsDto' description: List of Configuration Details Schema adapterConfiguration: $ref: '#/components/schemas/AdapterConfigurationDto' providerConfigurationSecurityKeys: $ref: '#/components/schemas/ProviderConfigurationSecurityKeysDto' additionalProperties: false description: Provider Configuration top layer schema MappingConfigurationDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/MappingConfigurationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false MappingRuleSetDto: type: object properties: mappingRules: type: - array - 'null' items: $ref: '#/components/schemas/MappingRuleDto' description: The list that contains all of the mapping rules targetProperty: type: - string - 'null' description: The targetProperty for mapping destination example: address targetPropertyFriendlyName: type: - string - 'null' description: The targetProperty friendly name for display example: address nestedMappingRules: $ref: '#/components/schemas/MappingDto' targetPropertyType: type: - string - 'null' description: The type of the targetProperty example: String hiddenIfNoValue: type: boolean description: hide this field in auto credit screening task if no value additionalProperties: false description: The schema that contains info of designated property MappingConfigurationDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/MappingConfigurationDto' additionalProperties: false FieldDto: type: object properties: name: type: - string - 'null' description: Name of the field example: Address friendlyName: type: - string - 'null' description: 'Friendly name of the field For display purpose' example: '' isMandatory: type: - boolean - 'null' description: The flag to set if property is mandatory type: type: - string - 'null' description: Type of the field example: String description: type: - string - 'null' description: Description of the field example: Address line 1 nestedFields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto' description: Nested field additionalProperties: false description: The Field schema ProviderDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/ProviderDto' additionalProperties: false ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} ProviderConfigurationDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/ProviderConfigurationDto' additionalProperties: false EnabledDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/EnabledDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code EnabledDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/EnabledDto' additionalProperties: false MappingConfigurationDto: type: object properties: id: type: string description: The id of mapping configuration format: uuid providerId: type: string description: The corresponding provider id of mapping configuration format: uuid initiateCreditScreeningRequestDto: $ref: '#/components/schemas/MappingDto' initiateCreditScreeningResultDto: $ref: '#/components/schemas/MappingDto' additionalProperties: false description: Mapping Configuration Schema ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ProviderDto: type: object properties: id: type: - string - 'null' description: Credit Screening Provider UiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 name: type: - string - 'null' description: Provider Name example: Equifax enabled: type: - boolean - 'null' description: Flag to check if provider is Enabled or not example: false internalIdentifier: type: - string - 'null' description: Internal Identifier example: equifax-screening additionalProperties: false description: Provider Schema ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ProviderConfigurationDetailsDto: type: object properties: description: type: - string - 'null' description: Configuration property description example: Address line 1 friendlyName: type: - string - 'null' description: The display name for the property example: Address mandatory: type: - boolean - 'null' description: Flag to set if property is mandatory example: false name: type: - string - 'null' description: Name example: Address type: type: - string - 'null' description: The tpye of the property example: String value: type: - string - 'null' description: The value of the property example: George Street maskRequired: type: - boolean - 'null' description: Flag to set if property needs to be masked example: false additionalProperties: false description: Provider Configuration Schema AdapterSchemaDto: type: object properties: id: type: string description: Id of the schema format: uuid providerId: type: string description: Provider Id of the schema format: uuid schema: $ref: '#/components/schemas/SchemaDto' additionalProperties: false description: Adapter Configuration Schema ProviderDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/ProviderDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SchemaEntryDto_2: type: object properties: fields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto_2' description: The list of all Fields additionalProperties: false ProviderTestResultDto: type: object properties: id: type: string description: Id of the Provider being tested. format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 tenantId: type: - string - 'null' description: Id of the Tenant example: b11f8be3-f29b-4959-8964-956d4af7c468 status: type: - string - 'null' description: The validation status. example: Completed additionalProperties: false description: Provider Test Result AdapterSchemaDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/AdapterSchemaDto_2' description: Adapter Configuration Schema messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProviderConfigurationDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderConfigurationDto_2' description: Provider Configuration top layer schema messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false MappingConfigurationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/MappingConfigurationDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProviderConfigurationSummaryDto: type: object properties: name: type: - string - 'null' providerId: type: string format: uuid mappingStatus: type: - string - 'null' adapterStatus: type: - string - 'null' authenticationStatus: type: - string - 'null' enabled: type: boolean isCustom: type: boolean internalIdentifier: type: - string - 'null' additionalProperties: false SchemaDto_2: type: object properties: initiateCreditScreeningRequest: allOf: - $ref: '#/components/schemas/SchemaEntryDto_2' description: "Adapter Configuration request schema \nIt contains list of fields" initiateCreditScreeningResult: allOf: - $ref: '#/components/schemas/SchemaEntryDto_2' description: "Adapter Configuration result schema \nIt contains list of fields" additionalProperties: false description: Adapter Configuration Schema Detail MappingRuleDto_2: type: object properties: order: type: integer description: This order will be used to generate mapping Path format: int32 propertyName: type: - string - 'null' description: Property Name isArrayProperty: type: boolean includingNestedPath: type: boolean description: If true, it will find all properties (including nested properties) with this Property Name additionalProperties: false description: The mapping rule schema ProviderConfigurationSummaryDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationSummaryDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProviderConfigurationDto_2: type: object properties: providerId: type: string description: Provider Id format: uuid configurationList: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationDetailsDto_2' description: List of Configuration Details Schema adapterConfiguration: allOf: - $ref: '#/components/schemas/AdapterConfigurationDto' description: Schema of Adapter Configuration providerConfigurationSecurityKeys: allOf: - $ref: '#/components/schemas/ProviderConfigurationSecurityKeysDto' description: Configuration keys for provider additionalProperties: false description: Provider Configuration top layer schema ProviderTestResultDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderTestResultDto' description: Provider Test Result messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false MappingConfigurationDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/MappingConfigurationDto_2' description: Mapping Configuration Schema messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProviderConfigurationSummaryDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderConfigurationSummaryDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false MappingRuleSetDto_2: type: object properties: mappingRules: type: - array - 'null' items: $ref: '#/components/schemas/MappingRuleDto_2' description: The list that contains all of the mapping rules targetProperty: type: - string - 'null' description: The targetProperty for mapping destination example: address targetPropertyFriendlyName: type: - string - 'null' description: The targetProperty friendly name for display example: address nestedMappingRules: allOf: - $ref: '#/components/schemas/MappingDto' description: The nested mapping rules for mapping a nested object targetPropertyType: type: - string - 'null' description: The type of the targetProperty example: String hiddenIfNoValue: type: boolean description: hide this property in auto credit screening task if this flag is true and no value example: true additionalProperties: false description: The schema that contains info of designated property FieldDto_2: type: object properties: name: type: - string - 'null' description: Name of the field example: '' friendlyName: type: - string - 'null' description: 'Friendly name of the field For display purpose' example: '' isMandatory: type: boolean description: The flag to set if property is mandatory type: type: - string - 'null' description: Type of the field example: String description: type: - string - 'null' description: Description of the field example: Address line 1 nestedFields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto_2' description: Nested field additionalProperties: false description: The Field schema ProviderDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ProviderDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false MappingConfigurationDto_2: type: object properties: id: type: string format: uuid providerId: type: string format: uuid initiateCreditScreeningRequestDto: allOf: - $ref: '#/components/schemas/MappingDto' description: The mapping configuration request schema for request initiateCreditScreeningResultDto: allOf: - $ref: '#/components/schemas/MappingDto' description: The mapping configuration result schema for request additionalProperties: false description: Mapping Configuration Schema ProviderDto_2: type: object properties: id: type: string description: Credit Screening Provider UiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 name: type: - string - 'null' description: Provider Name example: Equifax enabled: type: boolean description: Flag to check if provider is Eanbled or not example: false isCustom: type: boolean description: Flag to initialise if provider is customised or not example: false internalIdentifier: type: - string - 'null' description: The internal identifier for a provider example: equifax-sample additionalProperties: false description: Provider Schema ProviderConfigurationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProviderConfigurationDetailsDto_2: type: object properties: description: type: - string - 'null' description: Configuration property description example: Address line 1 friendlyName: type: - string - 'null' description: The display name for the property example: Address mandatory: type: boolean description: Flag to set if property is mandatory example: false name: type: - string - 'null' description: Name example: Address type: type: - string - 'null' description: The tpye of the property example: String value: type: - string - 'null' description: The value of the property example: George Street maskRequired: type: boolean description: Flag to set if property needs to be masked example: false additionalProperties: false description: Provider Configuration Schema AdapterSchemaDto_2: type: object properties: id: type: string description: Id of the schema format: uuid providerId: type: string description: Provider Id of the schema format: uuid schema: allOf: - $ref: '#/components/schemas/SchemaDto_2' description: The schema contains request and result schema additionalProperties: false description: Adapter Configuration Schema ProviderDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderDto_2' description: Provider Schema messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-creditscreeningcommand-v1-0-openapi.json - fenergo-creditscreeningquery-v1-0-openapi.json