Case Management

Case Management API

Create Case

Create or Find a Case for/By specified values

post

Body

application/json

Case details for creation

CaseCreateRequestV2

correlationidstring

The correlationId associated with the case.

Example:218d8992-3783-42ac-b59a-66cbc36adaab

sourcestring

The source associated with the case.

Example:Zinnia.OnBase

carrierstring

The carrier associated with the case.

Example:CarrierName_1

specversionstring

The specversion associated with the case.

Example:V1

typestring

The type associated with the case.

Example:CaseCreated

datacontenttypestring

The datacontenttype associated with the case.

Example:application/json

dataschemastring

The dataschema associated with the case.

Example:jsondata

subjectstring

The subject associated with the case.

Example:subject

sourcelocatorstring

The sourcelocator associated with the case.

Example:sourcelocator

datastring

The data associated with the case.

Example:[{"clientCode":"CarrierName_1","documentHandle":"206426781","documentType":"Incoming Transfer","documentNumber":"20240801-EM-426781","caseId":"156779803","caseStatus":"CP - New","contractNumber":"","caseCreatedOn":"2024-08-01T15:57:18-05:00","caseUpdatedOn":"2024-08-01T15:57:18-05:00","transactionType":"INCOMING TRANSFER","processType":"New Business","batchID":"13326094","productName":"CarrierName_1MUTUAL STABLE VOYAGE","correlationId":"e18d8992-3783-42ac-b59a-66cbc36adaab"}]

dataBase64string

The dataBase64 associated with the case.

Example:jsondata

identifiersarray[object]

An object representing an identifier and its corresponding value.

Show Child Parameters

Response

application/json

Case Created

CaseInstance

idstring

Unique identifier for the case instance.

templateIdstring

Identifier for the template associated with the case instance.

carrierstring

Name of the carrier associated with transaction/case.

processstring

Name of the process/transaction type for case.

caseGroupstring

Name of the caseGroup type for case.

parentInstanceIdstring

Identifier for the parent case instance, if applicable.

correlationIdstring

Identifier used for correlating events as they received.

caseStatusstring

Current status of the case instance.

Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED

caseResultstring

Contextual information regarding the caseStatus especially when case is marked as canceled

caseResultDetailstring

Detailed contextual information regarding the caseStatus

primaryboolean

Indicates if this is the primary case instance.

escalatedboolean

Indicates if the case instance has been escalated.

caseProcessingDetailsarray[object]

List of detail sections for case processing.

Show Child Parameters
processSubTypestring

Subtype of the process/transaction associated with the case.

policyNumberstring

Policy number/Contract No associated to the case instance.

planCodestring

PlanCode associated to the case instance.

productNamestring

Name of the product associated with Contract/Policy.

documentsarray[object]DEPRECATED

List of document associated to the case. (DEPRECATED)

Show Child Parameters
exceptionsarray[object]

List of all exceptions/NIGOs associated related to the case.

Show Child Parameters
notesarray[object]

List of all note associated to the case.

Show Child Parameters
tasksarray[object]

List of all tasks associated to the case irrespective of different stage/steps.

Show Child Parameters
mappedTasksarray[string]

List of Task Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)

mappedExceptionsarray[string]

List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)

mappedNotesarray | null[string]

List of Notes Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)

mappedDocumentsarray[string]

List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)

partiesarray[object]

List of individuals/parties associated with the contract/policy related to the case

Show Child Parameters
identifiersarray[object]

An object representing an identifier and its corresponding value.

Show Child Parameters
additionalDataobjectDEPRECATED

Additional data related to the case. (DEPRECATED)

Example:{"brokerDealerName":"LPL FINANCIAL CORPORATION"}

stagesarray[object]

List of stages representing milestone in the journey of a case/transaction.

Show Child Parameters
createdAtstring(date-time)

Timestamp when the case instance was created, derived from the time of the initial event.

updatedAtstring(date-time)

Timestamp when the case instance was last updated, derived from the time of the latest event.

systemUpdatedDtinteger(int64)

Epoch milliseconds when the case was last updated in the system.

Example:1784635013613

deletedboolean

Indicates if the case instance has been deleted.

techExceptionStatusstring

Overall status of technical exceptions on the case

techExceptionCountinteger(int32)

Total count of technical exceptions on the case

linkedCasesarray | null[string]

Set of case IDs linked to this case instance.

applicationTypestring

Application type (e.g. Electronic, Manual).

