Case Management

Case Management API

FormMetadataRequest

object
carrierstring

Carrier for the metadata.

Example:CarrierName_1

processstring

Process for the metadata

Example:New Business

taskTypestring

Task type for the metadata

Example:SUITABILITY_REVIEW

formSchemaobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
uiSchemaobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
Example

CaseCreateRequestV2

object
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
Example

CaseEscalationRequest

object
escalatedbooleanrequired

Whether the case should be escalated or de-escalated

Example:true

reasonstring

The reason for case escalation or de-escalation

Example:SLA Risk

sourcestring

The source for case escalation or de-escalation

Example:Call Center

Example

CaseCancelRequest

object
sourcestringrequired

Identifies the calling source/system

Example:Zinnia.BPMTransactions

cancellationReasonKeystringrequired

Key used to derive the configured caseResult and caseResultDetail from the reference store

Example:INVALID_CASE

Example

CaseCancelResponse

object
caseIdstring

Example:CA00000234

statusstring

Case status after cancellation

Example:CANCELED

cancellationReasonKeystring

Example:INVALID_CASE

caseResultstring

Result derived from the cancellationReasonKey

Example:Invalid Case

caseResultDetailstring

Result detail derived from the cancellationReasonKey

Example:This case is identified as invalid

sourcestring

Example:Zinnia.BPMTransactions

cancelledAtstring(date-time)

Example:2026-06-29T10:15:30Z

correlationIdstring

Example:fab83a6e-af7f-4508-be31-2a343d90d2c8

messagestring

Present only for an idempotent replay of an already-cancelled case; in that case the cancellation detail fields (cancellationReasonKey, caseResult, caseResultDetail, source, cancelledAt, correlationId) are omitted.

Example:Case CA00000234 was already cancelled prior to this request

Example