{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula External Data Outreach Command",
"description": "External Data Outreach Command API provides methods related to the Portal Outreach. It should be used to update Outreach Entity Data.",
"version": "3.0"
},
"servers": [
{
"url": "/externaloutreachcommand"
}
],
"paths": {
"/api/v3/data/updateoutreachdata/{journeyId}": {
"put": {
"tags": [
"Data"
],
"summary": "Update outreach entity data",
"description": "\nUpdates an existing outreach entity data
Required permissions:
At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit",
"operationId": "UpdateOutreachDataV3",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "Journey id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Update outreach entity data request. Must contain Policy jurisdiction(s) and entity draft properties.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EntityDraftRequestDtoV3ServiceRequest"
}
]
}
}
}
},
"responses": {
"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. Outreach entity data with given journey id does not exist.",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"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"
}
]
}
}
}
},
"202": {
"description": "Success. Outreach entity data updated. Validation errors will be returned for invalid properties.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutreachDataCommandResponseDtoServiceResponse"
}
}
}
},
"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": {
"AccountRelatedFundDto": {
"type": "object",
"properties": {
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"AccountRelatedFundsDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"accountRelatedFunds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountRelatedFundDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"AlertAssessmentDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assessments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AlertAssessmentDto"
},
"nullable": true
},
"lastAssessment": {
"allOf": [
{
"$ref": "#/components/schemas/AlertAssessmentDto"
}
],
"nullable": true
},
"lastAssessmentOutcome": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AlertAssessmentDto": {
"type": "object",
"properties": {
"category": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AlertDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"source": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"attribute": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AutoCreditAssessmentDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"autoCreditAssessments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoCreditAssessmentDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"AutoCreditAssessmentDto": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
},
"assessmentOutcome": {
"type": "string",
"nullable": true
},
"providerInternalIdentifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AutoCreditScreeningDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"creditScreenings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoCreditScreeningDto"
},
"nullable": true
},
"relatedPartyCreditScreenings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoCreditScreeningDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"AutoCreditScreeningDto": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"format": "uuid"
},
"creditScreeningOutcome": {
"type": "string",
"nullable": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
},
"providerInternalIdentifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ChangedFieldDto": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ChangedFieldsDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"changedFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangedFieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"CollateralDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"collaterals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollateralDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"CollateralDto": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
}
},
"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
},
"CreditAssessmentDto": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
},
"assessmentOutcome": {
"type": "string",
"nullable": true
},
"assessmentComment": {
"type": "string",
"nullable": true
},
"taskId": {
"type": "string",
"nullable": true
},
"taskDataKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CurrentDataGroupItemDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"CurrentFieldDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"currentField": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CurrentJourneysDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"inProgressJourneyTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"CurrentProductDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
},
"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": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"teamIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"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"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
}
},
"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
},
"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
},
"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": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"associationType": {
"type": "string",
"nullable": true
},
"ownershipPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"associationToClient": {
"type": "string",
"nullable": true
},
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"EntityDataMetadataDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"entityType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EntityDraftDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Source 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
},
"jurisdictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionedJurisdictionDto"
},
"description": "Collection of policy jurisdictions",
"nullable": true
},
"type": {
"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": "Entity draft properties",
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
},
"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"
},
"EntityDraftRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/EntityDraftDto"
},
{
"type": "object",
"properties": {
"dataSources": {
"allOf": [
{
"$ref": "#/components/schemas/DataSourcesDto"
}
],
"description": "Additional data sources used for evaluation",
"nullable": true
}
},
"additionalProperties": false
}
],
"description": "Request DTO to entity draft"
},
"EntityDraftRequestDtoV3": {
"allOf": [
{
"$ref": "#/components/schemas/EntityDraftRequestDto"
},
{
"type": "object",
"properties": {
"triggerValidation": {
"type": "boolean",
"description": "If true, it will trigger validation of the entity draft"
}
},
"additionalProperties": false
}
],
"description": "Request DTO to entity draft"
},
"EntityDraftRequestDtoV3ServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EntityDraftRequestDtoV3"
}
],
"description": "Request DTO to entity draft",
"nullable": true
}
},
"additionalProperties": false
},
"EventIngressDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"eventType": {
"type": "string",
"nullable": true
},
"eventSubtype": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ExternalDataAdapterDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"eventType": {
"type": "string",
"nullable": true
},
"eventSubtype": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"InvestmentAccountFundDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"JourneyLevelDataDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"MainEntityDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ManualCreditAssessmentV2DataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"creditAssessments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditAssessmentDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ManualCreditScreeningDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"creditScreenings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualCreditScreeningDto"
},
"nullable": true
},
"relatedPartyCreditScreenings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualCreditScreeningDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ManualCreditScreeningDto": {
"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"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
}
},
"additionalProperties": false
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"OutreachDataCommandResponseDto": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Version of outreach data after update",
"format": "int32",
"example": 4
},
"id": {
"type": "string",
"description": "Id of updated/created data",
"format": "uuid"
},
"hasValidationErrors": {
"type": "boolean",
"description": "Flag indicating occurrence of validation errors for invalid properties",
"example": false
}
},
"additionalProperties": false,
"description": "Response DTO representing updated outreach data"
},
"OutreachDataCommandResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/OutreachDataCommandResponseDto"
}
],
"description": "Response DTO representing updated outreach data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"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"
},
"RelatedAssetDto": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
}
},
"additionalProperties": false
},
"RelatedAssetsDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedAssetDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedAssociationDto": {
"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"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"RelatedAssociationsDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"relatedAssociations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedAssociationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedClientDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
}
},
"additionalProperties": false
},
"RelatedDealDto": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
}
},
"additionalProperties": false
},
"RelatedDealsDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"relatedDeals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedDealDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedDocumentDto": {
"type": "object",
"properties": {
"document": {
"allOf": [
{
"$ref": "#/components/schemas/RelatedDocumentVersionedDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"RelatedDocumentVersionedDto": {
"type": "object",
"properties": {
"documentKey": {
"type": "string",
"nullable": true
},
"documentType": {
"type": "string",
"nullable": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
}
},
"additionalProperties": false
},
"RelatedDocumentsDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedDocumentDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedFCRDto": {
"type": "object",
"properties": {
"status": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"submittedDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"RelatedFCRsDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fcRs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedFCRDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedInvestmentManagerDataSource": {
"type": "object",
"properties": {
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"nullable": true
},
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"RelatedPartiesDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"relatedParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedPartyDto": {
"type": "object",
"properties": {
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"nullable": true
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedProductDto": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
},
"lifecycleStatus": {
"type": "string",
"nullable": true
},
"relationshipTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedProductsDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedProductDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RelatedUnderlyingPrincipalOwnerDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ReviewAndApprovalDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"reviewAndApprovals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewAndApprovalDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReviewAndApprovalDto": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Peter"
},
"dateOfBirth": {
"type": "Single",
"value": "1989-04-10"
},
"address": {
"type": "Collection",
"dataGroupId": "674ccef1-cfdc-46af-97f8-340b24ab7f43",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Poland",
"city": "Warszawa",
"street": "Nowogrodzka"
}
}
}
}
}
},
"approvalOutcome": {
"type": "string",
"nullable": true
},
"approvalReason": {
"type": "string",
"nullable": true
},
"taskId": {
"type": "string",
"nullable": true
},
"taskDataKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ScreeningMaterialityAssessmentDto": {
"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"
},
"nullable": true
},
"sanctionsJurisdictions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"adverseMediaJurisdictions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"enforcementsJurisdictions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"otherJurisdictions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"sanctionsProceedDecision": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ScreeningMaterialityDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assessments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScreeningMaterialityAssessmentDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SignificanceEngineDataSource": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true,
"readOnly": true
},
"significanceEngine": {
"allOf": [
{
"$ref": "#/components/schemas/SignificanceEngineDto"
}
],
"nullable": true
}
},
"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
},
"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",
"versionId"
],
"type": "object",
"properties": {
"jurisdiction": {
"minLength": 1,
"type": "string",
"description": "Jurisdiction Name",
"example": "Global"
},
"versionId": {
"minLength": 1,
"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": [ ]
}
]
}