openapi: 3.2.0 info: title: Fenergo Manual Credit Screening API version: '1.0' description: 'Operations tagged ManualCreditScreening 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: ManualCreditScreening paths: /api/manual/set: post: tags: - ManualCreditScreening summary: Create a new Manual Credit Screening Set description: 'Creates a new Manual Credit Screening Set for a specific entitiy, journey, task id. It also creates a new Manual Credit Screening Version with a status of "Draft". Required permissions: Following permissions are required: ManualCreditScreeningCreate' operationId: CreateManualCreditScreeningSet 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: Manual Credit Screening Set content: application/json: schema: $ref: '#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '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/manual/set/{setId}/version: post: tags: - ManualCreditScreening summary: Create a new Manual Credit Screening Version for an existing Manual Credit… description: 'This method creates a new Manual Credit Screening Version The new version initializes with the DTO data. It is assigned the next available version number, with the default status of "Draft". Note that the latest existing version must not have a status of "Draft" to be able to create a new version. Required permissions: Following permissions are required: ManualCreditScreeningEdit' operationId: CreateManualCreditScreeningVersion parameters: - name: setId in: path description: Manual Credit Screening Set Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Manual Credit Screening Version group data content: application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionGroupDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionGroupDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionGroupDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Set with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/manual/set/{setId}/version/{versionNumber}: put: tags: - ManualCreditScreening summary: Update a Manual Credit Screening Version description: 'This method updates an existing Manual Credit Screening Version. Only Manual Credit Screening Version with "Draft" status can be updated. Required permissions: Following permissions are required: ManualCreditScreeningEdit' operationId: UpdateManualCreditScreeningVersion parameters: - name: setId in: path description: Manual Credit Screening Set Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Manual Credit Screening Version Number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Manual Credit Screening Version data content: application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Set with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - ManualCreditScreening summary: Get a Manual Credit Screening Version by Set Id and version number description: 'This method returns the Manual Credit Screening of set Id and version number Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetManualCreditScreeningVersionBySetIdVersionNumber parameters: - name: setId in: path description: The id of the Manual Credit Screening Version to retrieve required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the Manual Credit Screening Version to retrieve required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A Manual Credit Screening Dto is returned content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Version with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/manual/set/{setId}/version/{versionNumber}/complete: put: tags: - ManualCreditScreening summary: Update a Manual Credit Screening Version Status to "Completed" description: 'This method updates an existing Manual Credit Screening Version status to "Completed". Only Manual Credit Screening Version with the status of "Draft" can be updated. This route has the same functionality as the updating version status to reject (the route below). Required permissions: Following permissions are required: ManualCreditScreeningEdit' operationId: UpdateManualCreditVersionScreeningStatusToCompleted parameters: - name: setId in: path description: Manual Credit Screening Set Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Manual Credit Screening Version Number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Set with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/manual/set/{setId}/version/{versionNumber}/reject: put: tags: - ManualCreditScreening summary: Update a Manual Credit Screening Version Status to "Rejected" description: 'This method updates an existing Manual Credit Screening Version status to "Rejected". Only Manual Credit Screening Versions with the status of "Draft" can be updated. This route has the same functionality as the updating version status to completed (the route above). Required permissions: Following permissions are required: ManualCreditScreeningEdit' operationId: UpdateManualCreditVersionScreeningStatusToRejected parameters: - name: setId in: path description: Manual Credit Screening Set Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Manual Credit Screening Version Number required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Set with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningcommand /api/manual/set/{setId}/snapshot: post: tags: - ManualCreditScreening summary: Take a snapshot Manual Credit Screening Version description: 'This method take a snapshot for a Manual Credit Screening Version. Required permissions: Following permissions are required: ManualCreditScreeningEdit' operationId: SnapshotManualCreditScreeningVersion parameters: - name: setId in: path description: Manual Credit Screening Set Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Manual Credit Screening Snapshot data content: application/json: schema: $ref: '#/components/schemas/SnapshotSetServiceRequest' text/json: schema: $ref: '#/components/schemas/SnapshotSetServiceRequest' application/*+json: schema: $ref: '#/components/schemas/SnapshotSetServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse' application/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse' text/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse' '400': description: Invalid request content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Manual Credit Screening Set with given ID does not exists type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' 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/manual/set/{setId}: get: tags: - ManualCreditScreening summary: Get Manual Credit Screening Set By SetId and their all their versions description: 'This method returns a Manual Credit Screening Set and their related versions Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetManualCreditScreeningBySetId parameters: - name: setId 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 Manual Credit Screeening Set and their related versions. content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Set with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/manual/set/{setId}/version/latest: get: tags: - ManualCreditScreening summary: Get the latest Manual Credit Screening version by their setId description: 'This method returns the latest Manual Credit Screening Version by Set Id Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetLatestManualCreditScreeningVersionBySetId parameters: - name: setId 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 latest ManualCreditScreening Version is returned content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Version with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/manual/entity/{entityId}/journey/{journeyId}/task/{taskId}: get: tags: - ManualCreditScreening summary: Get a Manual Credit Screening Set and its latest Version by Entity, Journey and… description: 'This method returns a Manual Credit Screening Set and the latest manual credit screening version by entity, journey and task id. Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetManualScreeningByEntityJourneyTaskId 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. The ManualCreditScreeningSet is returned content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Set with latest version does not exist with the given ids type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/manual/journey/{journeyId}/task/{taskId}: get: tags: - ManualCreditScreening summary: Get a list of Manual Credit Screening Set and its latest Version by Journey and… description: 'This method returns a list of Manual Credit Screening Set and the manual credit screening version by journey and task id. Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetManualScreeningByJourneyTaskId 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 ManualCreditScreeningSet is returned content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Set with latest version does not exist with the given ids type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/manual/journey/{journeyId}/task/{taskId}/screening-in-scope: get: tags: - ManualCreditScreening summary: Get a list of Manual Credit Screening Set and its latest Version by Journey and… description: 'This method returns a list of Manual Credit Screening Set and the manual credit screening version by journey and task id which are in scope. Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetInScopedManualScreeningByJourneyTaskId 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 ManualCreditScreeningSet is returned content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningSetDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Set with latest version does not exist with the given ids type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/manual/version/{id}: get: tags: - ManualCreditScreening summary: Get a Manual Credit Screening Version of a specified Id description: 'This method returns the Manual Credit Screening of specified Id. Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetManualCreditScreeningVersionById parameters: - name: id in: path description: The id of the Manual Credit Screening Version to retrieve 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 Manual Credit Screening Dto is returned content: text/plain: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' application/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' text/json: schema: $ref: '#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Version with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/manual/set/{setId}/snapshot/latest: get: tags: - ManualCreditScreening summary: Get the latest Manual Credit Screening Version Snapshot description: 'This method returns the latest Manual Credit Screening Version snapshot of specified Id. Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetManualCreditScreeningSnapshotBySetIdQuery parameters: - name: setId in: path description: The set id of the Manual Credit Screening snapshot to retrieve 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 Manual Credit Screening Snapshot is returned content: text/plain: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse_2' application/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse_2' text/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Version with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/manual/journey/{journeyId}/task/{taskId}/snapshot: get: tags: - ManualCreditScreening summary: Get the list of latest Manual Credit Screening Version Snapshot description: 'This method returns a list of latest Manual Credit Screening Version snapshot of specified journey and task Id. Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetManualCreditScreeningSnapshotByJourneyTaskIdQuery parameters: - name: journeyId in: path description: The journey id of the Manual Credit Screening snapshot to retrieve required: true schema: type: string format: uuid - name: taskId in: path description: The task id of the Manual Credit Screening snapshot to retrieve 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 list of Manual Credit Screening Snapshot is returned content: text/plain: schema: $ref: '#/components/schemas/SnapshotSetIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/SnapshotSetIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/SnapshotSetIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Version with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery /api/manual/set/{setId}/version/{versionNumber}/snapshot: get: tags: - ManualCreditScreening summary: Get a Manual Credit Screening Version Snapshot by version number description: 'This method returns the Manual Credit Screening snapshot of specified Id and Version. Required permissions: Following permissions are required: ManualCreditScreeningAccess' operationId: GetManualCreditScreeningSnapshotBySetIdAndVersionQuery parameters: - name: setId in: path description: The set id of the Manual Credit Screening snapshot to retrieve required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the Manual Credit Screening snapshot to retrieve required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. A Manual Credit Screening Snapshot is returned content: text/plain: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse_2' application/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse_2' text/json: schema: $ref: '#/components/schemas/SnapshotSetServiceResponse_2' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Manual Credit Screening Version with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /creditscreeningquery components: schemas: SpecialCharactersRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' excludedCharacters: type: - array - 'null' items: type: string additionalProperties: false SnapshotSetServiceResponse: type: object properties: data: $ref: '#/components/schemas/SnapshotSet' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ExternalProviderRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' providerId: type: string format: uuid additionalProperties: false CreateNewManualCreditScreeningSetDto: type: object properties: id: type: string description: Id of the manual credit screening format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 entityId: type: string description: Entity 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 taskDataKey: type: - string - 'null' description: Task DataKey example: ket one name: type: - string - 'null' description: Name of this manual credit screening. status: type: - string - 'null' description: Manual Credit Screening Set Status example: Draft jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' additionalProperties: false CreateNewManualCreditScreeningSetDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateNewManualCreditScreeningSetDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValidationDataDto: type: object properties: isMandatory: $ref: '#/components/schemas/BasicRuleDto' specialCharacters: $ref: '#/components/schemas/SpecialCharactersRuleDto' noNumbers: $ref: '#/components/schemas/BasicRuleDto' onlyInteger: $ref: '#/components/schemas/BasicRuleDto' noNegative: $ref: '#/components/schemas/BasicRuleDto' onlyDecimal: $ref: '#/components/schemas/BasicRuleDto' regex: $ref: '#/components/schemas/RegexRuleDto' characterLimit: $ref: '#/components/schemas/ValueLimitRuleDto' numberLimit: $ref: '#/components/schemas/ValueLimitRuleDto' noFutureDates: $ref: '#/components/schemas/BasicRuleDto' noPastDates: $ref: '#/components/schemas/BasicRuleDto' dateLimit: $ref: '#/components/schemas/DateLimitRuleDto' multiSelectLimit: $ref: '#/components/schemas/ValueLimitRuleDto' collectionMinimumCount: $ref: '#/components/schemas/CollectionMinimumCountRuleDto' collectionMaximumCount: $ref: '#/components/schemas/CollectionMaximumCountRuleDto' externalProvider: $ref: '#/components/schemas/ExternalProviderRuleDto' additionalProperties: false CollectionMaximumCountRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: - integer - 'null' format: int32 overallMaximumCount: type: - integer - 'null' format: int32 additionalProperties: false ValueLimitRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' minValue: type: - integer - 'null' format: int32 maxValue: type: - integer - 'null' format: int32 additionalProperties: false BasicRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' additionalProperties: false GroupRequirement: type: object properties: name: type: - string - 'null' key: type: - string - 'null' primaryDataGroupField: type: - string - 'null' snapshotPropertyItems: type: - array - 'null' items: $ref: '#/components/schemas/GroupRequirementItem' validationRule: $ref: '#/components/schemas/ValidationRuleDto' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SnapshotSetServiceRequest: type: object properties: data: $ref: '#/components/schemas/SnapshotSet' additionalProperties: false SnapshotSet: type: object properties: setId: type: string format: uuid tenantId: type: string format: uuid versionNumber: type: integer format: int32 snapshotGroups: type: - array - 'null' items: $ref: '#/components/schemas/GroupRequirement' screeningOutcome: $ref: '#/components/schemas/Requirement' additionalProperties: false ManualCreditScreeningVersionDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/ManualCreditScreeningVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ManualCreditScreeningItemSetDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningItemDto' additionalProperties: false CreateNewManualCreditScreeningSetDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreateNewManualCreditScreeningSetDto' additionalProperties: false ManualCreditScreeningGroupDto: type: object properties: itemsSets: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningItemSetDto' additionalProperties: false Requirement: type: object properties: key: type: - string - 'null' label: type: - string - 'null' type: type: - string - 'null' order: type: - integer - 'null' format: int32 separator: type: - string - 'null' category: type: - string - 'null' validationRule: $ref: '#/components/schemas/ValidationRuleDto' additionalProperties: false GroupRequirementItem: type: object properties: key: type: - string - 'null' label: type: - string - 'null' valueType: type: - string - 'null' order: type: integer format: int32 isAdditionalField: type: boolean validationRule: $ref: '#/components/schemas/ValidationRuleDto' additionalProperties: false VersionedJurisdictionDto: type: object properties: jurisdiction: type: - string - 'null' versionId: type: string format: uuid additionalProperties: false CollectionMinimumCountRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' requiredTypesMinCount: type: - object - 'null' additionalProperties: type: - integer - 'null' format: int32 overallMinimumCount: type: integer format: int32 additionalProperties: false ManualCreditScreeningItemDto: type: object properties: key: type: - string - 'null' value: type: - string - 'null' valueTypes: type: - string - 'null' separator: type: - string - 'null' additionalProperties: false ValidationRuleDto: type: object properties: id: type: string format: uuid setId: type: string format: uuid propertyId: type: string format: uuid dataGroupId: type: - string - 'null' format: uuid isDataGroup: type: boolean propertyName: type: - string - 'null' friendlyName: type: - string - 'null' validationType: type: - string - 'null' validationData: $ref: '#/components/schemas/ValidationDataDto' additionalProperties: false DateLimitRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' minDate: type: - string - 'null' format: date-time maxDate: type: - string - 'null' format: date-time 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 ManualCreditScreeningVersionDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/ManualCreditScreeningVersionDto' additionalProperties: false ManualCreditScreeningVersionGroupDto: type: object properties: manualCreditScreeningGroups: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/ManualCreditScreeningGroupDto' screeningOutcome: type: - string - 'null' additionalProperties: false ManualCreditScreeningVersionGroupDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/ManualCreditScreeningVersionGroupDto' additionalProperties: false RegexRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' isCaseSensitive: type: boolean regexValue: type: - string - 'null' additionalProperties: false 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 ManualCreditScreeningVersionDto: type: object properties: id: type: string description: Id of the Manual Credit Screening Version format: uuid example: a4309731-77df-4e72-98e7-0d314b7a5151 versionNumber: type: integer description: Version Number of the Manual Credit Screening Version format: int32 example: 1 setId: type: string description: Manual Credit Screening Set GUiD format: uuid example: a4309731-77df-4e72-98e7-0d314b7a5151 status: type: - string - 'null' description: Manual Credit Screening Status example: Draft screeningOutcome: type: - string - 'null' description: The outcome of a screening version. example: Adverse Finding manualCreditScreeningGroups: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/ManualCreditScreeningGroupDto' additionalProperties: false SnapshotSetServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/SnapshotSet_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValidationDataDto_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto' noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto' regex: allOf: - $ref: '#/components/schemas/RegexRuleDto' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto' multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto' externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' additionalProperties: false SnapshotSetIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/SnapshotSet_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ManualCreditScreeningSetDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ManualCreditScreeningSetDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreditApprover: type: object properties: id: type: string format: uuid role: type: - string - 'null' additionalProperties: false GroupRequirement_2: type: object properties: name: type: - string - 'null' key: type: - string - 'null' primaryDataGroupField: type: - string - 'null' snapshotPropertyItems: type: - array - 'null' items: $ref: '#/components/schemas/GroupRequirementItem_2' validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_2' additionalProperties: false SnapshotSet_2: type: object properties: setId: type: string format: uuid tenantId: type: string format: uuid versionNumber: type: integer format: int32 snapshotGroups: type: - array - 'null' items: $ref: '#/components/schemas/GroupRequirement_2' screeningOutcome: allOf: - $ref: '#/components/schemas/Requirement_2' additionalProperties: false ManualCreditScreeningVersionDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ManualCreditScreeningVersionDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Requirement_2: type: object properties: key: type: - string - 'null' label: type: - string - 'null' type: type: - string - 'null' order: type: - integer - 'null' format: int32 separator: type: - string - 'null' category: type: - string - 'null' validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_2' additionalProperties: false ManualCreditScreeningSetDto: type: object properties: id: type: string description: Manual Credit Screening Set GUiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 entityId: type: string description: Entity Id which Manual Credit Screening Set belongs format: uuid example: 54953531-77df-4e72-98e7-0d314b7a5151 journeyId: type: string description: Journey Id which Manual Credit Screening belongs format: uuid example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4 taskId: type: string description: Task Id which Manual Credit Screening belongs format: uuid example: 2c3c8433-efc3-493b-9b14-70b7681c7342 taskDataKey: type: - string - 'null' description: Task DataKey example: key one name: type: - string - 'null' description: Name of this Manual Credit Screening example: Name status: type: - string - 'null' description: Manual Credit Screening Set Status example: Draft versions: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningVersionDto_2' description: List of Manual Credit Screenings Versions latestVersion: allOf: - $ref: '#/components/schemas/ManualCreditScreeningVersionDto_2' description: Latest Version of this Set additionalProperties: false ManualCreditScreeningSetDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningSetDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false GroupRequirementItem_2: type: object properties: key: type: - string - 'null' label: type: - string - 'null' valueType: type: - string - 'null' order: type: integer format: int32 isAdditionalField: type: boolean validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto_2' additionalProperties: false ValidationRuleDto_2: type: object properties: id: type: string format: uuid setId: type: string format: uuid propertyId: type: string format: uuid dataGroupId: type: - string - 'null' format: uuid isDataGroup: type: boolean propertyName: type: - string - 'null' friendlyName: type: - string - 'null' validationType: type: - string - 'null' validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_2' additionalProperties: false ManualCreditScreeningVersionDto_2: type: object properties: id: type: string description: Id of the Manual Credit Screening Version format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 setId: type: string description: Manual Credit Screening Set GUiD format: uuid example: a4309731-77df-4e72-98e7-0d314b7a5151 status: type: - string - 'null' description: Manual Credit Screening Status example: Draft versionNumber: type: integer description: Manual Credit Screening Version format: int32 example: 1 lastUpdatedDateTime: type: string description: The last time this version was updated. format: date-time approver: allOf: - $ref: '#/components/schemas/CreditApprover' description: The approver of this version. manualCreditScreeningGroups: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/ManualCreditScreeningGroupDto' screeningOutcome: type: - string - 'null' jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' 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