--- title: "CaseInstanceSummary" url: "https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5/schemas/CaseInstanceSummary" --- > Full API specification: https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5.md # CaseInstanceSummary ## 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: 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 CaseInstanceSummary: type: object properties: id: type: string description: A unique identifier for the case instance. example: 15ea7582-262f-4dfe-8a60-1e8b8e763fd4 templateId: type: string description: The identifier of the template associated with the case. example: cde717c9-5f7e-4c63-953c-ef50e44c021a carrier: type: string description: The carrier associated with the case. example: CarrierName_1 process: type: string description: The process associated with the case. example: Correspondence parentInstanceId: type: string description: The identifier of the parent case instance, if any. example: 15ea7582-262f-4dfe-8a60-1e8b8e763fb1 caseGroup: type: string description: Name of the caseGroup type for case. example: Distribution escalated: type: boolean description: Indicates if the case instance has been escalated. default: false example: false deleted: type: boolean description: Indicates if the case instance has been deleted. default: false example: false applicationType: type: string description: The application type of the policy. example: Digital caseResult: type: string description: Contextual information regarding the caseStatus especially when case is marked as canceled caseResultDetail: type: string description: Detailed contextual information regarding the caseStatus correlationId: type: string description: An identifier used to correlate related events or instances. example: 15ea7582-262f-4dfe-8a60-1e8b8e763fb1 primary: type: boolean description: Indicates if this is the primary case instance. example: false processSubType: type: string description: Subtype of the process/transaction associated with the case. example: INCOMING_TRANSFER policyNumber: type: string description: Policy number/Contract No associated with the case instance. example: "571001920" productName: type: string description: Name of the product associated with the Contract/Policy. example: CarrierName_1MUTUAL STABLE VOYAGE caseStatus: type: string description: The current status of the case. enum: - IN_PROGRESS - EXCEPTION - COMPLETED - CANCELED example: IN_PROGRESS stages: type: array description: A list of stages associated with the case. items: type: object properties: id: type: string description: A unique identifier for the stage. example: 15ea7582-262f-4dfe-8a60-1e8b8e763fb2 label: type: string description: The label of the stage. example: Agent Validation stageStatus: type: string description: The current status of the stage. enum: - IN_PROGRESS - EXCEPTION - COMPLETED exceptions: type: array description: A list of exceptions associated with the case. items: type: object properties: id: type: string description: A unique identifier for the exception. example: "123456" status: type: string description: The status of the exception. enum: - NEW - RESOLVED example: NEW exceptionRefId: type: string description: The exceptionRefId of the exception. example: NB.EM.068 category: type: string description: The category of the exception. example: Agent reason: type: string description: The reason for the exception. example: reason detailedReason: type: string description: A detailed reason for the exception. example: detailed status createdAt: type: string format: date-time description: The date and time when the exception was created. updatedAt: type: string format: date-time description: The date and time when the exception was last updated. parties: type: array description: A list of parties associated with the case. items: type: object properties: partyRole: type: string description: The role of the party in the case. enum: - Annuitant / Insured, Primary - Owner, Primary - Beneficiary, Primary - Servicing Agent - Agent example: Owner, Primary partyType: type: string description: The type of the party. example: Individual firstName: type: string description: The first name of the party. example: Utkarsh middleName: type: string description: The middle name of the party. example: Kr lastName: type: string description: The last name of the party. example: Jain fullName: type: string description: The full name of the party. example: Utkarsh Kr Jain prefix: type: string description: The prefix for the party's name. example: Mr. suffix: type: string description: The suffix for the party's name. example: "1" gender: type: string description: The gender of the party. example: M ssn: type: string description: The ssn of the party. example: "123456789" percent: type: string description: The percentage associated with the party's role in the case. example: "100" additionalData: oneOf: - $ref: "#/components/schemas/CaseAdditionalDataNB" - $ref: "#/components/schemas/CaseAdditionalDataWD" description: Additional data specific to the case. identifiers: type: array description: A list of identifiers associated with the case. items: type: object properties: identifier: type: string description: The type of identifier. example: policyNumber value: type: string description: The value of the identifier. example: AU42046202 createdAt: type: string format: date-time description: The date and time when the case was created. updatedAt: type: string format: date-time description: The date and time when the case was last updated. ```