{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula CreditScreening Query", "description": "**CreditScreening Query API**:\n\n
CreditScreening Query API retrieves creditscreenings and aggregates.\n\n
**CreditScreening Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/creditscreeningquery" } ], "paths": { "/api/creditscreening/{id}": { "get": { "tags": [ "CreditScreening" ], "summary": "Get a Credit Screening Enquiry by Id.", "description": "\nThis 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" } ] } } } } } } }, "/api/creditscreening/{id}/snapshot": { "get": { "tags": [ "CreditScreening" ], "summary": "Get a Credit Screening Enquiry Snapshot by Credit Screening Enquiry Id.", "description": "\nThis 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" } ] } } } } } } }, "/api/creditscreening/entity/{entityId}/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "CreditScreening" ], "summary": "Get a Credit Screening by Entity, Journey and Task Id.", "description": "\nThis 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" } ] } } } } } } }, "/api/creditscreening/journey/{journeyId}": { "get": { "tags": [ "CreditScreening" ], "summary": "Get all Credit Screenings by Journey Id.", "description": "\nThis 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" } ] } } } } } } }, "/api/creditscreening/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "CreditScreening" ], "summary": "Get all Credit Screenings by Journey and Task Id.", "description": "\nThis 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" } ] } } } } } } }, "/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 task.", "description": "\nThis 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" } ] } } } } } } }, "/entity/{entityId}/journey/{journeyId}/history": { "get": { "tags": [ "CreditScreening" ], "summary": "Get the screening history for an entity.", "description": "\nThis 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" } ] } } } } } } }, "/entity/{entityId}/task/{taskId}/historysnapshot": { "get": { "tags": [ "CreditScreening" ], "summary": "Get the screening history snapshot for an entity.", "description": "\nThis 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" } ] } } } } } } }, "/api/providers": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Get all Credit Screening Providers.", "description": "\nThis method returns all Credit Screening Providers for given tenant

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetAllCreditScreeningProviders", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of CreditScreenings is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/providers/{providerId}": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Get a Credit Screening Providers by Id.", "description": "\nThis method returns the Credit Screening Providers for given Provider Id.

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetCreditScreeningProvidersById", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A credit screening provider is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/providers/configurations": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Get all Credit Screening Providers Configurations.", "description": "\nThis method returns all Credit Screening Providers Configuration for given tenant

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetAllCreditScreeningProvidersConfiguration", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of CreditScreenings is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/providers/{providerId}/configuration": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Get a Credit Screening Provider Configuration by Provider Id.", "description": "\nThis method returns the Credit Screening Providers for given Provider Id.

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetCreditScreeningProviderConfigurationById", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A credit screening provider is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/providers/mappingconfigurations": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Get all Credit Screening Providers Mapping Configurations.", "description": "\nThis method returns all Credit Screening Mapping Configuration for given tenant

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetAllCreditScreeningMappingConfiguration", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of Mapping Configuration is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/providers/{providerId}/mappingconfiguration": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Get a Credit Screening Mapping Configuration by Provider Id.", "description": "\nThis method returns the Credit Screening Mapping Configuration for given Provider Id.

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetCreditScreeningMappingConfigurationByProviderId", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A credit screening mapping configuration is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/providers/{providerId}/adapterSchema": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Get a Credit Screening Adapter Schema by Provider Id.", "description": "\nThis method returns the Credit Screening Adapter Schema for given Provider Id.

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetCreditScreeningAdapterSchemaByProviderId", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A credit screening adapter schema is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/providers/{providerId}/test": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Get a test result for a Provider by Provider Id", "description": "\nThis method returns the Provider Test Result for given Provider Id.

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetProviderTestResult", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Provider Test Result is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderTestResultDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderTestResultDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderTestResultDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/providers/{providerId}/configurationsummary": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Gets a summarised result of the statuses associated with a provider.", "description": "\nThis method returns a summary of the provider which includes details about the provider itself,\r\n\nthe configuration, mapping configuration and adapter schema statues for given Provider Id.

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetCreditScreeningProviderConfigurationSummaryByProviderId", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Configuration Summary is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/providers/configurationsummary": { "get": { "tags": [ "CreditScreeningProvider" ], "summary": "Gets a summarised result of the statuses associated with all provider that are associated with a tenant.", "description": "\nThis method returns a summary of the provider which includes details about the provider itself,\r\n\nthe configuration, mapping configuration and adapter schema statues for all providers..

Required permissions:
At least one of the following permissions is required: CreditScreeningAccess, CreditScreeningDataSourcesAccess", "operationId": "GetCreditScreeningProviderConfigurationSummaries", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of configuration summaries is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/set/{setId}": { "get": { "tags": [ "ManualCreditScreening" ], "summary": "Get Manual Credit Screening Set By SetId and their all their versions.", "description": "\nThis 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" } ] } } } } } } }, "/api/manual/set/{setId}/version/latest": { "get": { "tags": [ "ManualCreditScreening" ], "summary": "Get the latest Manual Credit Screening version by their setId.", "description": "\nThis 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" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/manual/set/{setId}/version/{versionNumber}": { "get": { "tags": [ "ManualCreditScreening" ], "summary": "Get a Manual Credit Screening Version by Set Id and version number", "description": "\nThis 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" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/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 Task Id.", "description": "\nThis method returns a Manual Credit Screening Set and\r\n\nthe 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" } ] } } } } } } }, "/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 Task Id.", "description": "\nThis method returns a list of Manual Credit Screening Set and\r\n\nthe 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" } ] } } } } } } }, "/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 Task Id,\r\nwhich are in-scope for this task.", "description": "\nThis method returns a list of Manual Credit Screening Set and\r\n\nthe 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" } ] } } } } } } }, "/api/manual/version/{id}": { "get": { "tags": [ "ManualCreditScreening" ], "summary": "Get a Manual Credit Screening Version of a specified Id", "description": "\nThis 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" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/manual/set/{setId}/snapshot/latest": { "get": { "tags": [ "ManualCreditScreening" ], "summary": "Get the latest Manual Credit Screening Version Snapshot", "description": "\nThis 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" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/manual/journey/{journeyId}/task/{taskId}/snapshot": { "get": { "tags": [ "ManualCreditScreening" ], "summary": "Get the list of latest Manual Credit Screening Version Snapshot", "description": "\nThis 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" } ] } } } } } } }, "/api/manual/set/{setId}/version/{versionNumber}/snapshot": { "get": { "tags": [ "ManualCreditScreening" ], "summary": "Get a Manual Credit Screening Version Snapshot by version number", "description": "\nThis 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" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } } } }, "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" } ] } } } } } } } }, "components": { "schemas": { "AdapterConfigurationDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdapterSchemaDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the schema", "format": "uuid" }, "providerId": { "type": "string", "description": "Provider Id of the schema", "format": "uuid" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/SchemaDto" } ], "description": "The schema contains request and result schema", "nullable": true } }, "additionalProperties": false, "description": "Adapter Configuration Schema" }, "AdapterSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AdapterSchemaDto" } ], "description": "Adapter Configuration Schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "nullable": true }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "nullable": true }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreditApprover": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "role": { "type": "string", "nullable": true } }, "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", "description": "Task name which credit screening belongs", "nullable": true, "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", "nullable": true }, "enquiryResult": { "allOf": [ { "$ref": "#/components/schemas/EnquiryResult" } ], "description": "Results for credit screening", "nullable": true }, "internalIdentifier": { "type": "string", "description": "The internal identifier that a credit screening provider is known by", "nullable": true, "example": "internal_name" }, "isArchived": { "type": "boolean", "description": "Is credit screening archived flag", "example": true } }, "additionalProperties": false }, "CreditScreeningDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditScreeningDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditScreeningDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreditScreeningDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditScreeningEnquirySnapshotDto": { "type": "object", "properties": { "creditScreeningEnquiryId": { "type": "string", "format": "uuid" }, "mappingConfiguration": { "allOf": [ { "$ref": "#/components/schemas/MappingConfigurationDto" } ], "description": "Mapping Configuration Schema", "nullable": true } }, "additionalProperties": false }, "CreditScreeningEnquirySnapshotDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreditScreeningEnquirySnapshotDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "EnquiryResult": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "providerName": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "description": "id returns from provider api", "nullable": true }, "status": { "type": "string", "description": "Status of the enquiry result\r\nIn Progress -> Completed, Failed, .....", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "expiry": { "type": "string", "format": "date-time", "nullable": true }, "requestedBy": { "type": "string", "description": "Requestor name", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "resultOutcome": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "isCompleted": { "type": "boolean", "readOnly": true }, "isInProgress": { "type": "boolean", "readOnly": true }, "isFailed": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ExternalProviderRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "FieldDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "" }, "friendlyName": { "type": "string", "description": "Friendly name of the field\r\nFor display purpose", "nullable": true, "example": "" }, "isMandatory": { "type": "boolean", "description": "The flag to set if property is mandatory" }, "type": { "type": "string", "description": "Type of the field", "nullable": true, "example": "String" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "Address line 1" }, "nestedFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "description": "Nested field", "nullable": true } }, "additionalProperties": false, "description": "The Field schema" }, "GroupRequirement": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "primaryDataGroupField": { "type": "string", "nullable": true }, "snapshotPropertyItems": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRequirementItem" }, "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "GroupRequirementItem": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "valueType": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "isAdditionalField": { "type": "boolean" }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "HistoryResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningHistoryItemDto" }, "description": "History items to be returned.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total number of items.", "format": "int32" }, "screeningTypes": { "type": "array", "items": { "type": "string" }, "description": "History items to be returned.", "nullable": true } }, "additionalProperties": false }, "HistoryResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/HistoryResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningGroupDto": { "type": "object", "properties": { "itemsSets": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningItemSetDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningItemDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "valueTypes": { "type": "string", "nullable": true }, "separator": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningItemSetDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningItemDto" }, "nullable": true } }, "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", "description": "Task DataKey", "nullable": true, "example": "key one" }, "name": { "type": "string", "description": "Name of this Manual Credit Screening", "nullable": true, "example": "Name" }, "status": { "type": "string", "description": "Manual Credit Screening Set Status", "nullable": true, "example": "Draft" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDto" }, "description": "List of Manual Credit Screenings Versions", "nullable": true }, "latestVersion": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningVersionDto" } ], "description": "Latest Version of this Set", "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningSetDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningSetDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningSetDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningVersionDto": { "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", "description": "Manual Credit Screening Status", "nullable": true, "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.", "nullable": true }, "manualCreditScreeningGroups": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ManualCreditScreeningGroupDto" }, "nullable": true }, "screeningOutcome": { "type": "string", "nullable": true }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningVersionDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "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", "nullable": true }, "initiateCreditScreeningResultDto": { "allOf": [ { "$ref": "#/components/schemas/MappingDto" } ], "description": "The mapping configuration result schema for request", "nullable": true } }, "additionalProperties": false, "description": "Mapping Configuration Schema" }, "MappingConfigurationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MappingConfigurationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "MappingConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MappingConfigurationDto" } ], "description": "Mapping Configuration Schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "MappingDto": { "type": "object", "properties": { "ruleSets": { "type": "array", "items": { "$ref": "#/components/schemas/MappingRuleSetDto" }, "description": "The list that contains all the mapping rules for a provider\r\nIt can be for request or result mapping configuration", "nullable": true } }, "additionalProperties": false, "description": "The schema for mapping configuration request and result" }, "MappingRuleDto": { "type": "object", "properties": { "order": { "type": "integer", "description": "This order will be used to generate mapping Path", "format": "int32" }, "propertyName": { "type": "string", "description": "Property Name", "nullable": true }, "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" }, "MappingRuleSetDto": { "type": "object", "properties": { "mappingRules": { "type": "array", "items": { "$ref": "#/components/schemas/MappingRuleDto" }, "description": "The list that contains all of the mapping rules", "nullable": true }, "targetProperty": { "type": "string", "description": "The targetProperty for mapping destination", "nullable": true, "example": "address" }, "targetPropertyFriendlyName": { "type": "string", "description": "The targetProperty friendly name for display", "nullable": true, "example": "address" }, "nestedMappingRules": { "allOf": [ { "$ref": "#/components/schemas/MappingDto" } ], "description": "The nested mapping rules for mapping a nested object", "nullable": true }, "targetPropertyType": { "type": "string", "description": "The type of the targetProperty", "nullable": true, "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" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProviderConfigurationDetailsDto": { "type": "object", "properties": { "description": { "type": "string", "description": "Configuration property description", "nullable": true, "example": "Address line 1" }, "friendlyName": { "type": "string", "description": "The display name for the property", "nullable": true, "example": "Address" }, "mandatory": { "type": "boolean", "description": "Flag to set if property is mandatory", "example": false }, "name": { "type": "string", "description": "Name", "nullable": true, "example": "Address" }, "type": { "type": "string", "description": "The tpye of the property", "nullable": true, "example": "String" }, "value": { "type": "string", "description": "The value of the property", "nullable": true, "example": "George Street" }, "maskRequired": { "type": "boolean", "description": "Flag to set if property needs to be masked", "example": false } }, "additionalProperties": false, "description": "Provider Configuration Schema" }, "ProviderConfigurationDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "Provider Id", "format": "uuid" }, "configurationList": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigurationDetailsDto" }, "description": "List of Configuration Details Schema", "nullable": true }, "adapterConfiguration": { "allOf": [ { "$ref": "#/components/schemas/AdapterConfigurationDto" } ], "description": "Schema of Adapter Configuration", "nullable": true }, "providerConfigurationSecurityKeys": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationSecurityKeysDto" } ], "description": "Configuration keys for provider", "nullable": true } }, "additionalProperties": false, "description": "Provider Configuration top layer schema" }, "ProviderConfigurationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigurationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationDto" } ], "description": "Provider Configuration top layer schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSecurityKeysDto": { "type": "object", "properties": { "authenticationKey": { "type": "string", "nullable": true }, "encryptionKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSummaryDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" }, "mappingStatus": { "type": "string", "nullable": true }, "adapterStatus": { "type": "string", "nullable": true }, "authenticationStatus": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "isCustom": { "type": "boolean" }, "internalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSummaryDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSummaryDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationSummaryDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Credit Screening Provider UiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "name": { "type": "string", "description": "Provider Name", "nullable": true, "example": "Equifax" }, "enabled": { "type": "boolean", "description": "Flag to check if provider is Eanbled or not", "example": false }, "isCustom": { "type": "boolean", "description": "Flag to initialise if provider is customised or not", "example": false }, "internalIdentifier": { "type": "string", "description": "The internal identifier for a provider", "nullable": true, "example": "equifax-sample" } }, "additionalProperties": false, "description": "Provider Schema" }, "ProviderDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderDto" } ], "description": "Provider Schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderTestResultDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the Provider being tested.", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "tenantId": { "type": "string", "description": "Id of the Tenant", "nullable": true, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" }, "status": { "type": "string", "description": "The validation status.", "nullable": true, "example": "Completed" } }, "additionalProperties": false, "description": "Provider Test Result" }, "ProviderTestResultDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderTestResultDto" } ], "description": "Provider Test Result", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RegexRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Requirement": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32", "nullable": true }, "separator": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "SchemaDto": { "type": "object", "properties": { "initiateCreditScreeningRequest": { "allOf": [ { "$ref": "#/components/schemas/SchemaEntryDto" } ], "description": "Adapter Configuration request schema \r\nIt contains list of fields", "nullable": true }, "initiateCreditScreeningResult": { "allOf": [ { "$ref": "#/components/schemas/SchemaEntryDto" } ], "description": "Adapter Configuration result schema \r\nIt contains list of fields", "nullable": true } }, "additionalProperties": false, "description": "Adapter Configuration Schema Detail" }, "SchemaEntryDto": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "description": "The list of all Fields", "nullable": true } }, "additionalProperties": false }, "ScreeningHistoryItemDto": { "type": "object", "properties": { "screeningId": { "type": "string", "description": "The versionId for manual credit screening type, enquiryId for automated Credit screening type.", "format": "uuid", "nullable": true }, "version": { "type": "integer", "description": "The version number of the screening.", "format": "int32", "nullable": true }, "entityId": { "type": "string", "description": "EntityId for which the screening is for.", "format": "uuid" }, "type": { "type": "string", "description": "Whether the type of credit screening is Manual or Automated.", "nullable": true }, "status": { "type": "string", "description": "The status of the screening", "nullable": true }, "taskId": { "type": "string", "description": "The task Id the screening was completed in.", "format": "uuid" }, "taskName": { "type": "string", "description": "The task name the screening was completed in.", "nullable": true }, "providerId": { "type": "string", "description": "The id of the provider that completed the screening.", "format": "uuid" }, "providerName": { "type": "string", "description": "The name of the provider that completed the screening.", "nullable": true }, "approverId": { "type": "string", "description": "The Id of the individual that completed the screening.", "format": "uuid", "nullable": true }, "approverTeam": { "type": "string", "description": "The team of the individual/provider that completed the screening.", "nullable": true }, "screeningDate": { "type": "string", "description": "The date the screening was started (automated) / completed (manual) on.", "format": "date-time", "nullable": true }, "outcome": { "type": "string", "description": "The outcome result of the screening", "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SnapshotSet": { "type": "object", "properties": { "setId": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "snapshotGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRequirement" }, "nullable": true }, "screeningOutcome": { "allOf": [ { "$ref": "#/components/schemas/Requirement" } ], "nullable": true } }, "additionalProperties": false }, "SnapshotSetIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnapshotSet" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SnapshotSetServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SnapshotSet" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "ValidationRuleDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "setId": { "type": "string", "format": "uuid" }, "propertyId": { "type": "string", "format": "uuid" }, "dataGroupId": { "type": "string", "format": "uuid", "nullable": true }, "isDataGroup": { "type": "boolean" }, "propertyName": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "validationType": { "type": "string", "nullable": true }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "VersionedJurisdictionDto": { "type": "object", "properties": { "jurisdiction": { "type": "string", "nullable": true }, "versionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }