{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula EntityData Command", "description": "Entity Data Command API is part of FenX eco-system to manage Entity Data. All the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/entitydatacommand" } ], "paths": { "/api/entity": { "post": { "tags": [ "Entity" ], "summary": "Create entity", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit", "operationId": "CreateEntity", "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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Create entity request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEntityRequestV2DtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Entity created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/entity/full": { "post": { "tags": [ "Entity" ], "summary": "Create entity with full record in response", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit", "operationId": "CreateEntityFullRecord", "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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Create entity request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEntityRequestV2DtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Entity created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedFullRecordDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/entity/{id}/create-url-to-upload-file": { "post": { "tags": [ "Entity" ], "summary": "Create url to upload file.\nThis endpoint is intended for use with the new DataField type - RichTextEditor.", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit", "operationId": "CreateUrlToUploadFile", "parameters": [ { "name": "id", "in": "path", "description": "Entity 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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Parameters to create url to upload", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUrlToUploadFileRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUrlToUploadFileResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/entity/{entityId}/draft": { "post": { "tags": [ "EntityDraft" ], "summary": "Create entity draft", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit", "operationId": "CreateEntityDraft", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity 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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Create entity draft request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEntityDraftDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Entity draft created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDraftCreatedDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/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. Entity does not exist or has been deleted", "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/entity/{entityId}/draft/{id}": { "put": { "tags": [ "EntityDraft" ], "summary": "Update entity draft", "description": "\nUpdates an existing entity draft.

Required permissions:
At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit", "operationId": "UpdateEntityDraftRecord", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Entity draft 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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Update entity draft request. Must contain Policy jurisdiction(s) and entity draft properties", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateEntityDraftRequestDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Entity draft updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityDraftUpdatedDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity/entity draft 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" } ] } } } } }, "deprecated": true } }, "/api/entity/{entityId}/draft/{id}/verify": { "put": { "tags": [ "EntityDraft" ], "summary": "Verify entity draft", "description": "\nVerifies an entity draft record.

Required permissions:
Following permissions are required: EntityDataApprove", "operationId": "VerifyEntityDraft", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Entity draft 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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Conflict Resolutions request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConflictResolutionsDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. No conflicts were found for the Entity Draft Record" }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/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. Entity/entity draft 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/entity/{entityId}/draft/{id}/reject": { "put": { "tags": [ "EntityDraft" ], "summary": "Reject entity draft", "description": "\nUpdates the status property of an entity draft to rejected. Rejected drafts cannot be updated or merged.

Required permissions:
Following permissions are required: EntityDataApprove", "operationId": "RejectEntityDraft", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Entity draft 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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Reject Entity Draft request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RejectEntityDraftDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Entity draft rejected" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity/entity draft 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/entity/{entityId}/draft/{id}/risk": { "put": { "tags": [ "EntityDraft" ], "summary": "Update risk of entity draft", "description": "\nUpdates the risk properties of an entity draft.

Required permissions:
Following permissions are required: EntityDataEdit", "operationId": "UpdateEntityDraftRisk", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Entity draft 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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Update entity draft risk request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Entity draft risk updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity/entity draft 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/entity/{entityId}/draft/{id}/role": { "put": { "tags": [ "EntityDraft" ], "summary": "Update the role of entity draft", "description": "\nUpdates the role property of an entity draft.

Required permissions:
Following permissions are required: EntityDataEdit", "operationId": "UpdateEntityDraftRole", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Entity draft 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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Update entity draft role request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityRoleDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Entity draft role updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity/entity draft 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/entity/{entityId}/draft/{id}/access-layers": { "put": { "tags": [ "EntityDraft" ], "summary": "Update the access layers of the entity draft. The changes will be propagated to related entity.", "description": "

Required permissions:
Following permissions are required: EntityDataChangeEntityDraftAccessLayers", "operationId": "UpdateEntityDraftAccessLayers", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Entity draft 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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Update entity draft role request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDraftAccessLayersDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Entity draft role updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Entity/entity draft 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/match-and-merge-configuration/{entityType}": { "put": { "tags": [ "MatchAndMergeConfiguration" ], "summary": "Save Match and Merge configuration", "description": "

Required permissions:
Following permissions are required: EntityDataEdit", "operationId": "SaveMatchAndMergeConfiguration", "parameters": [ { "name": "entityType", "in": "path", "description": "The entity type (e.g. Individual, Company)", "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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "The configuration request containing the list of fields", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MatchAndMergeConfigurationRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Configuration saved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AccessLayerDetailsDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Access layer data key", "nullable": true, "example": "Global" }, "inheritedFrom": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of entity ids that access layer is inherited from", "nullable": true }, "isInherited": { "type": "boolean", "description": "Flag indicating if access layer is inherited by default" } }, "additionalProperties": false }, "AccessLayerDto": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "description": "Collection of geographic access layers", "nullable": true, "example": [ "Global" ] }, "businessRelated": { "type": "array", "items": { "type": "string" }, "description": "Collection of business related access layers", "nullable": true, "example": [ "Enterprise" ] }, "geographicDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AccessLayerDetailsDto" }, "description": "Collection of geographic access layers with details about inheritance", "nullable": true }, "businessRelatedDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AccessLayerDetailsDto" }, "description": "Collection of business related access layers with details about inheritance", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing associated access layers" }, "AccountRelatedFundDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "AccountRelatedFundsDataSource": { "required": [ "accountRelatedFunds" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "accountRelatedFunds": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelatedFundDto" } } }, "additionalProperties": false }, "AlertAssessmentDataSource": { "required": [ "assessments", "lastAssessment" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/AlertAssessmentDto" } }, "lastAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDto" } ] }, "lastAssessmentOutcome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertAssessmentDto": { "required": [ "category" ], "type": "object", "properties": { "category": { "type": "string" } }, "additionalProperties": false }, "AlertDataSource": { "required": [ "attribute", "source", "type" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "source": { "type": "string" }, "type": { "type": "string" }, "attribute": { "type": "string" } }, "additionalProperties": false }, "AssociatedVersionedJurisdictionDto": { "allOf": [ { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, { "type": "object", "properties": { "isOffboarded": { "type": "boolean", "description": "Flag to determine if previously associated jurisdiction is now offboarded", "example": false } }, "additionalProperties": false } ] }, "AutoCreditAssessmentDataSource": { "required": [ "autoCreditAssessments" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "autoCreditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditAssessmentDto" } } }, "additionalProperties": false }, "AutoCreditAssessmentDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "assessmentOutcome": { "type": "string", "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDataSource": { "required": [ "creditScreenings" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" } }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDto": { "required": [ "properties" ], "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldsDataSource": { "required": [ "changedFields" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "changedFields": { "type": "array", "items": { "$ref": "#/components/schemas/ChangedFieldDto" } } }, "additionalProperties": false }, "CollateralDataSource": { "required": [ "collaterals" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" } } }, "additionalProperties": false }, "CollateralDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "CollectionDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CollectionPropertyDto2": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConflictResolutionsDto": { "type": "object", "properties": { "dataConflictResolutions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "version": { "type": "integer", "description": "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking", "format": "int32", "default": -1 } }, "additionalProperties": false, "description": "Request DTO representing the conflict resolution data" }, "ConflictResolutionsDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConflictResolutionsDto" } ], "description": "Request DTO representing the conflict resolution data", "nullable": true } }, "additionalProperties": false }, "CreateEntityDraftDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "Journey id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "parentDraftId": { "type": "string", "description": "Optional parent draft id (jurisdictions are taken from parent if defined)", "format": "uuid", "nullable": true, "example": "4fd71919-b072-44be-a520-ab66009f1171" }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources", "nullable": true } }, "additionalProperties": false, "description": "Request DTO to create new entity draft\nContains required Journey id to define entity draft" }, "CreateEntityDraftDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateEntityDraftDto" } ], "description": "Request DTO to create new entity draft\nContains required Journey id to define entity draft", "nullable": true } }, "additionalProperties": false }, "CreateEntityRequestV2Dto": { "type": "object", "properties": { "type": { "type": "string", "description": "Entity type\nOne of Company, Individual, Other, Entity Group", "nullable": true, "example": "Individual" }, "targetEntity": { "type": "string", "description": "Target Entity type\nOne of Client, Related Party", "nullable": true, "example": "Related Party" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources used for evaluation", "nullable": true }, "policyJurisdiction": { "type": "string", "description": "Policy jurisdiction", "nullable": true, "example": "Global", "deprecated": true }, "policyJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "List of policy jurisdictions e.g. [\"Global\", \"Ireland\"]", "nullable": true }, "alternateId": { "type": "string", "description": "Id from external system to migrate data", "nullable": true, "example": "1124efd2-3423-40f5-9bdb-fae66c7fa88a" }, "category": { "type": "array", "items": { "type": "string" }, "description": "List of requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Entity access layers determining the access to the entity", "nullable": true } }, "additionalProperties": false, "description": "Request DTO to create new entity" }, "CreateEntityRequestV2DtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateEntityRequestV2Dto" } ], "description": "Request DTO to create new entity", "nullable": true } }, "additionalProperties": false }, "CreateUrlToUploadFileRequestDto": { "type": "object", "properties": { "fileName": { "type": "string", "description": "File name", "nullable": true, "example": "file.png" }, "dataKey": { "type": "string", "description": "Requirement dataKey", "nullable": true, "example": "richTextEditorV1" }, "isRootContent": { "type": "boolean", "description": "Identifier if it's requirement content" }, "entityDraftId": { "type": "string", "description": "Entity Draft Id", "format": "uuid", "example": "2124efd2-3423-40f5-9bdb-fae66c7fa88a" }, "contentSize": { "type": "integer", "description": "File content size", "format": "int64", "example": 6892 } }, "additionalProperties": false }, "CreateUrlToUploadFileRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateUrlToUploadFileRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "CreateUrlToUploadFileResponseDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "fileIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateUrlToUploadFileResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateUrlToUploadFileResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreditAssessmentDto": { "required": [ "properties", "taskId" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "assessmentOutcome": { "type": "string", "nullable": true }, "assessmentComment": { "type": "string", "nullable": true }, "taskId": { "type": "string" }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentDataGroupItemDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "CurrentFieldDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "currentField": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentJourneysDataSource": { "required": [ "inProgressJourneyTypes" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "inProgressJourneyTypes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CurrentProductDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentProductMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "isAgency": { "type": "string", "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentUserDataSource": { "required": [ "teamIds" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "teamIds": { "type": "array", "items": { "minLength": 1, "type": "string", "format": "uuid" } }, "isSystemUser": { "type": "boolean" } }, "additionalProperties": false }, "CustomPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "customTypeId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false } ] }, "CustomPropertyDto2": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "DataConflictDto": { "type": "object", "properties": { "existingValue": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" } ], "description": "Existing value.", "nullable": true }, "newValue": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" } ], "description": "New value.", "nullable": true } }, "additionalProperties": false, "description": "Class to represent data conflicts" }, "DataSourcesDto": { "type": "object", "properties": { "entityDataMetadata": { "allOf": [ { "$ref": "#/components/schemas/EntityDataMetadataDataSource" } ], "nullable": true }, "eventIngress": { "allOf": [ { "$ref": "#/components/schemas/EventIngressDataSource" } ], "nullable": true }, "changedFields": { "allOf": [ { "$ref": "#/components/schemas/ChangedFieldsDataSource" } ], "nullable": true }, "relatedClient": { "allOf": [ { "$ref": "#/components/schemas/RelatedClientDataSource" } ], "nullable": true }, "relatedProducts": { "allOf": [ { "$ref": "#/components/schemas/RelatedProductsDataSource" } ], "nullable": true }, "currentDataGroupItem": { "allOf": [ { "$ref": "#/components/schemas/CurrentDataGroupItemDataSource" } ], "nullable": true }, "externalDataAdapter": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataAdapterDataSource" } ], "nullable": true }, "entityAssociation": { "allOf": [ { "$ref": "#/components/schemas/EntityAssociationDataSource" } ], "nullable": true }, "manualCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditAssessmentV2DataSource" } ], "nullable": true }, "reviewAndApproval": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalDataSource" } ], "nullable": true }, "autoCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditAssessmentDataSource" } ], "nullable": true }, "manualCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningDataSource" } ], "nullable": true }, "collateral": { "allOf": [ { "$ref": "#/components/schemas/CollateralDataSource" } ], "nullable": true }, "currentJourneys": { "allOf": [ { "$ref": "#/components/schemas/CurrentJourneysDataSource" } ], "nullable": true }, "autoCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditScreeningDataSource" } ], "nullable": true }, "currentProduct": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductDataSource" } ], "nullable": true }, "relatedDeals": { "allOf": [ { "$ref": "#/components/schemas/RelatedDealsDataSource" } ], "nullable": true }, "mainEntity": { "allOf": [ { "$ref": "#/components/schemas/MainEntityDataSource" } ], "nullable": true }, "relatedAssets": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssetsDataSource" } ], "nullable": true }, "relatedAssociations": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssociationsDataSource" } ], "nullable": true }, "accountRelatedFunds": { "allOf": [ { "$ref": "#/components/schemas/AccountRelatedFundsDataSource" } ], "nullable": true }, "investmentAccountFund": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountFundDataSource" } ], "nullable": true }, "investmentAccountRelatedFundShareClass": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountRelatedFundShareClassDataSource" } ], "nullable": true }, "journeyLevelData": { "allOf": [ { "$ref": "#/components/schemas/JourneyLevelDataDataSource" } ], "nullable": true }, "relatedParties": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartiesDataSource" } ], "nullable": true }, "currentField": { "allOf": [ { "$ref": "#/components/schemas/CurrentFieldDataSource" } ], "nullable": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDataSource" } ], "nullable": true }, "alert": { "allOf": [ { "$ref": "#/components/schemas/AlertDataSource" } ], "nullable": true }, "relatedFCRs": { "allOf": [ { "$ref": "#/components/schemas/RelatedFCRsDataSource" } ], "nullable": true }, "relatedInvestmentManager": { "allOf": [ { "$ref": "#/components/schemas/RelatedInvestmentManagerDataSource" } ], "nullable": true }, "relatedUnderlyingPrincipalOwner": { "allOf": [ { "$ref": "#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource" } ], "nullable": true }, "alertAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDataSource" } ], "nullable": true }, "currentProductMetadata": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductMetadataDataSource" } ], "nullable": true }, "currentUser": { "allOf": [ { "$ref": "#/components/schemas/CurrentUserDataSource" } ], "nullable": true }, "relatedDocuments": { "allOf": [ { "$ref": "#/components/schemas/RelatedDocumentsDataSource" } ], "nullable": true }, "screeningMateriality": { "allOf": [ { "$ref": "#/components/schemas/ScreeningMaterialityDataSource" } ], "nullable": true } }, "additionalProperties": false }, "EntityAssociationDataSource": { "required": [ "associationToClient", "associationType" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "associationType": { "minLength": 1, "type": "string" }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "minLength": 1, "type": "string" }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "EntityCreatedDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the created entity", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" } }, "additionalProperties": false, "description": "Response DTO representing created entity" }, "EntityCreatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityCreatedDto" } ], "description": "Response DTO representing created entity", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": { "id": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "messages": [ { "message": "Some sent properties were out of scope and not updated: field", "type": "Warning" }, { "message": "Some properties are readonly and were left with existing value or set to default: status", "type": "Warning" } ] } }, "EntityCreatedFullRecordDto": { "allOf": [ { "$ref": "#/components/schemas/EntityCreatedDto" }, { "type": "object", "properties": { "role": { "allOf": [ { "$ref": "#/components/schemas/EntityRoleDto" } ], "description": "Entity role", "nullable": true }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "jurisdiction": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of jurisdictions entity is in scope for", "nullable": true }, "associatedJurisdictionsFromParents": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedVersionedJurisdictionDto" }, "nullable": true }, "description": "Associated jurisdictions from parent entities", "nullable": true }, "evaluatedJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of evaluated jurisdictions", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Entity", "format": "int32", "example": 1 }, "maskedProperties": { "allOf": [ { "$ref": "#/components/schemas/MaskedPropertiesDto" } ], "description": "Property name list of sensitive data requirements with masked value", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Entity access layers determining the access to the entity", "nullable": true }, "type": { "type": "string", "description": "Entity type\nOne of Company, Individual, Other, Entity Group", "nullable": true, "example": "Company" }, "alternateId": { "type": "string", "description": "Id from external system to migrate data", "nullable": true, "example": "1124efd2-3423-40f5-9bdb-fae66c7fa88a" } }, "additionalProperties": false } ], "description": "Response DTO representing created entity" }, "EntityCreatedFullRecordDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityCreatedFullRecordDto" } ], "description": "Response DTO representing created entity", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EntityDataMetadataDataSource": { "required": [ "entityType" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "entityType": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "EntityDraftCreatedDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity Draft id", "format": "uuid", "example": "bb88430f-48ec-46de-92dc-905876e0e8eb" }, "sourceEntityId": { "type": "string", "description": "Source entity id", "format": "uuid", "example": "bb88430f-48ec-46de-92dc-905876e0e8eb" }, "sourceEntityVersion": { "type": "integer", "description": "Source entity version", "format": "int32", "example": 1 }, "conflictsResolvedSourceEntityVersion": { "type": "integer", "description": "Conflict Resolved version", "format": "int32", "example": 1 }, "sourcePropertiesVersion": { "type": "integer", "description": "The version of the source entity properties when the draft was created", "format": "int32", "example": 5 }, "journeyId": { "type": "string", "description": "Journey id", "format": "uuid", "example": "7c4bc3ff-9d5b-4ccd-839b-637c227b1c65" }, "type": { "type": "string", "description": "Entity draft type", "nullable": true, "example": "Individual" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "risk": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskDto" } ], "description": "Entity draft risk", "nullable": true }, "role": { "allOf": [ { "$ref": "#/components/schemas/EntityRoleDto" } ], "description": "Entity draft role", "nullable": true }, "status": { "type": "string", "description": "Status", "nullable": true, "example": "InProgress" }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of Jurisdictions associated with EntityDraft", "nullable": true }, "associatedJurisdictionsFromParents": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedVersionedJurisdictionDto" }, "nullable": true }, "description": "Jurisdictions associated from parents", "nullable": true }, "evaluatedJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of evaluated jurisdictions", "nullable": true }, "riskVersion": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationVersionDto" } ], "description": "List of Risk Configurations associated with EntityDraft", "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Entity access layers determining the access to the entity Draft", "nullable": true }, "version": { "type": "integer", "description": "Version number for given EntityDraft", "format": "int32", "example": 1 }, "maskedProperties": { "allOf": [ { "$ref": "#/components/schemas/MaskedPropertiesDto" } ], "description": "Property name list of sensitive data requirements with masked value", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing created entity draft" }, "EntityDraftCreatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityDraftCreatedDto" } ], "description": "Response DTO representing created entity draft", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EntityDraftUpdatedDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Version of entity draft after update", "format": "int32", "example": 4 }, "hasValidationErrors": { "type": "boolean", "description": "Returned some validation errors for invalid properties", "example": false } }, "additionalProperties": false, "description": "Response DTO representing updated entity draft" }, "EntityDraftUpdatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityDraftUpdatedDto" } ], "description": "Response DTO representing updated entity draft", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EntityRiskDto": { "type": "object", "properties": { "riskLevel": { "type": "number", "description": "Risk level", "format": "double", "nullable": true, "example": 1 }, "riskCategory": { "type": "string", "description": "Risk category", "nullable": true, "example": "Low" }, "version": { "type": "integer", "description": "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking", "format": "int32", "default": -1 } }, "additionalProperties": false, "description": "Request DTO representing the entity risk data" }, "EntityRiskDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskDto" } ], "description": "Request DTO representing the entity risk data", "nullable": true } }, "additionalProperties": false }, "EntityRoleDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Role of the entity", "nullable": true, "example": "Client" }, "version": { "type": "integer", "description": "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking", "format": "int32", "default": -1 } }, "additionalProperties": false, "description": "Request DTO representing the entity role data" }, "EntityRoleDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityRoleDto" } ], "description": "Request DTO representing the entity role data", "nullable": true } }, "additionalProperties": false }, "EventIngressDataSource": { "required": [ "eventSubtype", "eventType" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "minLength": 1, "type": "string" }, "eventSubtype": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ExternalDataAdapterDataSource": { "required": [ "eventSubtype", "eventType" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "minLength": 1, "type": "string" }, "eventSubtype": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } ] }, "InvestmentAccountFundDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "InvestmentAccountRelatedFundShareClassDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "JourneyLevelDataDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "MainEntityDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "ManualCreditAssessmentV2DataSource": { "required": [ "creditAssessments" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentDto" } } }, "additionalProperties": false }, "ManualCreditScreeningDataSource": { "required": [ "creditScreenings" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" } }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDto": { "required": [ "properties" ], "type": "object", "properties": { "taskDataKey": { "type": "string", "nullable": true }, "taskId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "MaskedPropertiesDto": { "type": "object", "properties": { "singleProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Masked single data requirement properties", "nullable": true, "example": [ "property1" ] } }, "additionalProperties": false, "description": "Property name list of sensitive data requirements with masked value" }, "MatchAndMergeConfigurationRequestDto": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/MatchAndMergeFieldDto" }, "nullable": true } }, "additionalProperties": false }, "MatchAndMergeConfigurationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MatchAndMergeConfigurationRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "MatchAndMergeFieldDto": { "type": "object", "properties": { "policyFieldDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MergeConflictsDto": { "type": "object", "properties": { "entityVersion": { "type": "integer", "description": "Current Entity version returned to frontend after resolving merge conflicts.", "format": "int32", "example": 1 }, "dataConflicts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataConflictDto" }, "description": "Data conflicts.", "nullable": true } }, "additionalProperties": false, "description": "Class to represent merge conflicts", "example": { "entityVersion": 3, "dataConflicts": { "firstName": { "existingValue": { "type": "Single", "isValid": false, "value": "John" }, "newValue": { "type": "Single", "isValid": true, "value": "Adam" } } } } }, "MergeConflictsDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MergeConflictsDto" } ], "description": "Class to represent merge conflicts", "nullable": true, "example": { "entityVersion": 3, "dataConflicts": { "firstName": { "existingValue": { "type": "Single", "isValid": false, "value": "John" }, "newValue": { "type": "Single", "isValid": true, "value": "Adam" } } } } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "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": { } }, "PropertiesDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "PropertyDto": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "isValid": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "RejectEntityDraftDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking", "format": "int32", "default": -1 } }, "additionalProperties": false, "description": "Request DTO representing the entity risk data" }, "RejectEntityDraftDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RejectEntityDraftDto" } ], "description": "Request DTO representing the entity risk data", "nullable": true } }, "additionalProperties": false }, "RelatedAssetDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "RelatedAssetsDataSource": { "required": [ "assets" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssetDto" } } }, "additionalProperties": false }, "RelatedAssociationDto": { "required": [ "properties" ], "type": "object", "properties": { "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "RelatedAssociationsDataSource": { "required": [ "relatedAssociations" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssociationDto" } } }, "additionalProperties": false }, "RelatedClientDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "RelatedDealDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "RelatedDealsDataSource": { "required": [ "relatedDeals" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedDeals": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDealDto" } } }, "additionalProperties": false }, "RelatedDocumentDto": { "required": [ "document" ], "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/RelatedDocumentVersionedDto" } ] } }, "additionalProperties": false }, "RelatedDocumentVersionedDto": { "type": "object", "properties": { "documentKey": { "type": "string", "nullable": true }, "documentType": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } } }, "additionalProperties": false }, "RelatedDocumentsDataSource": { "required": [ "documents" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDocumentDto" } } }, "additionalProperties": false }, "RelatedFCRDto": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "submittedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RelatedFCRsDataSource": { "required": [ "fcRs" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "fcRs": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedFCRDto" } } }, "additionalProperties": false }, "RelatedInvestmentManagerDataSource": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] }, "dataSource": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RelatedPartiesDataSource": { "required": [ "relatedParties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedParties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyDto" } } }, "additionalProperties": false }, "RelatedPartyDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RelatedProductDto": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "lifecycleStatus": { "type": "string", "nullable": true }, "relationshipTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RelatedProductsDataSource": { "required": [ "products" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedProductDto" } } }, "additionalProperties": false }, "RelatedUnderlyingPrincipalOwnerDataSource": { "required": [ "properties" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ] } }, "additionalProperties": false }, "ReviewAndApprovalDataSource": { "required": [ "reviewAndApprovals" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "reviewAndApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewAndApprovalDto" } } }, "additionalProperties": false }, "ReviewAndApprovalDto": { "required": [ "approvalOutcome" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "approvalOutcome": { "type": "string" }, "approvalReason": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RiskConfigurationVersionDto": { "type": "object", "properties": { "riskModel": { "type": "array", "items": { "$ref": "#/components/schemas/RiskVersionDto" }, "description": "The list of Risk Models and their versions used in the Entity Draft", "nullable": true }, "riskConfigurationModel": { "type": "array", "items": { "$ref": "#/components/schemas/RiskVersionDto" }, "description": "The list of Risk Configuration Models and their versions used in the Entity Draft", "nullable": true }, "thresholdModel": { "type": "array", "items": { "$ref": "#/components/schemas/RiskVersionDto" }, "description": "The list of Threshold Models and their versions used in the Entity Draft", "nullable": true } }, "additionalProperties": false, "description": "Dto to store the risk configuration models and versions used in the Entity Draft" }, "RiskVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the risk model", "format": "uuid" }, "version": { "type": "integer", "description": "The version of the model", "format": "int32" } }, "additionalProperties": false, "description": "Stores the Id and the Version of a Risk Configuration Model" }, "ScreeningMaterialityAssessmentDto": { "required": [ "adverseMediaJurisdictions", "enforcementsJurisdictions", "otherJurisdictions", "pepJurisdictions", "sanctionsJurisdictions" ], "type": "object", "properties": { "mainEntity": { "type": "boolean" }, "materialityOutcome": { "type": "string", "nullable": true }, "pepMaterialityStatus": { "type": "string", "nullable": true }, "sanctionsMaterialityStatus": { "type": "string", "nullable": true }, "adverseMediaMaterialityStatus": { "type": "string", "nullable": true }, "enforcementsMaterialityStatus": { "type": "string", "nullable": true }, "otherMaterialityStatus": { "type": "string", "nullable": true }, "pepJurisdictions": { "type": "array", "items": { "type": "string" } }, "sanctionsJurisdictions": { "type": "array", "items": { "type": "string" } }, "adverseMediaJurisdictions": { "type": "array", "items": { "type": "string" } }, "enforcementsJurisdictions": { "type": "array", "items": { "type": "string" } }, "otherJurisdictions": { "type": "array", "items": { "type": "string" } }, "sanctionsProceedDecision": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScreeningMaterialityDataSource": { "required": [ "assessments" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningMaterialityAssessmentDto" } } }, "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 }, "SignificanceEngineDataSource": { "required": [ "significanceEngine" ], "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDto" } ] } }, "additionalProperties": false }, "SignificanceEngineDto": { "type": "object", "properties": { "singleFields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "collections": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto2": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "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 }, "UpdateDraftAccessLayersDto": { "type": "object", "properties": { "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Entity access layers determining the access to the entity draft and related entity", "nullable": true }, "version": { "type": "integer", "description": "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking", "format": "int32", "default": -1 } }, "additionalProperties": false, "description": "Request DTO representing the entity draft access layers data" }, "UpdateDraftAccessLayersDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDraftAccessLayersDto" } ], "description": "Request DTO representing the entity draft access layers data", "nullable": true } }, "additionalProperties": false }, "UpdateEntityDraftRequestDto": { "type": "object", "properties": { "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Collection of policy jurisdictions", "nullable": true }, "entityType": { "type": "string", "description": "The type of the entity", "nullable": true, "example": "Individual" }, "category": { "type": "array", "items": { "type": "string" }, "description": "List of requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Spain", "city": "Madrid", "street": "C. de Sevilla" } }, "93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2": { "properties": { "country": "Spain", "city": "Barcelona", "street": "Carrer de Girona" } } } } } }, "version": { "type": "integer", "description": "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking", "format": "int32", "default": -1 } }, "additionalProperties": false, "description": "Request DTO to update entity draft" }, "UpdateEntityDraftRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateEntityDraftRequestDto" } ], "description": "Request DTO to update entity draft", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "VersionedJurisdictionDto": { "required": [ "jurisdiction" ], "type": "object", "properties": { "jurisdiction": { "minLength": 1, "type": "string", "description": "Jurisdiction Name", "example": "Global" }, "versionId": { "type": "string", "description": "Jurisdiction Version Id", "format": "uuid", "example": "7c4bc3ff-9d5b-4ccd-839b-637c227b1c65" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }