{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula CreditScreening Command", "description": "**CreditScreening Command API**:\n\n
Credit Screening Command API provides both configurational and operational methods related to the client's credit screenings. Use the Credit Screening Command API to create, update and delete credit screenings and related aggregates. Use the Query API to retrieve credit screenings and other related aggregates.\n\n
**CreditScreening Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/creditscreeningcommand" } ], "paths": { "/api/creditscreening": { "post": { "tags": [ "CreditScreening" ], "summary": "Create a new Credit Screening Enquiry", "description": "

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningAccess", "operationId": "CreditScreening", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The Create Screening request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditScreeningRequestDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditScreeningRequestDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreditScreeningRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Request created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditScreeningRequestDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/creditscreening/{id}": { "delete": { "tags": [ "CreditScreening" ], "summary": "Delete a Credit Screening Enquiry", "description": "

Required permissions:
Following permissions are required: CreditScreeningDelete", "operationId": "DeleteCreditScreening", "parameters": [ { "name": "id", "in": "path", "description": "The request id that needs to be updated", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. Batch created" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/providers": { "post": { "tags": [ "CreditScreeningProvider" ], "summary": "Create a new Credit Screening Provider", "description": "\nThis method creates new Credit ScreeningProvider.\r\n\nThe new provider initializes with the DTO data and is set to disable as default.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit", "operationId": "CreateCreditScreeningProvider", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/providers/{providerId}": { "put": { "tags": [ "CreditScreeningProvider" ], "summary": "Update an existing Credit Screening Provider", "description": "\nThis method updates a Credit ScreeningProvider.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit", "operationId": "UpdateCreditScreeningProvider", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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" } ] } } } } } }, "delete": { "tags": [ "CreditScreeningProvider" ], "summary": "Delete a Credit Screening Provider and all related configurations.", "description": "\nThis method deletes a Credit Screening Provider.\r\n\nIt also deletes the configuration, mapping configuration and adapter schema\r\n\nthat are related to this provider.

Required permissions:
At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete", "operationId": "DeleteCreditScreeningProvider", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "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}/enabled": { "put": { "tags": [ "CreditScreeningProvider" ], "summary": "Update if a provider is Enabled", "description": "\nThis method updates a credit screening provider if they are inactive/active.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit", "operationId": "UpdateCreditScreeningProviderEnabled", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnabledDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnabledDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnabledDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EnabledDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EnabledDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnabledDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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}/configuration": { "post": { "tags": [ "CreditScreeningProvider" ], "summary": "Create a new Credit Screening Provider Configuration", "description": "\nThis method saves new Credit ScreeningProvider Configuration.\r\n\nThe configuration initializes with the DTO data consists a list configuration properties.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit", "operationId": "CreateCreditScreeningProviderConfiguration", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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" } ] } } } } } }, "put": { "tags": [ "CreditScreeningProvider" ], "summary": "Update an existing Credit Screening Provider Configuration", "description": "\nThis method update an existing Credit Screening Provider Configuration.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit", "operationId": "UpdateCreditScreeningProviderConfiguration", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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" } ] } } } } } }, "delete": { "tags": [ "CreditScreeningProvider" ], "summary": "Delete a Credit Screening Provider Configuration", "description": "\nThis method delete existing Credit Screening Provider Configuration.

Required permissions:
At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete", "operationId": "DeleteCreditScreeningProviderConfiguration", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "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}/mappingconfiguration": { "post": { "tags": [ "CreditScreeningProvider" ], "summary": "Create a new Credit Screening Mapping Configuration", "description": "\nThis method saves new Mapping Configuration.\r\n\nThe new configuration initializes with the DTO data and has the resquest and result\r\n mapping rules stored inside.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit", "operationId": "CreateCreditScreeningMappingConfiguration", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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}/mappingconfiguration/{mappingId}": { "put": { "tags": [ "CreditScreeningProvider" ], "summary": "Update an existing Credit Screening Mapping Configuration", "description": "\nThis method updates an existing Mapping Configuration.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit", "operationId": "UpdateCreditScreeningMappingConfiguration", "parameters": [ { "name": "mappingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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" } ] } } } } } }, "delete": { "tags": [ "CreditScreeningProvider" ], "summary": "Delete an existing Credit Screening Mapping Configuration", "description": "\nThis method deletes an existing Mapping Configuration.

Required permissions:
At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete", "operationId": "DeleteCreditScreeningMappingConfiguration", "parameters": [ { "name": "mappingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "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}/adapterSchema": { "post": { "tags": [ "CreditScreeningProvider" ], "summary": "Create a new Adapter Schema", "description": "\nThis method saves new Credit Screening Adapter Schema.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesCreate, CreditScreeningDataSourcesEdit", "operationId": "CreateCreditScreeningAdapterShcema", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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}/adapterSchema/{id}": { "put": { "tags": [ "CreditScreeningProvider" ], "summary": "Update an existing Adapter Schema", "description": "\nThis method update an existing Credit Screening Adapter Schema.

Required permissions:
At least one of the following permissions is required: CreditScreeningEdit, CreditScreeningDataSourcesEdit", "operationId": "UpdateCreditScreeningAdapterShcema", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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" } ] } } } } } }, "delete": { "tags": [ "CreditScreeningProvider" ], "summary": "Delete an existing Adapter Schema", "description": "\nThis method delete an existing Credit Screening Adapter Schema.

Required permissions:
At least one of the following permissions is required: CreditScreeningDelete, CreditScreeningDataSourcesDelete", "operationId": "DeleteCreditScreeningAdapterShcema", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "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": { "post": { "tags": [ "CreditScreeningProvider" ], "summary": "Test mock adapter endpoint", "description": "\nThis method triggers a mock adapter endpoint.", "operationId": "ProviderTest", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "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": { "post": { "tags": [ "ManualCreditScreening" ], "summary": "Create a new Manual Credit Screening Set", "description": "\nCreates a new Manual Credit Screening Set for a specific entitiy, journey, task id.\r\n\nIt also creates a new Manual Credit Screening Version with a status of \"Draft\".

Required permissions:
Following permissions are required: ManualCreditScreeningCreate", "operationId": "CreateManualCreditScreeningSet", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Manual Credit Screening Set", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateNewManualCreditScreeningSetDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/set/{setId}/version": { "post": { "tags": [ "ManualCreditScreening" ], "summary": "Create a new Manual Credit Screening Version for an existing Manual Credit Screening Set", "description": "\nThis method creates a new Manual Credit Screening Version\r\n\nThe new version initializes with the DTO data. It is assigned the next available version number,\r\n with the default status of \"Draft\". \r\n\nNote that the latest existing version must not have a status of \"Draft\" to be able\r\n to create a new version.

Required permissions:
Following permissions are required: ManualCreditScreeningEdit", "operationId": "CreateManualCreditScreeningVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Manual Credit Screening Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Manual Credit Screening Version group data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionGroupDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionGroupDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionGroupDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Manual Credit Screening Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/set/{setId}/version/{versionNumber}": { "put": { "tags": [ "ManualCreditScreening" ], "summary": "Update a Manual Credit Screening Version", "description": "\nThis method updates an existing Manual Credit Screening Version.\r\n\nOnly Manual Credit Screening Version with \"Draft\" status can be updated.

Required permissions:
Following permissions are required: ManualCreditScreeningEdit", "operationId": "UpdateManualCreditScreeningVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Manual Credit Screening Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Manual Credit Screening Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Manual Credit Screening Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Manual Credit Screening Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/set/{setId}/version/{versionNumber}/complete": { "put": { "tags": [ "ManualCreditScreening" ], "summary": "Update a Manual Credit Screening Version Status to \"Completed\".", "description": "\nThis method updates an existing Manual Credit Screening Version status to \"Completed\".\r\n\nOnly Manual Credit Screening Version with the status of \"Draft\" can be updated.\r\n\nThis route has the same functionality as the updating version status to reject (the route below).

Required permissions:
Following permissions are required: ManualCreditScreeningEdit", "operationId": "UpdateManualCreditVersionScreeningStatusToCompleted", "parameters": [ { "name": "setId", "in": "path", "description": "Manual Credit Screening Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Manual Credit Screening Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Manual Credit Screening Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/set/{setId}/version/{versionNumber}/reject": { "put": { "tags": [ "ManualCreditScreening" ], "summary": "Update a Manual Credit Screening Version Status to \"Rejected\".", "description": "\nThis method updates an existing Manual Credit Screening Version status to \"Rejected\".\r\n\nOnly Manual Credit Screening Versions with the status of \"Draft\" can be updated.\r\n\nThis route has the same functionality as the updating version status to completed (the route above).

Required permissions:
Following permissions are required: ManualCreditScreeningEdit", "operationId": "UpdateManualCreditVersionScreeningStatusToRejected", "parameters": [ { "name": "setId", "in": "path", "description": "Manual Credit Screening Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Manual Credit Screening Version Number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Manual Credit Screening Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/set/{setId}/snapshot": { "post": { "tags": [ "ManualCreditScreening" ], "summary": "Take a snapshot Manual Credit Screening Version", "description": "\nThis method take a snapshot for a Manual Credit Screening Version.

Required permissions:
Following permissions are required: ManualCreditScreeningEdit", "operationId": "SnapshotManualCreditScreeningVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Manual Credit Screening Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Manual Credit Screening Snapshot data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Manual Credit Screening Set with given ID does not exists", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/batch/update": { "put": { "tags": [ "ManualCreditScreeningBatch" ], "summary": "Update a batch of manual credit screening version", "description": "\nThis method updates a batch of existing Manual Credit Screening Version.\r\n\nOnly Manual Credit Screening Version with \"Draft\" status can be updated.

Required permissions:
Following permissions are required: ManualCreditScreeningEdit", "operationId": "UpdateBatch", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Batch of Manual Credit Screening Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoIEnumerableServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoIEnumerableServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDtoIEnumerableServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Manual Credit Screening Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/batch/complete": { "put": { "tags": [ "ManualCreditScreeningBatch" ], "summary": "Complete a batch of manual credit screening version", "description": "\nThis method completes a batch of existing Manual Credit Screening Version.\r\n\nOnly Manual Credit Screening Version with \"Draft\" status can be updated.

Required permissions:
Following permissions are required: ManualCreditScreeningEdit", "operationId": "CompleteBatch", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Batch of Manual Credit Screening Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCompleteDtoServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchCompleteDtoServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatchCompleteDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchResultDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Manual Credit Screening Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/manual/batch/snapshot": { "post": { "tags": [ "ManualCreditScreeningBatch" ], "summary": "Take a batch of snapshot for manual credit screening version", "description": "\nThis method takes a batch of snapshot for existing Manual Credit Screening Version.

Required permissions:
Following permissions are required: ManualCreditScreeningEdit", "operationId": "BatchSnapshot", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Batch of Manual Credit Screening Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetIEnumerableServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SnapshotSetIEnumerableServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SnapshotSetIEnumerableServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchSnapshotResultDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchSnapshotResultDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchSnapshotResultDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Manual Credit Screening Set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "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": { "$ref": "#/components/schemas/SchemaDto" } }, "additionalProperties": false, "description": "Adapter Configuration Schema" }, "AdapterSchemaDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdapterSchemaDto" } }, "additionalProperties": false }, "AdapterSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdapterSchemaDto" }, "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 }, "BatchCompleteDto": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/CompleteDto" }, "description": "List of the manual credit screening that needs to be completed", "nullable": true }, "approver": { "$ref": "#/components/schemas/CreditApprover" } }, "additionalProperties": false }, "BatchCompleteDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchCompleteDto" } }, "additionalProperties": false }, "BatchErrorDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "Id of the manual credit screening that fails", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "versionNumber": { "type": "integer", "description": "Version Number of the manual credit screening that fails", "format": "int32", "example": 1 }, "error": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of service response message", "nullable": true } }, "additionalProperties": false }, "BatchResultDto": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDto" }, "description": "List of versions that updated sucessfully", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BatchErrorDto" }, "description": "List of errors message schema", "nullable": true } }, "additionalProperties": false }, "BatchResultDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchResultDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "BatchSnapshotResultDto": { "type": "object", "properties": { "snapshotSets": { "type": "array", "items": { "$ref": "#/components/schemas/SnapshotSet" }, "description": "List of Snapshot Set that updated successfully", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BatchErrorDto" }, "description": "List of errors message schema", "nullable": true } }, "additionalProperties": false }, "BatchSnapshotResultDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchSnapshotResultDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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 }, "CompleteDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "Id of the manual credit screening", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "versionNumber": { "type": "integer", "description": "Version Number of the manual credit screening", "format": "int32", "example": 1 } }, "additionalProperties": false }, "CreateNewManualCreditScreeningSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the manual credit screening", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "entityId": { "type": "string", "description": "Entity id of credit screening", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Journey Id which credit screening belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id which credit screening belongs", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "taskDataKey": { "type": "string", "description": "Task DataKey", "nullable": true, "example": "ket one" }, "name": { "type": "string", "description": "Name of this manual credit screening.", "nullable": true }, "status": { "type": "string", "description": "Manual Credit Screening Set Status", "nullable": true, "example": "Draft" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "nullable": true } }, "additionalProperties": false }, "CreateNewManualCreditScreeningSetDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateNewManualCreditScreeningSetDto" } }, "additionalProperties": false }, "CreateNewManualCreditScreeningSetDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateNewManualCreditScreeningSetDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditApprover": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "role": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreditScreeningRequestDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity id of credit screening", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "id": { "type": "string", "description": "Id of credit screening", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Journey Id which credit screening belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id which credit screening belongs", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "taskName": { "type": "string", "description": "Task Name which credit screening belongs", "nullable": true }, "searchCriteria": { "description": "Schema that contains attributes to be used for credit screening", "nullable": true }, "enquiryResult": { "$ref": "#/components/schemas/EnquiryResult" } }, "additionalProperties": false, "description": "The Credit Screening Schema" }, "CreditScreeningRequestDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditScreeningRequestDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditScreeningRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditScreeningRequestDto" } }, "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 }, "EnabledDto": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag to check if provider is Enabled or not", "nullable": true, "example": false } }, "additionalProperties": false }, "EnabledDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EnabledDto" } }, "additionalProperties": false }, "EnabledDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EnabledDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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": "Address" }, "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", "nullable": true }, "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": { "$ref": "#/components/schemas/ValidationRuleDto" } }, "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": { "$ref": "#/components/schemas/ValidationRuleDto" } }, "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 }, "ManualCreditScreeningVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the Manual Credit Screening Version", "format": "uuid", "example": "a4309731-77df-4e72-98e7-0d314b7a5151" }, "versionNumber": { "type": "integer", "description": "Version Number of the Manual Credit Screening Version", "format": "int32", "example": 1 }, "setId": { "type": "string", "description": "Manual Credit Screening Set GUiD", "format": "uuid", "example": "a4309731-77df-4e72-98e7-0d314b7a5151" }, "status": { "type": "string", "description": "Manual Credit Screening Status", "nullable": true, "example": "Draft" }, "screeningOutcome": { "type": "string", "description": "The outcome of a screening version.", "nullable": true, "example": "Adverse Finding" }, "manualCreditScreeningGroups": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ManualCreditScreeningGroupDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningVersionDtoIEnumerableServiceRequest": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDto" } }, "additionalProperties": false }, "ManualCreditScreeningVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManualCreditScreeningVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningVersionGroupDto": { "type": "object", "properties": { "manualCreditScreeningGroups": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ManualCreditScreeningGroupDto" }, "nullable": true }, "screeningOutcome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningVersionGroupDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManualCreditScreeningVersionGroupDto" } }, "additionalProperties": false }, "MappingConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of mapping configuration", "format": "uuid" }, "providerId": { "type": "string", "description": "The corresponding provider id of mapping configuration", "format": "uuid" }, "initiateCreditScreeningRequestDto": { "$ref": "#/components/schemas/MappingDto" }, "initiateCreditScreeningResultDto": { "$ref": "#/components/schemas/MappingDto" } }, "additionalProperties": false, "description": "Mapping Configuration Schema" }, "MappingConfigurationDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MappingConfigurationDto" } }, "additionalProperties": false }, "MappingConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MappingConfigurationDto" }, "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", "nullable": true }, "includingNestedPath": { "type": "boolean", "description": "If true, it will find all properties (including nested properties) with this Property Name", "nullable": true } }, "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": { "$ref": "#/components/schemas/MappingDto" }, "targetPropertyType": { "type": "string", "description": "The type of the targetProperty", "nullable": true, "example": "String" }, "hiddenIfNoValue": { "type": "boolean", "description": "hide this field in auto credit screening task if no value" } }, "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", "nullable": true, "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", "nullable": true, "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": { "$ref": "#/components/schemas/AdapterConfigurationDto" }, "providerConfigurationSecurityKeys": { "$ref": "#/components/schemas/ProviderConfigurationSecurityKeysDto" } }, "additionalProperties": false, "description": "Provider Configuration top layer schema" }, "ProviderConfigurationDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProviderConfigurationDto" } }, "additionalProperties": false }, "ProviderConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProviderConfigurationDto" }, "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 }, "ProviderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Credit Screening Provider UiD", "format": "uuid", "nullable": true, "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 Enabled or not", "nullable": true, "example": false }, "internalIdentifier": { "type": "string", "description": "Internal Identifier", "nullable": true, "example": "equifax-screening" } }, "additionalProperties": false, "description": "Provider Schema" }, "ProviderDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProviderDto" } }, "additionalProperties": false }, "ProviderDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProviderDto" }, "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": { "$ref": "#/components/schemas/ValidationRuleDto" } }, "additionalProperties": false }, "SchemaDto": { "type": "object", "properties": { "initiateCreditScreeningRequest": { "$ref": "#/components/schemas/SchemaEntryDto" }, "initiateCreditScreeningResult": { "$ref": "#/components/schemas/SchemaEntryDto" } }, "additionalProperties": false, "description": "Adapter Configuration Schema Detail" }, "SchemaEntryDto": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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": { "$ref": "#/components/schemas/Requirement" } }, "additionalProperties": false }, "SnapshotSetIEnumerableServiceRequest": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SnapshotSet" }, "nullable": true } }, "additionalProperties": false }, "SnapshotSetServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnapshotSet" } }, "additionalProperties": false }, "SnapshotSetServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SnapshotSet" }, "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": { "$ref": "#/components/schemas/BasicRuleDto" }, "specialCharacters": { "$ref": "#/components/schemas/SpecialCharactersRuleDto" }, "noNumbers": { "$ref": "#/components/schemas/BasicRuleDto" }, "onlyInteger": { "$ref": "#/components/schemas/BasicRuleDto" }, "noNegative": { "$ref": "#/components/schemas/BasicRuleDto" }, "onlyDecimal": { "$ref": "#/components/schemas/BasicRuleDto" }, "regex": { "$ref": "#/components/schemas/RegexRuleDto" }, "characterLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "numberLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "noFutureDates": { "$ref": "#/components/schemas/BasicRuleDto" }, "noPastDates": { "$ref": "#/components/schemas/BasicRuleDto" }, "dateLimit": { "$ref": "#/components/schemas/DateLimitRuleDto" }, "multiSelectLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" }, "collectionMinimumCount": { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" }, "collectionMaximumCount": { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" }, "externalProvider": { "$ref": "#/components/schemas/ExternalProviderRuleDto" } }, "additionalProperties": false }, "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": { "$ref": "#/components/schemas/ValidationDataDto" } }, "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": [ ] } ] }