Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula Journey Logic Engine",
"description": "**Journey Logic Engine API**:\n\n<br> Logic Engine API is a rules engine impementation in Journey domain. The Logic Engine API should be used in tandem with Journey Command API and Journey Query API. Use the Journey Command API to create and manage Journey Schemas and Journey Instances. Use the Command Query API to retrieve Journey Schema and Journey Instance aggregates.\n\n<br> **Journey Logic Engine API Provides**:\n\n<br><ul><li> The ability to evaluate the logic conditions. The request should contain the values configured in the conditions (typically Entity attributes). The Logic Engine will execute the logic and return all matching Journey Schemas.The matched Journey Schema ID can be used then to create a new Journey Instance.</li></ul>",
"version": "2.0"
},
"servers": [
{
"url": "/journeylogicengine"
}
],
"paths": {
"/api/v2/cache/flush": {
"delete": {
"tags": [
"Cache"
],
"summary": "Allows clearing the Logic Engine API cache.\nThis is an maintenance endpoint and does not need to be used under normal circumstances.",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: JourneyBuilderDelete",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. Cache was flushed successfully."
},
"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/v2/engine/evaluate-journey-schema": {
"post": {
"tags": [
"Engine"
],
"summary": "Evaluates logic condition to retrieve matching Journey Schema(s)",
"description": "<ul>\n <li>Executes logic engine to retrieve all journey schemas that requests match with defined conditions.</li>\n <li>Returns the collection of matching journey schemas filtered by journey type if filter provided.</li>\n</ul><br /><br /><b>Required permissions:</b><br />Following permissions are required: JourneyCreate",
"operationId": "EvaluateJourneySchemaV2",
"parameters": [
{
"name": "journeyTypeFilter",
"in": "query",
"description": "Optional filter(s) to retrieve matched schemas only for specified journey type.\nIf multiple filters specified (i.e. Client Onboarding and Client Offboarding) both journey types will be returned (if matched).\nIf empty (no filters), all matched journey types will be returned.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Service request with key-value data required for evaluation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateJourneySchemaRequestV2DtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Success. The list of evaluated journey schemas is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateJourneySchemaResponseDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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": {
"required": [
"properties"
],
"type": "object",
"properties": {
"properties": {
"allOf": [
{
"$ref": "#/components/schemas/PropertiesDto"
}
],
"description": "Generic properties"
}
},
"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
},
"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": "Generic properties setup in policy for manual credit assessment",
"example": {
"firstName": {
"type": "Single",
"value": "Tom"
},
"dateOfBirth": {
"type": "Single",
"value": "2021-07-15"
},
"address": {
"type": "Collection",
"dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "Mayor Street"
}
},
"47010265-3b85-4407-be61-90d04525f020": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "E Wall Rd"
}
}
}
}
}
},
"assessmentOutcome": {
"type": "string",
"description": "Assessment Outcome of this manual credit assessment",
"nullable": true
},
"providerInternalIdentifier": {
"type": "string",
"description": "Provider Internal Identifier",
"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",
"description": "Entity Id",
"format": "uuid"
},
"creditScreeningOutcome": {
"type": "string",
"description": "The outcome recorded for a manual screening task.",
"nullable": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"description": "Generic properties setup in policy for auto credit screening",
"example": {
"firstName": {
"type": "Single",
"value": "Tom"
},
"dateOfBirth": {
"type": "Single",
"value": "2021-07-15"
},
"address": {
"type": "Collection",
"dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "Mayor Street"
}
},
"47010265-3b85-4407-be61-90d04525f020": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "E Wall Rd"
}
}
}
}
}
},
"providerInternalIdentifier": {
"type": "string",
"description": "Provider Internal Identifier",
"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
},
"ChannelTypeDto": {
"enum": [
"Internal",
"External",
"InternalAndExternal"
],
"type": "string"
},
"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": "Generic properties setup in policy",
"example": {
"firstName": {
"type": "Single",
"value": "Tom"
},
"dateOfBirth": {
"type": "Single",
"value": "2021-07-15"
},
"address": {
"type": "Collection",
"dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "Mayor Street"
}
},
"47010265-3b85-4407-be61-90d04525f020": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "E Wall Rd"
}
}
}
}
}
}
},
"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": {
"required": [
"properties",
"taskId"
],
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"description": "Generic properties setup in policy for manual credit assessment",
"example": {
"firstName": {
"type": "Single",
"value": "Tom"
},
"dateOfBirth": {
"type": "Single",
"value": "2021-07-15"
},
"address": {
"type": "Collection",
"dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "Mayor Street"
}
},
"47010265-3b85-4407-be61-90d04525f020": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "E Wall Rd"
}
}
}
}
}
},
"assessmentOutcome": {
"type": "string",
"description": "Assessment Outcome of this manual credit assessment",
"nullable": true
},
"assessmentComment": {
"type": "string",
"description": "Assessment Comment of this credit assessment",
"nullable": true
},
"taskId": {
"type": "string",
"description": "Task Id"
},
"taskDataKey": {
"type": "string",
"description": "Task Data Key",
"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": "Generic properties setup in product policy",
"example": {
"firstName": {
"type": "Single",
"value": "Tom"
},
"dateOfBirth": {
"type": "Single",
"value": "2021-07-15"
},
"address": {
"type": "Collection",
"dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "Mayor Street"
}
},
"47010265-3b85-4407-be61-90d04525f020": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "E Wall Rd"
}
}
}
}
}
},
"lifecycleStatus": {
"type": "string",
"description": "System field used in backend for status of a product in lifecycle",
"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"
},
"nullable": true,
"example": {
"firstName": {
"type": "Single",
"value": "Tom"
},
"dateOfBirth": {
"type": "Single",
"value": "2021-07-15"
},
"address": {
"type": "Collection",
"dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc",
"collections": {
"54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "Mayor Street"
}
},
"47010265-3b85-4407-be61-90d04525f020": {
"properties": {
"country": "Ireland",
"city": "Dublin",
"street": "E Wall Rd"
}
}
}
}
}
}
},
"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"
}
],
"description": "DataSource for EntityDraft information beside generic properties",
"nullable": true
},
"eventIngress": {
"allOf": [
{
"$ref": "#/components/schemas/EventIngressDataSource"
}
],
"description": "DataSource for EventIngress event details",
"nullable": true
},
"changedFields": {
"allOf": [
{
"$ref": "#/components/schemas/ChangedFieldsDataSource"
}
],
"description": "DataSource for detecting changed EntityDraft properties in comparasion with verified Entity",
"nullable": true
},
"relatedClient": {
"allOf": [
{
"$ref": "#/components/schemas/RelatedClientDataSource"
}
],
"description": "DataSource for new Related Client properties added in Association task",
"nullable": true
},
"relatedProducts": {
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-journeylogicengine-v2-0-openapi.json