Example:Electronic

caseAdditionalDataarray[object]

A structured additional data attribute attached to a case.

Show Child Parameters
systemCreatedDateinteger(int64)

Epoch milliseconds when the case was created in the system.

Example:1784635013613

systemCreatedDtinteger(int64)

Alias of systemCreatedDate.

Example:1784635013613

slaStartDateinteger | null(int64)

SLA start date as epoch milliseconds.

etcDateinteger | null(int64)

Estimated time of completion as epoch milliseconds.

post/case/v2/cases

Body

{ "correlationid": "218d8992-3783-42ac-b59a-66cbc36adaab", "source": "Zinnia.OnBase", "carrier": "CarrierName_1", "type": "CaseCreated", "datacontenttype": "application/json", "data": "[{\"clientCode\":\"CarrierName_1\",\"documentHandle\":\"206426781\",\"documentType\":\"Incoming Transfer\",\"documentNumber\":\"20240801-EM-426781\",\"caseId\":\"156779803\",\"caseStatus\":\"CP - New\",\"contractNumber\":\"\",\"caseCreatedOn\":\"2024-08-01T15:57:18-05:00\",\"caseUpdatedOn\":\"2024-08-01T15:57:18-05:00\",\"transactionType\":\"INCOMING TRANSFER\",\"processType\":\"New Business\",\"batchID\":\"13326094\",\"productName\":\"CarrierName_1MUTUAL STABLE VOYAGE\",\"correlationId\":\"e18d8992-3783-42ac-b59a-66cbc36adaab\"}]", "identifiers": [ { "identifier": "caseID", "value": "156779801" }, { "identifier": "documentNumber", "value": "20240801-EM-426782" } ] }
 
application/json

FetchFlowResponse

object
stagesarray[object]
Show Child Parameters
Example

MultiFlowStageResponse

object
idstring

Example:requestAck

labelstring

Example:Request Acknowledgement

optionalboolean
stepsarray[object]
Show Child Parameters
Example

MultiFlowStepResponse

object
idstring

Example:requestAck.withdrawalRequestReceived

labelstring

Example:Request Received

optionalboolean
Example

ActivityFeedCreateRequest

object

Request body to create a generic activity feed entry for the case identified in the path.
Do not send rootEntityId, rootEntityType, or description; the service derives root metadata and description handling.

carrierstringrequired

Carrier code; must be in the deployment allowlist for activity feed publishing

Example:GILI

entityTypestringrequired

Type of entity in the activity feed

Allowed values:TASKSTAGESTEPCASEEXCEPTIONDOCUMENT

entityIdstringrequired

Identifier of the entity the action applies to (e.g. stage id)

Example:processData

entityLabelstringrequired

Human-readable label for the entity

Example:Process document generation request

entityActionstringrequired

Type of action performed on the entity (includes values used by search filters and generic create flows)

Allowed values:CREATEDSTATUS_CHANGEASSIGNMENTUNASSIGNMENTPRIORITIZEDDEPRIORITIZEDUPDATEDRESETREMOVEDREQUESTED

activityFeedRequestIdstring(uuid)required

Caller-supplied idempotency / correlation key; stored as source.id on the activity feed document

Example:cfba1b0e-b44e-4657-b7fa-2ec2efee8bb7

changedFieldstringrequired

Semantic name of the field or attribute that changed

Example:stageStatus

valueBeforeUpdatestring

Previous value when applicable; omit or null when not meaningful

Example:COMPLETED

valueAfterUpdatestringrequired

Value after the business action

Example:IN_PROGRESS

activityFeedSourceTypestringrequired

Source channel for the feed entry (e.g. API for this endpoint; EVENT for Kafka-originated generic actions)

Example:API

activityFeedPerformedBystringrequired

System or user principal that performed the action (stored on source.performedBy)

Example:Zinnia.UI

eventTimeinteger(int64)required

Epoch milliseconds when the business action occurred

Example:1778675772613

entityProcessingTimeinteger(int64)required

Epoch milliseconds when the system processed the action

Example:1778675800625

parentEntityDetailsarray[object]

Optional parent entity chain. When omitted, the server defaults to [{ entityType: CASE, entityId: <caseId> }].

Show Child Parameters
additionalAttributesarray[object]

Optional structured add-ons. When present, each element must use FEED_ADDITIONAL_DATA with a non-empty values list.

Show Child Parameters
Example