openapi: 3.2.0 info: title: Fenergo Credit Screening API version: '1.0' description: 'Operations tagged CreditScreening across 2 of this provider''s published API definitions: fenergo-creditscreeningcommand-v1-0-openapi.json, fenergo-creditscreeningquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /creditscreeningcommand - url: /creditscreeningquery security: - Bearer: [] tags: - name: CreditScreening paths: /api/creditscreening: post: tags: - CreditScreening summary: Create a new Credit Screening Enquiry description: 'This method creates a credit screening request that triggers asynchronous requests to different screening providers. The method returns the credit screening request DTO created in the system. Required permissions: At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningAccess' operationId: CreditScreening 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 Screening request content: application/json: schema: $ref: '#/components/schemas/CreditScreeningRequestDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CreditScreeningRequestDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CreditScreeningRequestDtoServiceRequest' responses: '202': description: Success. Request created content: text/plain: schema: $ref: '#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/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: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/creditscreening/{id}: delete: tags: - CreditScreening summary: Delete a Credit Screening Enquiry description: 'This method deletes a credit screening request. The method returns the credit screening request DTO created in the system. Required permissions: Following permissions are required: CreditScreeningDelete' operationId: DeleteCreditScreening 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: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/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: OBSOLETE_ENDPOINT get: tags: - CreditScreening summary: Get a Credit Screening Enquiry by Id description: 'This method returns the Credit Screening for given id. Required permissions: Following permissions are required: CreditScreeningAccess' operationId: GetCreditScreeningById 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. A credit screening details is returned content: text/plain: schema: $ref: '#/components/schemas/CreditScreeningDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreditScreeningDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreditScreeningDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/creditscreening/{id}/snapshot: get: tags: - CreditScreening summary: Get a Credit Screening Enquiry Snapshot by Credit Screening Enquiry Id description: 'This method returns the Credit Screening Enquiry Snapshot for given id. Required permissions: Following permissions are required: CreditScreeningAccess' operationId: GetCreditScreeningSnapshotById 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. A credit screening snapshot details is returned content: text/plain: schema: $ref: '#/components/schemas/CreditScreeningEnquirySnapshotDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreditScreeningEnquirySnapshotDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreditScreeningEnquirySnapshotDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/creditscreening/entity/{entityId}/journey/{journeyId}/task/{taskId}: get: tags: - CreditScreening summary: Get a Credit Screening by Entity, Journey and Task Id description: 'This method returns the Credit Screening for given id. Required permissions: Following permissions are required: CreditScreeningAccess' operationId: GetCreditScreeningByEntityJoureyTaskId 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. A credit screening details is returned content: text/plain: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/creditscreening/journey/{journeyId}: get: tags: - CreditScreening summary: Get all Credit Screenings by Journey Id description: 'This method returns the Credit Screening for given journey id. Required permissions: Following permissions are required: CreditScreeningAccess' operationId: GetCreditScreeningByJourneyId 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. The list of CreditScreenings is returned content: text/plain: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/creditscreening/journey/{journeyId}/task/{taskId}: get: tags: - CreditScreening summary: Get all Credit Screenings by Journey and Task Id description: 'This method returns the Credit Screening for given id. Required permissions: Following permissions are required: CreditScreeningAccess' operationId: GetCreditScreeningByJoureyTaskId parameters: - 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. The list of CreditScreenings is returned content: text/plain: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/creditscreening/journey/{journeyId}/task/{taskId}/screening-in-scope: get: tags: - CreditScreening summary: Get all Credit Screenings by Journey and Task Id which are in scope for this… description: 'This method returns the Credit Screening for task id and journey id. Required permissions: Following permissions are required: CreditScreeningAccess' operationId: GetInScopedCreditScreeningByJourneyTaskId parameters: - 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. The list of CreditScreenings is returned content: text/plain: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/CreditScreeningDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /entity/{entityId}/journey/{journeyId}/history: get: tags: - CreditScreening summary: Get the screening history for an entity description: 'This method returns the Credit Screening history items for the requested criteria. Required permissions: Following permissions are required: CreditScreeningAccess, ManualCreditScreeningAccess' operationId: GetScreeningHistoryByJourneyEntityId parameters: - name: journeyId in: path required: true schema: type: string format: uuid - name: entityId in: path required: true schema: type: string format: uuid - name: size in: query schema: type: integer format: int32 - name: from in: query schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A history response is returned content: text/plain: schema: $ref: '#/components/schemas/HistoryResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/HistoryResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/HistoryResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /entity/{entityId}/task/{taskId}/historysnapshot: get: tags: - CreditScreening summary: Get the screening history snapshot for an entity description: 'This method returns the Credit Screening history items that were snapshoted for the requested criteria. Required permissions: Following permissions are required: CreditScreeningAccess, ManualCreditScreeningAccess' operationId: GetScreeningHistorySnapshotByEntityIdTaskId parameters: - name: taskId in: path required: true schema: type: string format: uuid - name: entityId 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 history response is returned content: text/plain: schema: $ref: '#/components/schemas/HistoryResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/HistoryResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/HistoryResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery components: schemas: EnquiryResult: type: object properties: providerId: type: string format: uuid providerName: type: - string - 'null' referenceId: type: - string - 'null' description: id returns from provider api status: type: - string - 'null' description: 'Status of the enquiry result In Progress -> Completed, Failed, .....' createdOn: type: string format: date-time completedOn: type: - string - 'null' format: date-time expiry: type: - string - 'null' format: date-time requestedBy: type: - string - 'null' description: Requestor name 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 CreditScreeningRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreditScreeningRequestDto' additionalProperties: false CreditScreeningRequestDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/CreditScreeningRequestDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' 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 CreditScreeningRequestDto: type: object properties: entityId: type: string description: Entity id of credit screening format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 id: type: string description: Id of credit screening format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 journeyId: type: string description: Journey Id which credit screening belongs format: uuid example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4 taskId: type: string description: Task Id which credit screening belongs format: uuid example: 2c3c8433-efc3-493b-9b14-70b7681c7342 taskName: type: - string - 'null' description: Task Name which credit screening belongs searchCriteria: description: Schema that contains attributes to be used for credit screening enquiryResult: $ref: '#/components/schemas/EnquiryResult' additionalProperties: false description: The Credit Screening Schema 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 CreditScreeningEnquirySnapshotDto: type: object properties: creditScreeningEnquiryId: type: string format: uuid mappingConfiguration: allOf: - $ref: '#/components/schemas/MappingConfigurationDto' description: Mapping Configuration Schema 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: allOf: - $ref: '#/components/schemas/MappingDto' description: The nested mapping rules for mapping a nested object targetPropertyType: type: - string - 'null' description: The type of the targetProperty example: String hiddenIfNoValue: type: boolean description: hide this property in auto credit screening task if this flag is true and no value example: true additionalProperties: false description: The schema that contains info of designated property HistoryResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/HistoryResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreditScreeningDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreditScreeningDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreditScreeningEnquirySnapshotDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreditScreeningEnquirySnapshotDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false MappingConfigurationDto: type: object properties: id: type: string format: uuid providerId: type: string format: uuid initiateCreditScreeningRequestDto: allOf: - $ref: '#/components/schemas/MappingDto' description: The mapping configuration request schema for request initiateCreditScreeningResultDto: allOf: - $ref: '#/components/schemas/MappingDto' description: The mapping configuration result schema for request additionalProperties: false description: Mapping Configuration Schema ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false CreditScreeningDto: type: object properties: entityId: type: string description: Entity id of credit screening format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 id: type: string description: Id of credit screening format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 journeyId: type: string description: Journey Id which credit screening belongs format: uuid example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4 taskId: type: string description: Task Id which credit screening belongs format: uuid example: 2c3c8433-efc3-493b-9b14-70b7681c7342 taskName: type: - string - 'null' description: Task name which credit screening belongs example: Automated Screening providerId: type: string description: Provider Id which credit screening is referring to format: uuid example: 58dcd00d-8a44-4de8-9fce-3c5be46675c2 searchCriteria: description: Schema that contains attributes to be used for credit screening enquiryResult: allOf: - $ref: '#/components/schemas/EnquiryResult' description: Results for credit screening internalIdentifier: type: - string - 'null' description: The internal identifier that a credit screening provider is known by example: internal_name isArchived: type: boolean description: Is credit screening archived flag example: true additionalProperties: false CreditScreeningDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/CreditScreeningDto' 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 HistoryResponseDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningHistoryItemDto' description: History items to be returned. totalItems: type: integer description: Total number of items. format: int32 screeningTypes: type: - array - 'null' items: type: string description: History items to be returned. additionalProperties: false ScreeningHistoryItemDto: type: object properties: screeningId: type: - string - 'null' description: The versionId for manual credit screening type, enquiryId for automated Credit screening type. format: uuid version: type: - integer - 'null' description: The version number of the screening. format: int32 entityId: type: string description: EntityId for which the screening is for. format: uuid type: type: - string - 'null' description: Whether the type of credit screening is Manual or Automated. status: type: - string - 'null' description: The status of the screening taskId: type: string description: The task Id the screening was completed in. format: uuid taskName: type: - string - 'null' description: The task name the screening was completed in. providerId: type: string description: The id of the provider that completed the screening. format: uuid providerName: type: - string - 'null' description: The name of the provider that completed the screening. approverId: type: - string - 'null' description: The Id of the individual that completed the screening. format: uuid approverTeam: type: - string - 'null' description: The team of the individual/provider that completed the screening. screeningDate: type: - string - 'null' description: The date the screening was started (automated) / completed (manual) on. format: date-time outcome: type: - string - 'null' description: The outcome result of the screening additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-creditscreeningcommand-v1-0-openapi.json - fenergo-creditscreeningquery-v1-0-openapi.json