---
title: "CaseInstanceSummaryResponse"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/CaseInstanceSummaryResponse"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# CaseInstanceSummaryResponse

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    CaseInstanceSummaryModel:
      type: object
      properties:
        id:
          type: string
          description: Case instance identifier
          example: case-123
        templateId:
          type: string
          description: Template identifier used for the case
          example: template-456
        carrier:
          type: string
          description: Insurance carrier name
          example: EVGL Insurance
        process:
          type: string
          description: Process name
          example: New Business
        parentInstanceId:
          type: string
          description: Parent instance identifier
          example: parent-case-789
        correlationId:
          type: string
          description: Correlation identifier
          example: corr-123
        caseStatus:
          type: string
          description: Current status of the case
          example: In Progress
        processSubType:
          type: string
          description: Process sub-type
          example: New Application
        policyNumber:
          type: string
          description: Policy number
          example: POL123456789
        productName:
          type: string
          description: Name of the insurance product
          example: Term Life 20
        primary:
          type: boolean
          description: Indicates if this is a primary case
          example: true
        deleted:
          type: boolean
          description: Indicates if the case has been deleted
          example: false
        stages:
          description: List of case stages
          type: array
          items:
            $ref: "#/components/schemas/CaseInstanceStageSummary"
        additionalData:
          type: object
          description: Additional data associated with the case
          example:
            key1: value1
            key2: value2
        identifiers:
          description: List of identifiers for the case
          type: array
          items:
            $ref: "#/components/schemas/IdentifierDocument"
        createdAt:
          type: string
          description: Date when the case was created
          example: 2023-01-15T10:30:00Z
        updatedAt:
          type: string
          description: Date when the case was last updated
          example: 2023-01-16T14:45:00Z
        parties:
          description: List of parties involved in the case
          type: array
          items:
            $ref: "#/components/schemas/PartyDetailsModel"
        exceptions:
          description: List of exceptions associated with the case
          type: array
          items:
            $ref: "#/components/schemas/InstanceExceptionModel"
        applicationType:
          type: string
          description: Type of application
          example: policy
        caseResult:
          type: string
          description: Result of the case processing
          example: Approved
        caseResultDetail:
          type: string
          description: Detailed result information
          example: Approved with standard rates
      required:
        - primary
        - deleted
        - additionalData
        - identifiers
    CaseInstanceStageSummary:
      type: object
      properties:
        id:
          type: string
          description: Stage identifier
          example: stage-123
        label:
          type: string
          description: Display label for the stage
          example: Document Review
        stageStatus:
          type: string
          description: Current status of the stage
          example: Completed
    IdentifierDocument:
      type: object
      properties:
        identifier:
          type: string
          description: Type of identifier
          example: SSN
        value:
          type: string
          description: Value of the identifier
          example: 123-45-6789
    PartyDetailsModel:
      type: object
      properties:
        partyRole:
          type: string
          description: Role of the party in the case
          example: Owner
        partyType:
          type: string
          description: Type of party
          example: Individual
        firstName:
          type: string
          description: First name of the party
          example: John
        middleName:
          type: string
          description: Middle name of the party
          example: A
        lastName:
          type: string
          description: Last name of the party
          example: Doe
        fullName:
          type: string
          description: Full name of the party
          example: John A Doe
        prefix:
          type: string
          description: Name prefix
          example: Mr
        suffix:
          type: string
          description: Name suffix
          example: Jr
        gender:
          type: string
          description: Gender of the party
          example: Male
        ssn:
          type: string
          description: Social Security Number (masked)
          example: XXX-XX-1234
        percent:
          type: string
          description: Percentage value associated with the party
          example: "50"
        externalId:
          type: string
          description: External identifier for the party
          example: EXT-PARTY-123
    InstanceExceptionModel:
      type: object
      properties:
        id:
          type: string
          description: Exception identifier
          example: exc-123
        externalId:
          type: string
          description: External identifier for the exception
          example: EXT-123
        status:
          type: string
          description: Current status of the exception
          example: Open
        category:
          type: string
          description: Exception category
          example: Documentation
        exceptionType:
          type: string
          description: Type of exception
          example: Technical
        reason:
          type: string
          description: Brief reason for the exception
          example: Missing document
        detailedReason:
          type: string
          description: Detailed description of the exception reason
          example: Signature missing on page 3 of application form
        processingReason:
          type: string
          description: Processing reason for the exception
          example: Requires manual review
        processingResolution:
          type: string
          description: Resolution details for processing
          example: Document resent by applicant
        createdAt:
          type: string
          description: Date when the exception was created
          example: 2023-01-15T10:30:00Z
        updatedAt:
          type: string
          description: Date when the exception was last updated
          example: 2023-01-16T14:45:00Z
    CaseInstanceSummaryResponse:
      type: object
      properties:
        message:
          type: string
          description: Response message
          example: Success
        data:
          description: Array of case instance summaries
          items:
            $ref: "#/components/schemas/CaseInstanceSummaryModel"
          type: array
        count:
          type: number
          description: Number of results in the current page
          example: 10
        offset:
          type: number
          description: Starting index of the results
          example: 0
        limit:
          type: number
          description: Maximum number of results to return
          example: 25
        total:
          type: number
          description: Total number of results available
          example: 100
        status:
          type: number
          description: HTTP status code
          example: 200
      required:
        - data
        - count
        - offset
        - limit
        - total
        - status
```