openapi: 3.2.0 info: title: Fenergo Credit Assessment Provider API version: '1.0' description: 'Operations tagged CreditAssessmentProvider across 2 of this provider''s published API definitions: fenergo-creditassessmentcommand-v1-0-openapi.json, fenergo-creditassessmentquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /creditassessmentcommand - url: /creditassessmentquery security: - Bearer: [] tags: - name: CreditAssessmentProvider paths: /api/providers: post: tags: - CreditAssessmentProvider summary: Create a new Automated CreditAssessment Provider description: 'This method creates new Automated CreditAssessment Provider. 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: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationCreate' operationId: CreateCreditAssessmentProvider 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/CreditAssessmentProviderDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/CreditAssessmentProviderDtoServiceResponse' '400': description: Invalid request content: application/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: Error Code get: tags: - CreditAssessmentProvider summary: Get all Automated Credit Assessment Providers description: 'This method returns all Automated Credit Assessment Providers for given tenant Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetAllCreditAssessmentProviders 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 AutomatedCreditAssessments is returned content: application/json: schema: $ref: '#/components/schemas/CreditAssessmentProviderDtoIEnumerableServiceResponse' '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: Error Code servers: - url: /creditassessmentcommand /api/providers/{providerId}: put: tags: - CreditAssessmentProvider summary: Update an Automated CreditAssessment Provider description: 'This method updates an Automated CreditAssessment Provider. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit' operationId: UpdateCreditAssessmentProvider 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/CreditAssessmentProviderDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/CreditAssessmentProviderDtoServiceResponse' '400': description: Invalid 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: Error Code delete: tags: - CreditAssessmentProvider summary: Delete an Automated CreditAssessment Provider description: 'This method delete an Automated CreditAssessment Provider and associated configurations. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentDelete, CreditAssessmentConfigurationDelete' operationId: DeleteCreditAssessmentProvider 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: 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: Error Code get: tags: - CreditAssessmentProvider summary: Get Automated Credit Assessment Providers by Id description: 'This method returns the Automated Credit Assessment Providers for given provider id. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetCreditAssessmentProvidersById 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. An Automated Credit Assessment provider is returned content: application/json: schema: $ref: '#/components/schemas/CreditAssessmentProviderDtoServiceResponse_2' '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: Error Code servers: - url: /creditassessmentcommand /api/providers/{providerId}/enabled: put: tags: - CreditAssessmentProvider summary: Update whether an Automated CreditAssessment Provider is enabled description: 'This method updates whether an Automated CreditAssessment Provider is enabled. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit' operationId: UpdateCreditAssessmentProviderEnabled 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/CreditAssessmentProviderDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/CreditAssessmentProviderDtoServiceResponse' '400': description: Invalid 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: Error Code servers: - url: /creditassessmentcommand /api/providers/{providerId}/configuration: post: tags: - CreditAssessmentProvider summary: Save a new Automated CreditAssessment Provider Configuration description: 'This method saves new Automated CreditAssessment Provider Configuration. The configuration initializes with the DTO data consists a list configuration properties. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationCreate' operationId: CreateProviderConfiguration 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' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse' '400': description: Invalid 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: Error Code put: tags: - CreditAssessmentProvider summary: Update an existing Automated CreditAssessment Provider Configuration description: 'This method update an existing Automated CreditAssessment Provider Configuration. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit' operationId: UpdateProviderConfiguration 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' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse' '400': description: Invalid 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: Error Code delete: tags: - CreditAssessmentProvider summary: Delete a new Automated CreditAssessment Provider Configuration description: 'This method delete existing Automated CreditAssessment Provider Configuration. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentDelete, CreditAssessmentConfigurationDelete' operationId: DeleteProviderConfiguration 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: 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: Error Code get: tags: - CreditAssessmentProvider summary: Get Automated Credit Assessment Providers by Id description: 'This method returns the Automated Credit Assessment Providers for given provider id. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetProviderConfigurationById 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. An Automated Credit Assessment provider is returned content: application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse_2' '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: Error Code servers: - url: /creditassessmentcommand /api/providers/{providerId}/mappingconfiguration: post: tags: - CreditAssessmentProvider summary: Save a new AutomatedCreditAssessment 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: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationCreate' operationId: CreateMappingConfiguration 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' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse' '400': description: Invalid 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: Error Code get: tags: - CreditAssessmentProvider summary: Get Automated Credit Assessment Mapping Configuration by Provider Id description: 'This method returns the Automated Credit Assessment Mapping Configuration for given provider id. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetMappingConfigurationByProviderId 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. An Automated Credit Assessment mapping configuration is returned content: application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse_2' '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: Error Code servers: - url: /creditassessmentcommand /api/providers/{providerId}/mappingconfiguration/{mappingId}: put: tags: - CreditAssessmentProvider summary: Update an existing Automated Credit Assessment Mapping Configuration description: 'This method updates an existing Mapping Configuration. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit' operationId: UpdateMappingConfiguration 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' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoServiceResponse' '400': description: Invalid 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: Error Code delete: tags: - CreditAssessmentProvider summary: Delete an existing Automated Credit Assessment Mapping Configuration description: 'This method deletes an existing Mapping Configuration. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentDelete, CreditAssessmentConfigurationDelete' operationId: DeleteMappingConfiguration 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: 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: Error Code servers: - url: /creditassessmentcommand /api/providers/{providerId}/adapterSchema: post: tags: - CreditAssessmentProvider summary: Create a new Adapter Schema description: 'This method saves new Automated CreditAssessment Provider Adapter Schema. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationCreate' operationId: CreateAdapterSchema 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' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse' '400': description: Invalid 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: Error Code get: tags: - CreditAssessmentProvider summary: Get Automated Credit Assessment Adapter Schema by Provider Id description: 'This method returns the Automated Credit Assessment Adapter Schema for given provider id. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetAdapterSchema 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 content: application/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse_2' '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 type: Error errorCode: Error Code '200': description: Success. An Automated Credit Assessment adapter schema is returned '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: Error Code servers: - url: /creditassessmentcommand /api/providers/{providerId}/adapterSchema/{id}: put: tags: - CreditAssessmentProvider summary: Update a new Adapter Schema description: 'This method update an existing Automated CreditAssessment Provider Adapter Schema. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit' operationId: UpdateAdapterSchema 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' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoServiceResponse' '400': description: Invalid 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: Error Code delete: tags: - CreditAssessmentProvider summary: Delete an existing Adapter Schema description: 'This method delete an existing Automated CreditAssessment Provider Adapter Schema. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentDelete, CreditAssessmentConfigurationDelete' operationId: DeleteAdapterSchema 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: 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: Error Code servers: - url: /creditassessmentcommand /api/providers/{providerId}/test: post: tags: - CreditAssessmentProvider summary: Test mock adapter endpoint description: 'This method triggers a mock adapter endpoint. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentEdit, CreditAssessmentConfigurationEdit, CreditAssessmentConfigurationCreate' 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: 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: Error Code get: tags: - CreditAssessmentProvider 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: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' 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: application/json: schema: $ref: '#/components/schemas/ProviderTestResultDtoServiceResponse' '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 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: Error Code servers: - url: /creditassessmentcommand /api/providers/configurations: get: tags: - CreditAssessmentProvider summary: Get all Automated Credit Assessment Providers Configurations description: 'This method returns all Automated Credit Assessment Providers Configuration for given tenant Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetAllCreditAssessmentProvidersConfiguration 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 AutomatedCreditAssessments is returned content: application/json: schema: $ref: '#/components/schemas/ProviderConfigurationDtoIEnumerableServiceResponse' '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: Error Code servers: - url: /creditassessmentquery /api/providers/mappingconfigurations: get: tags: - CreditAssessmentProvider summary: Get all Automated Credit Assessment Providers Mapping Configurations description: 'This method returns all Automated Credit Assessment Mapping Configuration for given tenant Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetAllMappingConfiguration 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: application/json: schema: $ref: '#/components/schemas/MappingConfigurationDtoIEnumerableServiceResponse' '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: Error Code servers: - url: /creditassessmentquery /api/providers/adapterSchemas: get: tags: - CreditAssessmentProvider summary: Get all Automated Credit Assessment Providers Adapter Schemas description: 'This method returns all Automated Credit Assessment Adapter Schema for given tenant Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetAllAdapterSchema 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 Adapter Schema is returned content: application/json: schema: $ref: '#/components/schemas/AdapterSchemaDtoIEnumerableServiceResponse' '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: Error Code servers: - url: /creditassessmentquery /api/providers/{providerId}/configurationSummary: get: tags: - CreditAssessmentProvider 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: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetCreditAssessmentProviderConfigurationSummaryByProviderId 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: application/json: schema: $ref: '#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse' '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 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: Error Code servers: - url: /creditassessmentquery /api/providers/configurationSummaries: get: tags: - CreditAssessmentProvider summary: Gets a summarised result of the statuses associated with a provider description: 'This method returns summaries of all providers which includes details about the providers themselves, the configuration, mapping configuration and adapter schema statues. Required permissions: At least one of the following permissions is required: AutomatedCreditAssessmentAccess, CreditAssessmentConfigurationAccess' operationId: GetCreditAssessmentProviderConfigurationSummaries 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. A list of Configuration Summaries is returned content: application/json: schema: $ref: '#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse' '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 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: Error Code servers: - url: /creditassessmentquery components: schemas: ProviderConfigurationSecurityKeysDto: type: object properties: authenticationKey: type: - string - 'null' encryptionKey: type: - string - 'null' 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 CreditAssessmentProviderDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreditAssessmentProviderDto' additionalProperties: false SchemaDto: type: object properties: initiateAutomatedCreditAssessmentRequest: $ref: '#/components/schemas/SchemaEntryDto' initiateAutomatedCreditAssessmentResult: $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 CreditAssessmentProviderDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreditAssessmentProviderDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' 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 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 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 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 CreditAssessmentProviderDto: type: object properties: id: type: string description: Credit Assessment Provider UiD format: uuid example: e381900c-cd27-4024-ad84-52145f0bea4e name: type: - string - 'null' description: Provider Name example: Experian Test enabled: type: - boolean - 'null' description: Flag to check if provider is Eanbled or not example: false internalIdentifier: type: - string - 'null' description: The internal identifier for a provider example: equifax-sample additionalProperties: false description: Provider Schema 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 initiateAutomatedCreditAssessmentRequest: $ref: '#/components/schemas/MappingDto' initiateAutomatedCreditAssessmentResult: $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 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 AdapterSchemaDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/AdapterSchemaDto' 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 providerInternalIdentifier: type: - string - 'null' additionalProperties: false SchemaDto_2: type: object properties: initiateAutomatedCreditAssessmentRequest: allOf: - $ref: '#/components/schemas/SchemaEntryDto_2' description: "Adapter Configuration request schema \nIt contains list of fields" initiateAutomatedCreditAssessmentResult: 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 AdapterSchemaDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AdapterSchemaDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreditAssessmentProviderDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CreditAssessmentProviderDto_2' description: Provider Schema messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false 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 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 CreditAssessmentProviderDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/CreditAssessmentProviderDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreditAssessmentProviderDto_2: type: object properties: id: type: string description: Credit Assessment Provider UiD format: uuid example: e381900c-cd27-4024-ad84-52145f0bea4e name: type: - string - 'null' description: Provider Name example: Experian Test 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 MappingConfigurationDto_2: type: object properties: id: type: string format: uuid providerId: type: string format: uuid initiateAutomatedCreditAssessmentRequest: allOf: - $ref: '#/components/schemas/MappingDto' description: The mapping configuration request schema for request initiateAutomatedCreditAssessmentResult: allOf: - $ref: '#/components/schemas/MappingDto' description: The mapping configuration result schema for request additionalProperties: false description: Mapping Configuration 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 securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-creditassessmentcommand-v1-0-openapi.json - fenergo-creditassessmentquery-v1-0-openapi.json