openapi: 3.2.0 info: title: Fenergo Automated Credit Assessment API version: '1.0' description: 'Operations tagged AutomatedCreditAssessment 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: AutomatedCreditAssessment paths: /api/auto: post: tags: - AutomatedCreditAssessment summary: Create a new Automated Credit Assessment Enquiry description: 'This method creates an automated credit assessment request that triggers asynchronous requests to different assessment providers. The method returns the automated credit assessment request DTO created in the system. Required permissions: Following permissions are required: AutomatedCreditAssessmentEdit' operationId: AutomatedCreditAssessment parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The Create Automated Assessment request content: application/json: schema: $ref: '#/components/schemas/AutomatedCreditAssessmentRequestDtoServiceRequest' responses: '202': description: Success. Request created content: application/json: schema: $ref: '#/components/schemas/AutomatedCreditAssessmentRequestDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: Error Code get: tags: - AutomatedCreditAssessment summary: Get all Automated Credit Assessment Enquiries description: 'This method returns all Automated Credit Assessment Enquiries for given tenant Required permissions: Following permissions are required: AutomatedCreditAssessmentAccess' operationId: GetAutomatedCreditAssessments 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/AutomatedCreditAssessmentDtoIEnumerableServiceResponse' '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/auto/{id}: delete: tags: - AutomatedCreditAssessment summary: Delete an Automated Credit Assessment Enquiry description: 'This method deletes an automated credit assessment request. The method returns the automated credit assessment request DTO created in the system. Required permissions: Following permissions are required: AutomatedCreditAssessmentDelete' operationId: DeleteAutomatedCreditAssessment parameters: - name: id in: path description: The request id that needs to be updated required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Batch created '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: Error Code get: tags: - AutomatedCreditAssessment summary: Get an Automated Credit Assessment Enquiry by Id description: 'This method returns the Automated Credit Assessment for given id. Required permissions: Following permissions are required: AutomatedCreditAssessmentAccess' operationId: GetAutomatedCreditAssessmentById parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. An automated credit assessment details is returned content: application/json: schema: $ref: '#/components/schemas/AutomatedCreditAssessmentDtoServiceResponse' '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/auto/{id}/snapshot: get: tags: - AutomatedCreditAssessment summary: Get an Automated Credit Assessment Enquiry Snapshot by Automated Credit… description: 'This method returns the Automated Credit Assessment Enquiry Snapshot for given id. Required permissions: Following permissions are required: AutomatedCreditAssessmentAccess' operationId: GetAutomatedCreditAssessmentSnapshotById parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. An automated credit assessment snapshot details is returned content: application/json: schema: $ref: '#/components/schemas/AutoCreditAssessmentEnquirySnapshotDtoServiceResponse' '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/auto/entity/{entityId}/journey/{journeyId}/task/{taskId}: get: tags: - AutomatedCreditAssessment summary: Get an Automated Credit Assessment by Entity, Journey and Task Id description: 'This method returns the Automated Credit Assessment for given id. Required permissions: Following permissions are required: AutomatedCreditAssessmentAccess' operationId: GetAutomatedCreditAssessmentByEntityJourneyTaskId parameters: - name: entityId in: path required: true schema: type: string format: uuid - name: journeyId in: path required: true schema: type: string format: uuid - name: taskId 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 details is returned content: application/json: schema: $ref: '#/components/schemas/AutomatedCreditAssessmentDtoIEnumerableServiceResponse' '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/auto/journey/{journeyId}: get: tags: - AutomatedCreditAssessment summary: Get an Automated Credit Assessment by Journey Id description: 'This method returns the Automated Credit Assessment for given journey id. Required permissions: Following permissions are required: AutomatedCreditAssessmentAccess' operationId: GetAutomatedCreditAssessmentByJourneyId parameters: - name: journeyId 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 details is returned content: application/json: schema: $ref: '#/components/schemas/AutomatedCreditAssessmentDtoIEnumerableServiceResponse' '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 components: schemas: AutomatedCreditAssessmentRequestDto: type: object properties: entityId: type: string description: Entity id of automated credit Assessment format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 id: type: string description: Id of automated credit Assessment format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 name: type: - string - 'null' description: Name of automated credit Assessment example: Automated Credit Assessment journeyId: type: string description: Journey Id which automated credit Assessment belongs format: uuid example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4 taskId: type: string description: Task Id which automated credit Assessment belongs format: uuid example: 2c3c8433-efc3-493b-9b14-70b7681c7342 searchCriteria: description: Schema that contains attributes to be used for automated credit Assessment enquiryResult: $ref: '#/components/schemas/EnquiryResult' additionalProperties: false description: The Credit Automated Assessment Schema AutomatedCreditAssessmentRequestDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AutomatedCreditAssessmentRequestDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false EnquiryResult: type: object properties: providerId: type: string format: uuid providerName: type: - string - 'null' referenceId: type: - string - 'null' status: type: - string - 'null' createdOn: type: string format: date-time completedOn: type: - string - 'null' format: date-time expiry: type: - string - 'null' format: date-time requestedBy: type: - string - 'null' errors: type: - array - 'null' items: type: string resultOutcome: type: - object - 'null' additionalProperties: {} isCompleted: type: boolean readOnly: true isInProgress: type: boolean readOnly: true isFailed: type: boolean readOnly: true additionalProperties: false AutomatedCreditAssessmentRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/AutomatedCreditAssessmentRequestDto' 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: {} ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' 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 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: 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 AutomatedCreditAssessmentDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AutomatedCreditAssessmentDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AutoCreditAssessmentEnquirySnapshotDto: type: object properties: autoCreditAssessmentEnquiryId: type: string format: uuid mappingConfiguration: allOf: - $ref: '#/components/schemas/MappingConfigurationDto' description: Mapping Configuration Schema additionalProperties: false MappingConfigurationDto: 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 ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false AutomatedCreditAssessmentDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AutomatedCreditAssessmentDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AutomatedCreditAssessmentDto: type: object properties: entityId: type: string description: Entity id of automated credit assessment format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 id: type: string description: Id of automated credit assessment format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 name: type: - string - 'null' description: Name of automated credit assessment example: Automated Credit Assessment journeyId: type: string description: Journey Id which automated credit assessment belongs format: uuid example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4 taskId: type: string description: Task Id which automated credit assessment belongs format: uuid example: 2c3c8433-efc3-493b-9b14-70b7681c7342 providerId: type: string description: Provider Id which automated credit assessment is referring to format: uuid example: 58dcd00d-8a44-4de8-9fce-3c5be46675c2 providerInternalIdentifier: type: - string - 'null' description: A unique identifier for the provider. searchCriteria: description: Schema that contains attributes to be used for automated credit assessment enquiryResult: allOf: - $ref: '#/components/schemas/EnquiryResult' description: Results for automated credit assessment additionalProperties: false AutoCreditAssessmentEnquirySnapshotDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AutoCreditAssessmentEnquirySnapshotDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false 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 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 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 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