Case orchestration API for creating and retrieving case instances that group the documents, requirements and transactions belonging to a single piece of work across the Zinnia platform.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/zinnia-case-management-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.0.3
info:
title: Case Management API
description: Maintains cases and tasks apis related to the policy lifecycle.
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
tags:
- name: Case Instance
description: Manages cases for all processes
- name: Task Instance (Legacy)
description: Legacy - Manages tasks based on cases. Used for Withdrawal/Renewal. No further changes accepted.
- name: Task Instance (Task Management)
description: Manages tasks based on cases. Implemented using Zinnia Live Task management framework.
- name: Task Form Metadata
- name: Reference data
description: Reference data applicable for cases
- name: Exception Instance (Exception Management)
- name: Exception Reference
- name: Activity Feed Management
description: Manages activity feed search and retrieval for cases
- name: Case Linking
description: Manages case linking operations including retrieval of linked cases
paths:
/case/v1/cases/{caseId}:
get:
summary: Get Case Detail
tags:
- Case Instance
description: Retrieve the case instance details using the system identifier (caseId).
operationId: getCaseInstanceById
parameters:
- name: caseId
in: path
description: Case instance id
example: CA0000360227
required: true
schema:
type: string
responses:
'200':
description: Case details retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInstance'
example:
id: CA0000360227
templateId: b5664374-8724-43c8-846c-0f8fad7890fd
carrier: CarrierName_1
process: New Business
caseGroup: New Business
parentInstanceId: ''
correlationId: 96d5a484-78b2-4245-9588-d65e670d1c08
caseStatus: IN_PROGRESS
caseResult: ''
caseResultDetail: ''
primary: false
caseProcessingDetails:
- detailType: submissionDetails
properties:
- _id: submittedBy
value: MANUAL
- _id: submissionSource
value: Orion
linkDetails:
linkedCaseInstanceId: 0000028951
linkedReason: Identified by case management
processSubType: ANNUITY APPLICATION
policyNumber: '5810000002'
planCode: '900'
productName: ''
documents:
- id: '119299808'
name: NB Purchase w App
documentNumber: 11251004-M-199808
source: Source
url: https://example.com/doc-123
updatedAt: '2023-10-10T12:34:56Z'
fileType: NB Fix
documentUploadDate: '2023-10-10T12:34:56Z'
exceptions:
- id: '9989285'
status: RESOLVED
excptionRefId: NB.EM.068
exceptionType: Business Exception
category: ACH
reason: INCORRECT ACH INFORMATION PROVIDED
detailedReason: BANK NAME
updatedAt: '2024-07-15T22:47:54.000Z'
taskIdList:
- '9989286'
additionalData: {}
eventRef:
- 85d469a5-e5d9-40b3-b7c8-144bdf10ed0d
- 33cc35a5-c5fc-44ac-95a9-c910b2096f38
notes: []
tasks:
- label: ''
id: '9989286'
assignee: ''
status: COMPLETE
updatedAt: '2024-07-15T22:54:22.000Z'
createdAt: '2024-07-15T22:44:24.000Z'
taskType: Manual Check
taskName: Manual Check
queue: new_business
additionalData: {}
eventRef:
- 0da9f427-7bdd-4018-9cb4-160260a6f1c5
- 7d7766cd-452a-4cbe-bd37-d5490a16415b
- 99aca59e-a83f-4575-b1de-df2b35ccf83d
externalTaskId: '9989286'
notesIdList: []
- label: ''
id: '9989292'
assignee: ''
status: COMPLETE
updatedAt: '2024-07-15T22:56:19.000Z'
createdAt: '2024-07-15T22:50:24.000Z'
taskType: Checks Out
additionalData: {}
eventRef:
- 9db828ce-fea4-4896-a1e2-972971b08191
- bda9a2f6-b1a7-4ede-b543-660b5951d12c
externalTaskId: '9989292'
notesIdList: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
identifiers:
- identifier: documentNumber
value: 20240715-MAN-389232
- identifier: policyNumber
value: '5810000002'
- identifier: caseID
value: '9989283'
- identifier: businessKey
value: 20240715-MAN-389232
- identifier: contractNumber
value: '5810000002'
stages:
- id: requestAck
label: Request Acknowledgement
stageStatus: IN_PROGRESS
mappedNotes: []
steps:
- id: requestAck.nbRequestReceived
label: New NB Request Received
stepStatus: COMPLETED
eventRef:
- a24d3d9f-200e-44d6-85e4-4b6cfbcb09c4
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: requestAck.draftContractCreation
label: Draft Contract Creation
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: requestAck.caseProcessing
label: Case Processing
stepStatus: COMPLETED
eventRef:
- a24d3d9f-200e-44d6-85e4-4b6cfbcb09c4
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments:
- '119299808'
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:43:19.000Z'
- id: agentValidation
label: Agent Validation
stageStatus: NOT_STARTED
mappedNotes: []
steps:
- id: agentValidation.valiatingAgentDetails
label: Validating Agent Details
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: true
instanceInfo:
identifier: A12345
label: Steve Smith
object: Agent
createdAt: '2024-07-15T22:43:19.000Z'
- id: agentValidation.preValidationRules
label: Pre Validation Rules
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: agentValidation.agentStatusValidation
label: Agent Status Validation
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:43:19.000Z'
- id: policyValidation
label: Policy Validation
stageStatus: NOT_STARTED
mappedNotes: []
steps:
- id: policyValidation.valiatingApplicationDetails
label: Validating Application Details
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: policyValidation.retrieveApplicationData
label: Retrieve Application Data
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: policyValidation.agentHierarchyValidation
label: Agent Hierarchy Validation
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:43:19.000Z'
- id: premiumProcessing
label: Premium Processing
stageStatus: NOT_STARTED
mappedNotes: []
steps:
- id: premiumProcessing.premiumProcessing
label: Premium Processing
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:43:19.000Z'
- id: requestCompletion
label: Request Completion
stageStatus: IN_PROGRESS
mappedNotes: []
steps:
- id: requestCompletion.LCContractIssued
label: Contract Issued
stepStatus: NOT_STARTED
stepResult: APPROVED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: requestCompletion.caseCompleted
label: Case Processing Completed
stepStatus: COMPLETED
eventRef:
- 46b7bb4f-1095-4dc1-af4c-ae777a06f71b
updatedAt: '2024-07-15T22:59:00.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:59:00.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:59:00.000Z'
parties: []
createdAt: '2024-07-15T22:43:19.000Z'
updatedAt: '2024-07-15T22:59:00.000Z'
systemUpdatedDt: '2024-07-15'
deleted: false
techExceptionStatus: ''
techExceptionCount: 5
'400':
description: Validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
/case/v2/cases/{caseId}:
get:
summary: Get Case Detail
tags:
- Case Instance
description: Retrieve the case instance details using the system identifier (caseId).
operationId: getCaseInstanceByIdV2
parameters:
- name: caseId
in: path
description: Case instance id
example: CA0000360227
required: true
schema:
type: string
responses:
'200':
description: Case details retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInstance'
example:
id: CA0000360227
templateId: b5664374-8724-43c8-846c-0f8fad7890fd
carrier: CarrierName_1
process: New Business
caseGroup: New Business
parentInstanceId: ''
correlationId: 96d5a484-78b2-4245-9588-d65e670d1c08
caseStatus: IN_PROGRESS
caseResult: ''
caseResultDetail: ''
primary: false
caseProcessingDetails:
- detailType: submissionDetails
properties:
- _id: submittedBy
value: MANUAL
- _id: submissionSource
value: Orion
linkDetails:
linkedCaseInstanceId: 0000028951
linkedReason: Identified by case management
processSubType: ANNUITY APPLICATION
policyNumber: '5810000002'
planCode: '900'
productName: ''
documents:
- id: '119299808'
name: NB Purchase w App
documentNumber: 11251004-M-199808
source: Source
url: https://example.com/doc-123
updatedAt: '2023-10-10T12:34:56Z'
fileType: NB Fix
documentUploadDate: '2023-10-10T12:34:56Z'
exceptions:
- id: '9989285'
status: RESOLVED
excptionRefId: NB.EM.068
exceptionType: Business Exception
category: ACH
reason: INCORRECT ACH INFORMATION PROVIDED
detailedReason: BANK NAME
updatedAt: '2024-07-15T22:47:54.000Z'
taskIdList:
- '9989286'
additionalData: {}
eventRef:
- 85d469a5-e5d9-40b3-b7c8-144bdf10ed0d
- 33cc35a5-c5fc-44ac-95a9-c910b2096f38
notes: []
tasks:
- label: ''
id: '9989286'
assignee: ''
status: COMPLETE
updatedAt: '2024-07-15T22:54:22.000Z'
createdAt: '2024-07-15T22:44:24.000Z'
taskType: Manual Check
taskName: Manual Check
queue: new_business
additionalData: {}
eventRef:
- 0da9f427-7bdd-4018-9cb4-160260a6f1c5
- 7d7766cd-452a-4cbe-bd37-d5490a16415b
- 99aca59e-a83f-4575-b1de-df2b35ccf83d
externalTaskId: '9989286'
notesIdList: []
- label: ''
id: '9989292'
assignee: ''
status: COMPLETE
updatedAt: '2024-07-15T22:56:19.000Z'
createdAt: '2024-07-15T22:50:24.000Z'
taskType: Checks Out
additionalData: {}
eventRef:
- 9db828ce-fea4-4896-a1e2-972971b08191
- bda9a2f6-b1a7-4ede-b543-660b5951d12c
externalTaskId: '9989292'
notesIdList: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
identifiers:
- identifier: documentNumber
value: 20240715-MAN-389232
- identifier: policyNumber
value: '5810000002'
- identifier: caseID
value: '9989283'
- identifier: businessKey
value: 20240715-MAN-389232
- identifier: contractNumber
value: '5810000002'
stages:
- id: requestAck
label: Request Acknowledgement
stageStatus: IN_PROGRESS
mappedNotes: []
steps:
- id: requestAck.nbRequestReceived
label: New NB Request Received
stepStatus: COMPLETED
eventRef:
- a24d3d9f-200e-44d6-85e4-4b6cfbcb09c4
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: requestAck.draftContractCreation
label: Draft Contract Creation
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: requestAck.caseProcessing
label: Case Processing
stepStatus: COMPLETED
eventRef:
- a24d3d9f-200e-44d6-85e4-4b6cfbcb09c4
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments:
- '119299808'
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:43:19.000Z'
- id: agentValidation
label: Agent Validation
stageStatus: NOT_STARTED
mappedNotes: []
steps:
- id: agentValidation.valiatingAgentDetails
label: Validating Agent Details
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: true
instanceInfo:
identifier: A12345
label: Steve Smith
object: Agent
createdAt: '2024-07-15T22:43:19.000Z'
- id: agentValidation.preValidationRules
label: Pre Validation Rules
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: agentValidation.agentStatusValidation
label: Agent Status Validation
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:43:19.000Z'
- id: policyValidation
label: Policy Validation
stageStatus: NOT_STARTED
mappedNotes: []
steps:
- id: policyValidation.valiatingApplicationDetails
label: Validating Application Details
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: policyValidation.retrieveApplicationData
label: Retrieve Application Data
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: policyValidation.agentHierarchyValidation
label: Agent Hierarchy Validation
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:43:19.000Z'
- id: premiumProcessing
label: Premium Processing
stageStatus: NOT_STARTED
mappedNotes: []
steps:
- id: premiumProcessing.premiumProcessing
label: Premium Processing
stepStatus: NOT_STARTED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:43:19.000Z'
- id: requestCompletion
label: Request Completion
stageStatus: IN_PROGRESS
mappedNotes: []
steps:
- id: requestCompletion.LCContractIssued
label: Contract Issued
stepStatus: NOT_STARTED
stepResult: APPROVED
eventRef: []
updatedAt: '2024-07-15T22:43:19.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:43:19.000Z'
- id: requestCompletion.caseCompleted
label: Case Processing Completed
stepStatus: COMPLETED
eventRef:
- 46b7bb4f-1095-4dc1-af4c-ae777a06f71b
updatedAt: '2024-07-15T22:59:00.000Z'
tasks: []
mappedTasks: []
mappedExceptions: []
mappedDocuments: []
mappedNotes: []
multiInstance: false
instanceInfo: {}
createdAt: '2024-07-15T22:59:00.000Z'
tasks: []
mappedTasks: []
createdAt: '2024-07-15T22:59:00.000Z'
parties: []
createdAt: '2024-07-15T22:43:19.000Z'
updatedAt: '2024-07-15T22:59:00.000Z'
systemUpdatedDt: '2024-07-15'
deleted: false
techExceptionStatus: ''
techExceptionCount: 5
'400':
description: Validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
/case/v2/cases:
post:
tags:
- Case Instance
summary: Create Case
description: Create or Find a Case for/By specified values
operationId: CreateCaseV2
requestBody:
description: Case details for creation
content:
application/json:
schema:
$ref: '#/components/schemas/CaseCreateRequestV2'
examples:
New Business:
value:
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
required: true
responses:
'200':
description: Case Created
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInstance'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
'401':
description: Authentication failed
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerErrorResponse'
components:
schemas:
ActivityFeedSearchRequest:
type: object
properties:
filters:
$ref: '#/components/schemas/ActivityFeedFilters'
pagination:
$ref: '#/components/schemas/ActivityFeedPagination'
sort:
$ref: '#/components/schemas/ActivityFeedSort'
ActivityFeedFilters:
type: object
properties:
entityType:
type: string
description: 'Type of entity to filter by (e.g. STAGE, STEP). When combined with includeHierarchicalEntities, feeds
whose
entity matches this type act as seeds; descendant feeds under those entities may be included.
'
example: STAGE
entityIds:
type: array
description: 'Entity ids to match (e.g. stage or step id). When includeHierarchicalEntities is true, feeds under
these
entities in the case hierarchy may also be returned.
'
items:
type: string
example:
- policyValidation
- policyValidation.childStep
instanceInfoIds:
type: array
description: 'Instance-info identifiers (e.g. from entityInstanceInfo on a step) used to narrow feeds; hierarchical
rules
apply when includeHierarchicalEntities is true.
'
items:
type: string
example:
- inst-search-cuke-60
includeHierarchicalEntities:
# --- truncated at 32 KB (182 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zinnia/refs/heads/main/openapi/zinnia-case-management-openapi.yml