---
title: "CaseInstance"
url: "https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5/schemas/CaseInstance"
---

> Full API specification: https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5.md

# CaseInstance

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Case Management API
  version: 1.0.0
servers:
  - url: https://dev.api.zinnia.io/
    description: Dev Environment
  - url: https://qa.api.zinnia.io/
    description: QA Environment
  - url: https://uat.api.zinnia.io/
    description: UAT Environment
  - url: https://api.zinnia.io/
    description: PROD Environment
components:
  schemas:
    DocumentInstance:
      type: object
      properties:
        id:
          type: string
          example: "12345"
        name:
          type: string
          example: Identity_Document.pdf
        documentNumber:
          type: string
          example: "119299808"
        source:
          type: string
          example: onbase
        url:
          type: string
          example: http://dev.onbase.com/document/12345
        updatedAt:
          type: string
          example: 09-April-2023
        fileType:
          type: string
          example: NB Fix
        documentUploadDate:
          type: string
          example: 2024-10-04T13:16:45-05:00
        additionalData:
          $ref: "#/components/schemas/AdditionalDataInstance"
        eventRef:
          type: array
          items:
            type: string
            example: 15ea7582-262f-4dfe-8a60-1e8b8e763fd4
    ExceptionInstance:
      type: object
      properties:
        id:
          type: string
          description: Unique Identifier for Exception Instance
        status:
          type: string
          enum:
            - NEW
            - RESOLVED
          description: Status of Exception Instance
        exceptionRefId:
          type: string
          description: The exceptionRefId of the exception.
          example: NB.EM.068
        exceptionType:
          type: string
          description: The exceptionType of the exception.
          example: Business Exception
        category:
          type: string
          description: Category of Exception
        reason:
          type: string
          description: Short description of Exception
        detailedReason:
          type: string
          description: Detailed description of Exception
        updatedAt:
          type: string
          description: Last updated timestamp of Exception
        taskIdList:
          type: array
          items:
            type: string
          uniqueItems: true
          description: List of Task Identifier associated with Exception Instance
        additionalData:
          $ref: "#/components/schemas/AdditionalDataInstance"
        exceptionAdditionalData:
          type: array
          description: Exception Additional Data
          items:
            $ref: "#/components/schemas/ExceptionAdditionalData"
        eventRef:
          type: array
          items:
            type: string
          description: List of Events associated with Exception Instance
    NoteInstance:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier of Note
        note:
          type: string
          description: The Text content of Note
        author:
          type: string
          description: Author of note
        internal:
          type: boolean
          description: Indicates whether the item is internal or not.
        createdAt:
          type: string
          description: The timestamp of Note been created
        updatedAt:
          type: string
          example: 09-April-2023
          description: The timestamp of Note been updated
        desc:
          type: string
          description: Description of note
        additionalData:
          $ref: "#/components/schemas/AdditionalDataInstance"
        eventRef:
          type: array
          items:
            type: string
          description: List of Events associated with Note Instance
    TaskLinkInstance:
      type: object
      properties:
        id:
          type: string
          description: A Unique identifier of Task in Task Management
        taskType:
          type: string
          description: Business friendly type for Task
        label:
          type: string
          description: Business friendly Label for Task
        assignee:
          type: string
          description: User currently assigned to the task
        status:
          type: string
          description: Status of Task (STATUS DISCUSSION IN PROGRESS)
          enum:
            - OPEN
            - CLOSED
            - NEW
            - COMPLETED
            - COMPLETE
        taskName:
          type: string
          description: task name of the task
        queue:
          type: string
          description: Queue to which the task is assigned
        createdAt:
          type: string
          description: Timestamp when the Task was created
        updatedAt:
          type: string
          description: Timestamp when the Task was last updated
        eventRef:
          type: array
          items:
            type: string
            description: List of Events associated with Note Instance
        externalTaskId:
          type: string
          description: The identifier how an external system understand it for example
            used to map onbase taskId
        notesIdList:
          type: array
          items:
            type: string
          description: List of Note identifiers associated to Task
    IdentifierInstance:
      type: object
      description: An object representing an identifier and its corresponding value.
      properties:
        identifier:
          type: string
          description: The type of identifier.
        value:
          type: string
          description: The value of the identifier.
    CaseAdditionalDataNB:
      type: object
      properties:
        policyNumber:
          type: string
          example: "12345678"
        requestSubType:
          type: string
          example: NB Purchase w APP
        owners:
          type: array
          items:
            type: object
            properties:
              firstName:
                type: string
                example: Utkarsh
              lastName:
                type: string
                example: Jain
              middleName:
                type: string
                example: Kumar
              fullName:
                type: string
                example: Utkarsh Kumar Jain
              ssn:
                type: string
                example: "045678387"
    CaseAdditionalDataWD:
      type: object
      properties:
        policyNumber:
          type: string
          example: "12345678"
        ownerName:
          type: string
          example: John
        ssn:
          type: string
          example: xxxx-xxx-1245
    StageInstance:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the stage instance.
        label:
          type: string
          description: Business Friendly label for the stage instance.
        stageStatus:
          type: string
          description: Current status of the stage instance.
          enum:
            - IN_PROGRESS
            - EXCEPTION
            - COMPLETED
            - NOT_STARTED
        mappedTasks:
          type: array
          description: List of identifiers for tasks mapped to this stage (RESERVED FOR
            FUTURE SCOPE).
          items:
            type: string
        mappedNotes:
          type: array
          description: List of identifiers for notes mapped to this stage (RESERVED FOR
            FUTURE SCOPE).
          items:
            type: string
        steps:
          type: array
          description: List of step instances that make up this stage.
          items:
            $ref: "#/components/schemas/StepInstance"
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the stage instance was created.
    AdditionalDataInstance:
      type: object
      additionalProperties:
        type: string
    ExceptionAdditionalData:
      type: object
      description: Additional data related to the Exception.
      properties:
        id:
          type: string
          description: A identifier of Exception Addtional Attribute.
          example: severity
        label:
          type: string
          description: The label for Exception Addtional Attribute.
          example: SEVERITY
        value:
          type: string
          description: The value of Exception Addtional Attribute.
          example: Medium
        dataType:
          type: string
          description: The data type of Exception Addtional Attribute.
          example: STRING
        entityType:
          type: string
          description: The Entity Type of Exception Addtional Attribute.
          example: INCIDENT_ENTITY
        source:
          type: string
          description: The Source of Exception Addtional Attribute.
          example: Zinnia.BPMTransactions
    StepInstance:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the step instance.
        label:
          type: string
          description: Business Friendly label for the step instance.
        stepStatus:
          type: string
          description: Current status of the step instance.
          enum:
            - IN_PROGRESS
            - EXCEPTION
            - COMPLETED
            - NOT_STARTED
        stepResult:
          type: string
          description: Step level decision outcome
        eventRef:
          type: array
          description: List of event references associated with this step.
          items:
            type: string
        mappedTasks:
          type: array
          description: List of identifiers for tasks mapped to this step.
          items:
            type: string
        mappedExceptions:
          type: array
          description: List of exception mapped to this step.
          items:
            type: string
        mappedDocuments:
          type: array
          description: List of document id mapped to this step.
          items:
            type: string
        mappedCases:
          type: array
          description: List of Case id mapped to this step.
          items:
            type: string
        mappedNotes:
          type: array
          description: List of identifiers for notes mapped to this step (RESERVED FOR
            FUTURE SCOPE).
          items:
            type: string
        multiInstance:
          type: boolean
          description: Indicates whether step is multiple instance or not.
          default: false
        instanceInfo:
          type: object
          description: Contains information about the multi instance step
          properties:
            identifier:
              type: string
              description: A unique identifier for the multi instance step.
            label:
              type: string
              description: The label of the multi instance step.
            object:
              type: string
              description: The object of the multi instance step.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the step instance was created.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the step instance was last updated.
    CaseInstance:
      type: object
      properties:
        _id:
          type: string
          description: Unique identifier for the case instance.
        templateId:
          type: string
          description: Identifier for the template associated with the case instance.
        carrier:
          type: string
          description: Name of the carrier associated with transaction/case.
        process:
          type: string
          description: Name of the process/transaction type for case.
        caseGroup:
          type: string
          description: Name of the caseGroup type for case.
        parentInstanceId:
          type: string
          description: Identifier for the parent case instance, if applicable.
        correlationId:
          type: string
          description: Identifier used for correlating events as they received.
        caseStatus:
          description: Current status of the case instance.
          type: string
          enum:
            - IN_PROGRESS
            - EXCEPTION
            - COMPLETED
            - CANCELED
        caseResult:
          description: Contextual information regarding the caseStatus especially when
            case is marked as canceled
          type: string
        caseResultDetail:
          description: Detailed contextual information regarding the caseStatus
          type: string
        primary:
          type: boolean
          description: Indicates if this is the primary case instance.
        escalated:
          type: boolean
          description: Indicates if the case instance has been escalated.
        caseProcessingDetails:
          type: array
          description: List of detail sections for case processing.
          items:
            type: object
            properties:
              detailType:
                type: string
                description: Type of the detail section (e.g., "submissionDetails",
                  "executionDetails").
                example: submissionDetails
              properties:
                type: array
                description: List of properties for the detail section.
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                      description: Identifier for the property (e.g., "submittedBy",
                        "submissionSource").
                      example: submittedBy
                    value:
                      type: string
                      description: Value of the property.
                      example: MANUAL
        linkDetails:
          type: object
          description: Details about linked case instances.
          properties:
            linkedCaseInstanceId:
              type: string
              description: Identifier of the linked case instance.
            linkedReason:
              type: string
              description: Reason for linking the case instances. It could be identified by
                case management system or by some external system
        processSubType:
          type: string
          description: Subtype of the process/transaction associated with the case.
        policyNumber:
          type: string
          description: Policy number/Contract No associated to the case instance.
        planCode:
          type: string
          description: PlanCode associated to the case instance.
        productName:
          description: Name of the product associated with Contract/Policy.
          type: string
        documents:
          type: array
          description: List of document associated to the case. (DEPRECATED)
          deprecated: true
          items:
            $ref: "#/components/schemas/DocumentInstance"
        exceptions:
          description: List of all exceptions/NIGOs associated related to the case.
          type: array
          items:
            $ref: "#/components/schemas/ExceptionInstance"
        notes:
          type: array
          description: List of all note associated to the case.
          items:
            $ref: "#/components/schemas/NoteInstance"
        tasks:
          type: array
          description: List of all tasks associated to the case irrespective of different
            stage/steps.
          items:
            $ref: "#/components/schemas/TaskLinkInstance"
        mappedTasks:
          type: array
          description: List of Task Identifiers which directly linked to Case (RESERVED
            FOR FUTURE SCOPE)
          items:
            type: string
        mappedExceptions:
          type: array
          description: List of Exception/NIGO Identifiers which directly linked to Case
            (RESERVED FOR FUTURE SCOPE)
          items:
            type: string
        mappedNotes:
          type: array
          description: List of Notes Identifiers which directly linked to Case (RESERVED
            FOR FUTURE SCOPE)
          items:
            type: string
        mappedDocuments:
          type: array
          description: List of Exception/NIGO Identifiers which directly linked to Case
            (RESERVED FOR FUTURE SCOPE)
          items:
            type: string
        parties:
          type: array
          description: List of individuals/parties associated with the contract/policy
            related to the case
          items:
            type: object
            properties:
              partyRole:
                type: string
                description: Role of the party in the case. (LIST TO BE SHARED BY SOR)
                enum:
                  - Annuitant / Insured, Primary
                  - Owner, Primary
                  - Beneficiary, Primary
                  - Servicing Agent
                  - Agent
              partyType:
                type: string
                description: Type of party involved in the case.
                enum:
                  - Company
                  - Individual
                  - Other
                  - Trust
                  - UGMA
              firstName:
                type: string
                description: First name of the party.
              middleName:
                type: string
                description: Middle name of the party.
              lastName:
                type: string
                description: Last name of the party.
              fullName:
                type: string
                description: Full name of the party.
              prefix:
                type: string
                description: Prefix of the party's name.
              suffix:
                type: string
                description: Suffix of the party's name.
              gender:
                type: string
                description: Gender of the party.
              ssn:
                type: string
                description: ssn of the party.
              percent:
                type: string
                description: Percentage share or involvement of the party in the policy.
        identifiers:
          type: array
          description: List of identifiers received from different systems.
          items:
            $ref: "#/components/schemas/IdentifierInstance"
        additionalData:
          description: Additional data related to the case. (DEPRECATED)
          deprecated: true
          oneOf:
            - $ref: "#/components/schemas/CaseAdditionalDataNB"
            - $ref: "#/components/schemas/CaseAdditionalDataWD"
        stages:
          type: array
          description: List of stages representing milestone in the journey of a
            case/transaction.
          items:
            $ref: "#/components/schemas/StageInstance"
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the case instance was created, derived from the time
            of the initial event.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the case instance was last updated, derived from the
            time of the latest event.
        systemUpdatedDt:
          type: string
          format: date
          description: The date when the system was last updated.
        deleted:
          type: boolean
          description: Indicates if the case instance has been deleted.
        techExceptionStatus:
          type: string
          description: Overall status of technical exceptions on the case
        techExceptionCount:
          type: integer
          format: int32
          description: Total count of technical exceptions on the case
```