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

# Case Management API

OpenAPI specification document.

```json
{"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\nentity matches this type act as seeds; descendant feeds under those entities may be included.\n","example":"STAGE"},"entityIds":{"type":"array","description":"Entity ids to match (e.g. stage or step id). When includeHierarchicalEntities is true, feeds under these\nentities in the case hierarchy may also be returned.\n","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\napply when includeHierarchicalEntities is true.\n","items":{"type":"string"},"example":["inst-search-cuke-60"]},"includeHierarchicalEntities":{"type":"boolean","default":false,"description":"When true, expands results to include descendant feeds in the activity hierarchy for the selected entity ids,\nentity type, or instance-info scope. When false, only directly matching feeds are considered before other filters.\n","example":true},"action":{"$ref":"#/components/schemas/ActivityFeedAction"},"startDate":{"type":"string","format":"date-time","description":"Start date for filtering activity feed records","example":"2025-12-29T00:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"End date for filtering activity feed records","example":"2025-12-29T23:59:59Z"}}},"ActivityFeedPagination":{"type":"object","properties":{"pageSize":{"type":"integer","minimum":1,"description":"Number of records per page","example":10},"pageNumber":{"type":"integer","minimum":1,"description":"Page number to retrieve","example":1}}},"ActivityFeedSort":{"type":"object","properties":{"order":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort order for activity feed records","example":"desc"}}},"ActivityFeedSearchResponse":{"type":"object","properties":{"caseId":{"type":"string","description":"Case ID for which activity feed was searched","example":"CA0000061736"},"feeds":{"type":"array","items":{"$ref":"#/components/schemas/ActivityFeedRecord"},"default":[]},"page":{"$ref":"#/components/schemas/ActivityFeedPageMetadata"}}},"ActivityFeedPageMetadata":{"type":"object","properties":{"pageSize":{"type":"integer","description":"Number of records per page","example":10},"pageNumber":{"type":"integer","description":"Current page number","example":1},"totalPages":{"type":"integer","description":"Total number of pages","example":1},"totalRecords":{"type":"integer","format":"int64","description":"Total number of records","example":3}}},"ActivityFeedRecord":{"type":"object","description":"Activity feed row returned by search (entity, action, changes, time, source).","properties":{"id":{"type":"string","description":"Unique identifier for the activity feed record","example":"9c0638a9-1bab-4553-8135-75a3cfd471b3"},"entity":{"$ref":"#/components/schemas/ActivityFeedEntityRef"},"action":{"$ref":"#/components/schemas/ActivityFeedAction"},"changes":{"type":"array","items":{"$ref":"#/components/schemas/ActivityFeedChange"}},"time":{"type":"string","format":"date-time","description":"Timestamp when the activity occurred","example":"2025-12-29T12:00:42Z"},"source":{"$ref":"#/components/schemas/ActivityFeedSource"}}},"ActivityFeedEntityRef":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ActivityFeedEntityType"},"id":{"type":"string","description":"ID of the entity","example":"policyValidation.childStep"},"label":{"type":"string","description":"Label of the entity","example":"Child Step"}}},"ActivityFeedEntityType":{"type":"string","enum":["TASK","STAGE","STEP","CASE","EXCEPTION","DOCUMENT"],"description":"Type of entity in the activity feed"},"ActivityFeedAction":{"type":"string","enum":["CREATED","STATUS_CHANGE","ASSIGNMENT","UNASSIGNMENT"],"description":"Type of action performed on the entity"},"ActivityFeedChange":{"type":"object","properties":{"field":{"type":"string","description":"Field that was changed","example":"status"},"from":{"type":"string","description":"Previous value of the field","example":""},"to":{"type":"string","description":"New value of the field","example":"NEW"}}},"ActivityFeedSource":{"type":"object","properties":{"type":{"type":"string","description":"Type of source that performed the action","example":"API"},"id":{"type":"string","description":"ID of the source","example":"7dfd65b3-4609-4fd9-a3f2-b6cbf9f4415f"},"performedBy":{"type":"string","description":"ID of the user who performed the action","example":"c6a7ab9f7dd84015a6552bfc5b366b77"}}},"TaskSearchCriteria":{"type":"object","properties":{"policyNumber":{"type":"string","description":"The policy number associated with the case.","example":"AU7654098"},"applicationType":{"type":"string","description":"The application type of the policy.","example":"Digital"},"process":{"type":"array","description":"A list of processes to filter the search results.","items":{"type":"string"},"example":["New Business"]}}},"DashboardStatsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"brokerDealerName"},"name":{"type":"string","example":"Example Broker"},"count":{"type":"integer","example":3990},"values":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"process"},"name":{"type":"string","example":"Process 1"},"count":{"type":"integer","example":3990},"values":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"caseStatus"},"name":{"type":"string","example":"EXCEPTION"},"count":{"type":"integer","example":2396}}}}}}}}}},"totalElements":{"type":"integer","example":4856}}},"DashboardStatsRequest":{"type":"object","properties":{"filter":{"$ref":"#/components/schemas/DashboardSearchRequest"},"groupBy":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","enum":["brokerDealerName","carrier","caseStatus","processSubType","policyNumber","process","productName","expectionCategory","openStages","updatedAt","createdAt"]}}}},"DashboardSearchRequest":{"type":"object","properties":{"policyNumber":{"type":"string","description":"The policy number associated with the case.","example":"AU7654098"},"applicationType":{"type":"string","description":"The application type of the policy.","example":"Digital"},"process":{"type":"array","description":"A list of processes to filter the search results.","items":{"type":"string"},"example":["New Business"]},"carrier":{"type":"array","description":"A list of carrier to filter the search results.","items":{"type":"string"},"example":["Carrier 1","Carrier 2"]},"requestSubType":{"type":"array","description":"A list of request subtypes to filter the search results.","items":{"type":"string"},"example":["INTERNAL CONVERSION"]},"productName":{"type":"array","description":"A list of product names to filter the search results.","items":{"type":"string"},"example":["TOTAL INTEREST ANUITY APPLICATION"]},"caseStatus":{"type":"array","description":"A list of case statuses to filter the search results.","items":{"type":"string"},"example":["Exception"]},"createdDateStart":{"type":"string","description":"The start date for the creation date range filter.","format":"date-time"},"createdDateEnd":{"type":"string","format":"date-time","description":"The end date for the creation date range filter."},"updatedDateStart":{"type":"string","format":"date-time","description":"The start date for the updated date range filter."},"updatedDateEnd":{"type":"string","format":"date-time","description":"The end date for the updated date range filter."},"brokerDealerName":{"type":"array","description":"A list of broker dealer names to filter the search results.","items":{"type":"string"},"example":["Broker 1","Broker 2"]}}},"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"}}},"TaskDetailById":{"allOf":[{"$ref":"#/components/schemas/TaskListSummary"}],"type":"object","properties":{"exceptions":{"type":"array","items":{"type":"string"},"example":[]},"schema":{"type":"object","example":{"schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"suitabilityStatus":{"type":"string"},"notes":{"type":"array","items":{"type":"object","properties":{"submissionDate":{"type":"string"},"commentCategory":{"type":"string"},"commentSubCategory":{"type":"string"},"commentDetail":{"type":"string"},"comment":{"type":"string"},"description":{"type":"string"},"createdDate":{"type":"string"},"createBy":{"type":"string"},"noteId":{"type":"integer"}},"required":["submissionDate","commentCategory","commentSubCategory","commentDetail","comment","description","createdDate","createBy","noteId"]}}},"required":["suitabilityStatus"]}},"data":{"oneOf":[{"$ref":"#/components/schemas/SuitabilityDetails"},{"$ref":"#/components/schemas/AgentInformationDetails"}]}}},"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"}}}},"ExceptionInstanceForTask":{"type":"object","properties":{"id":{"type":"string","example":"12324"},"status":{"type":"string","example":"New"},"category":{"type":"string","example":"Agent"},"reason":{"type":"string","example":"Suitability requested"},"detailedReason":{"type":"string","example":"Suitability requested from External client"},"updatedAt":{"type":"string","example":"09-April-2023"}}},"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"}}},"AdditionalDataInstance":{"type":"object","additionalProperties":{"type":"string"}},"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."}}},"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."}}},"ValidationResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":400},"timestamp":{"type":"string","format":"date-time"},"errorId":{"type":"string","example":"a4a57ed0-2c1b-4922-9959-3b85dd8a96d3"},"message":{"type":"string","example":"Template validation fails with errors"},"error":{"type":"array","items":{"type":"string","example":"Stage [0] Step [1] mandatory attribute label missing"}}}},"ResourceNotFoundResponse":{"type":"object","properties":{"timestamp":{"type":"string"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"}},"example":{"timestamp":"1681395423438","status":404,"error":"Not Found","message":"resource not found for provided input","path":"/case/v1/path/schema/Test"}},"AccessDeniedResponse":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"}},"example":{"timestamp":1681395423438,"status":403,"error":"Access Denied","message":"User is not authorized for the carrier : CarrierName_2","path":"API Path"}},"UnauthorizedResponse":{"type":"object","properties":{"timestamp":{"type":"integer"},"status":{"type":"integer"},"error":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"}},"example":{"timestamp":1721395364487,"status":401,"error":"Unauthorized","message":"Unauthorized","path":"API Path"}},"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."}}},"TaskListResponse":{"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskListSummary"}},"count":{"type":"integer","format":"int32","example":5},"offset":{"type":"integer","format":"int32","example":4},"limit":{"type":"integer","format":"int32","example":5},"total":{"type":"integer","format":"int32","example":13},"status":{"type":"integer","format":"int32","example":200},"message":{"type":"string","example":"Successfully retrieved data!"}}},"TaskListSummary":{"type":"object","properties":{"id":{"type":"string","example":"TA000000000033"},"caseId":{"type":"string","example":"CA0000042426"},"taskType":{"type":"string","example":"Suitabilty"},"taskName":{"type":"string","example":"Suitability Review"},"status":{"type":"string","example":"NEW"},"carrier":{"type":"string","example":"CarrierName_1"},"process":{"type":"string","example":"New Business"},"assignee":{"type":"string","default":"","example":"anurag.chaudhary@zinnia.com"},"queue":{"type":"string","default":"","example":"ADMIN_QUEUE"},"priority":{"type":"string","default":"","example":"HIGH"},"slaDue":{"type":"string","example":"2023-08-12T11:27:19.232Z"},"createdAt":{"type":"string","example":"2023-08-08T11:27:19.232Z"},"updatedAt":{"type":"string","example":"2023-08-08T11:27:19.232Z"}}},"SuitabilityDetails":{"type":"object","properties":{"suitabiltyQuestion":{"type":"string","example":"Suitability question"},"suitabilityStatus":{"type":"string","example":"Accepted"},"followUpDate":{"type":"string","example":"2/17/2024 12:00:00 AM"},"notes":{"type":"array","items":{"type":"object","properties":{"submissionDate":{"type":"string","example":"2/16/2024 2:19:16 AM"},"commentCategory":{"type":"string","example":"1st Call Out Successful"},"commentSubCategory":{"type":"string","example":"Ceding Carrier will not Release Info"},"commentDetail":{"type":"string","example":"Contact Agent"},"comment":{"type":"string","example":"task note updated"},"description":{"type":"string","example":"task note updated"},"createdDate":{"type":"string","example":"2/16/2024 02:19:16 AM"},"createBy":{"type":"string","example":"SBDQ36"},"noteId":{"type":"integer","format":"int32","example":9651167}}}}}},"AgentInformationDetails":{"type":"object","properties":{"transmittalInformation":{"type":"array","items":{"type":"object","properties":{"representativeName":{"type":"string","example":"Sean Battin"},"brokerName":{"type":"string","example":"Lincoln"},"representativeExternalIdNumber":{"type":"integer","example":8068116963},"dateWritten":{"type":"string","example":"10/20/2021"},"clientName":{"type":"string","example":"Thomas Little"},"stateWritten":{"type":"string","example":"Pennsylvania"}}}},"specialInstructions":{"type":"array","items":{"type":"object","properties":{"userName":{"type":"string","example":"CONAEHA"},"submissionDate":{"type":"string","example":"8/24/2023 2:49"},"comment":{"type":"string","example":"Pa appointment approved in mcs"}}}}}},"CaseListInstanceResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CaseInstanceSummary"}},"count":{"type":"integer","format":"int32","example":5},"offset":{"type":"integer","format":"int32","example":4},"limit":{"type":"integer","format":"int32","example":5},"total":{"type":"integer","format":"int32","example":13},"status":{"type":"integer","format":"int32","example":200},"message":{"type":"string","example":"Successfully retrieved data!"}}},"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"}}},"TaskLinkInstanceList":{"type":"array","items":{"$ref":"#/components/schemas/TaskLinkInstance"}},"ExceptionListInstance":{"type":"array","items":{"$ref":"#/components/schemas/ExceptionInstance"}},"ExceptionListInstanceForTask":{"type":"array","items":{"$ref":"#/components/schemas/ExceptionInstanceForTask"}},"DocumentListInstance":{"type":"array","items":{"$ref":"#/components/schemas/DocumentInstance"}},"StageListInstance":{"type":"array","items":{"$ref":"#/components/schemas/StageInstance"}},"NoteListInstance":{"type":"array","items":{"$ref":"#/components/schemas/NoteInstance"}},"EventTimeLineInstance":{"type":"array","items":{"$ref":"#/components/schemas/EventInstance"}},"EventInstance":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the event instance."},"source":{"type":"string"},"eventName":{"type":"string","description":"The name of the event that occurred."},"eventGroup":{"type":"string","description":"The group to which this event belongs."},"eventTs":{"type":"string","format":"date-time","description":"The timestamp when the event occurred."},"correlationId":{"type":"string","description":"An identifier used to correlate related cases."},"payload":{"type":"string","description":"The payload of the event, typically containing detailed information."},"identifiers":{"type":"array","items":{"type":"object","description":"A list of identifiers associated with the event.","properties":{"identifier":{"type":"string","description":"The type of identifier."},"value":{"type":"string","description":"The value of the identifier."}}}}}},"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."}}},"TaskListSearchCriteria":{"allOf":[{"$ref":"#/components/schemas/TaskSearchCriteria"},{"type":"object","properties":{"sortBy":{"type":"string","enum":["updatedAt","createdAt"],"example":"createdAt"},"sortDirection":{"type":"string","enum":["asc","desc"]},"offset":{"type":"integer","format":"int32","example":2},"limit":{"type":"integer","format":"int32","example":20}}}]},"CasePageSearchCriteria":{"allOf":[{"$ref":"#/components/schemas/CaseSearchCriteria"},{"type":"object","properties":{"sortBy":{"type":"string","description":"The field by which to sort the search results.","enum":["updatedAt","createdAt","carrier","process","caseStatus"],"example":"createdAt"},"sortDirection":{"type":"string","description":"The direction to sort the search results, either ascending (asc) or descending (desc).","enum":["asc","desc"]},"offset":{"type":"integer","format":"int32","description":"The offset for pagination, indicating the starting point for the results.","example":2},"limit":{"type":"integer","format":"int32","description":"The maximum number of results to return.","example":20}}}]},"LabelConfigModel":{"type":"object","properties":{"key":{"type":"string","description":"Unique key for the label","example":"process"},"value":{"type":"string","description":"Value associated with the label","example":"LOAN PAYMENT"},"displayValue":{"type":"string","description":"Display value of the label","example":"ONE-TIME LOAN PAYMENT"}},"required":["key","value","displayValue"]},"LabelConfigResponse":{"type":"object","properties":{"labelconfigs":{"type":"array","items":{"$ref":"#/components/schemas/LabelConfigModel"}}}},"CaseSearchCriteria":{"type":"object","properties":{"policyNumber":{"type":"string","description":"The policy number associated with the case.","example":"AU7654098"},"ssn":{"type":"string","description":"The ssn associated with the case.","example":"SSN-UTK-0078"},"ownerFirstName":{"type":"string","description":"The first name of the policy owner.","example":"Utkarsh"},"ownerLastName":{"type":"string","description":"The last name of the policy owner.","example":"Jain"},"caseIds":{"type":"array","items":{"type":"string","description":"A list of case IDs to filter the search results."},"example":["NB-12345678"]},"applicationType":{"type":"string","description":"The application type of the policy.","example":"Digital"},"isIncludeSecondary":{"type":"boolean","description":"Indicates whether to include secondary cases in the search results.","default":false,"example":false},"process":{"type":"array","description":"A list of processes to filter the search results.","items":{"type":"string"},"example":["New Business"]},"carrier":{"type":"string","description":"The carrier associated with the case.","example":"CarrierName_1"},"requestSubType":{"type":"array","description":"A list of request subtypes to filter the search results.","items":{"type":"string"},"example":["INTERNAL CONVERSION"]},"productName":{"type":"array","description":"A list of product names to filter the search results.","items":{"type":"string"},"example":["TOTAL INTEREST ANUITY APPLICATION"]},"caseStatus":{"type":"array","description":"A list of case statuses to filter the search results.","items":{"type":"string"},"example":["Exception"]},"notInCaseStatus":{"type":"array","description":"A list of case statuses to exclude from the search results.","items":{"type":"string"},"example":["Exception"]},"createdDateStart":{"type":"string","description":"The start date for the creation date range filter.","format":"date-time"},"createdDateEnd":{"type":"string","format":"date-time","description":"The end date for the creation date range filter."},"updatedDateStart":{"type":"string","format":"date-time","description":"The start date for the updated date range filter."},"updatedDateEnd":{"type":"string","format":"date-time","description":"The end date for the updated date range filter."},"agentFirstName":{"type":"string","description":"The first name of the agent associated with the case.","example":"JOHN WESLY"},"agentLastName":{"type":"string","description":"The last name of the agent associated with the case.","example":"BEVAN"},"brokerDealerName":{"type":"string","description":"The name of the broker-dealer associated with the case.","example":"JP MORGAN SECURITIES LLC"},"identifiers":{"type":"array","description":"A list of case identifier to search case.","items":{"type":"object","properties":{"identifier":{"type":"string","description":"identifier name","example":"documentNumber"},"value":{"type":"string","description":"identifier value","example":"20240813-EM-964334"}}},"example":[{"identifier":"documentNumber","value":"20240813-EM-964334"}]},"exceptions":{"type":"array","description":"A list of exception filters to narrow case search results.","items":{"$ref":"#/components/schemas/ExceptionFilterModel"}}}},"ExceptionFilterModel":{"type":"object","properties":{"exceptionType":{"type":"string","description":"Exception type filter."},"status":{"type":"string","description":"Exception status filter."},"category":{"type":"string","description":"Exception category filter."}}},"CaseStatsSearchCriteria":{"allOf":[{"$ref":"#/components/schemas/CaseSearchCriteria"},{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string","enum":["caseStatus","process"]}}}}]},"RefDataSearchCriteria":{"allOf":[{"$ref":"#/components/schemas/CaseSearchCriteria"},{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string","enum":["requestSubType","productName"]}}}}]},"TaskSearchModel":{"type":"object","properties":{"process":{"type":"string","description":"A list of processes to filter the search results."},"carriers":{"type":"array","description":"The carrier associated with the task.","items":{"type":"string"}},"taskName":{"type":"string","description":"Name of the task."},"taskType":{"type":"string","description":"Task Type"},"taskDetails":{"type":"string","description":"Associated Task Details"},"statuses":{"type":"array","description":"A list of task statuses to filter the search results.","items":{"type":"string"}},"queues":{"type":"array","description":"A list of queue associated with the task to filter the search results.","items":{"type":"string"}},"assigneePartyId":{"type":"string","description":"Assignee Party task filter"},"caseId":{"type":"string"},"escalated":{"type":"boolean","description":"Escalated or Not escalated task filter"},"carrier":{"type":"string"},"status":{"type":"string"},"queue":{"type":"string"},"taskCreatedOn":{"type":"string","description":"The created date for the task range filter.","format":"date-time"},"scheduledDate":{"type":"string","description":"The scheduled date filter.","format":"date-time"},"scheduledDateStart":{"type":"string","description":"The scheduled start date for the scheduled date range filter.","format":"date-time"},"scheduledDateEnd":{"type":"string","description":"The scheduled end date for the scheduled date range filter.","format":"date-time"},"ownerFirstName":{"type":"string","description":"The first name of the policy owner.","example":"Utkarsh"},"ownerLastName":{"type":"string","description":"The last name of the policy owner.","example":"Jain"},"agentFirstName":{"type":"string","description":"The first name of the agent associated with the case.","example":"JOHN WESLY"},"agentLastName":{"type":"string","description":"The last name of the agent associated with the case.","example":"BEVAN"},"assigneeDetails":{"description":"Assignee search criteria. When provided in task search, the service resolves matching users and filters tasks by their assignee partyIds.","type":"object","allOf":[{"$ref":"#/components/schemas/AssigneeDetails"}]},"identifiers":{"type":"array","description":"A list of case identifier to search task.","items":{"$ref":"#/components/schemas/CaseIdentifierModel"}},"sortBy":{"type":"string","description":"The field by which to sort the search results."},"sortDirection":{"type":"string","description":"The direction to sort the search results, either ascending (asc) or descending (desc)."},"offset":{"type":"string","description":"The offset for pagination, indicating the starting point for the results."},"pageSize":{"type":"string","description":"The maximum number of results to return."}}},"CaseIdentifierModel":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"CaseStatsSearchResponse":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":120},"stats":{"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","example":"caseType"},"counts":{"type":"object","properties":{"label":{"type":"string","example":"New Business"},"value":{"type":"integer","format":"int32","example":32}}}}}}}},"EventDetailInstance":{"type":"object","properties":{"id":{"type":"string","example":"2ad51ecf-9923-437f-a6f0-70968e464cdb"},"correlationid":{"type":"string","example":"20230314-M-101161"},"source":{"type":"string","example":"ONBASE"},"specversion":{"type":"string","example":"V1"},"type":{"type":"string","example":"AckNBApplicationValidation"},"carrier":{"type":"string","example":"CarrierName_1"},"datacontenttype":{"type":"string","example":"application/json"},"time":{"type":"string","format":"date-time"},"data":{"type":"string","example":"{\"businessKey\":\"20230314-M-101161\",\"contractNum\":\"573005409\",\"user\":\"ECMagent\",\"CheckReceived\":\"Success\",\"receivedDateTime\":\"2023-03-14T11:06:34.6979232-05:00\",\"CorrelationID\":\"f3e98d05-1d9e-433f-b315-3b1eb0d03ed3\"}"},"identifier":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}}},"CaseCreateRequest":{"type":"object","properties":{"carrier":{"type":"string","description":"The carrier associated with the case.","example":"CarrierName_1"},"process":{"type":"string","description":"The process associated with the case.","example":"New Business"},"correlationId":{"type":"string","description":"The correlationId associated with the case.","example":"f3e98d05-1d9e-433f-b315-3b1eb0d03ed3"},"processSubType":{"type":"string","description":"A subtype of the process for the case.","example":"INCOMING_TRANSFER"},"identifiers":{"type":"array","description":"A list of identifiers associated with the case.","items":{"$ref":"#/components/schemas/IdentifierInstance"}}}},"FormMetadataRequest":{"type":"object","properties":{"carrier":{"type":"string","description":"Carrier for the metadata.","example":"CarrierName_1"},"process":{"type":"string","description":"Process for the metadata","example":"New Business"},"taskType":{"type":"string","description":"Task type for the metadata","example":"SUITABILITY_REVIEW"},"formSchema":{"type":"object","additionalProperties":true,"description":"Additional data related to the task","example":{}},"uiSchema":{"type":"object","additionalProperties":true,"description":"Additional data related to the task","example":{}},"schemaContent":{"type":"object","additionalProperties":true,"description":"Additional data related to the task","example":{}}}},"CaseCreateRequestV2":{"type":"object","properties":{"correlationid":{"type":"string","description":"The correlationId associated with the case.","example":"218d8992-3783-42ac-b59a-66cbc36adaab"},"source":{"type":"string","description":"The source associated with the case.","example":"Zinnia.OnBase"},"carrier":{"type":"string","description":"The carrier associated with the case.","example":"CarrierName_1"},"specversion":{"type":"string","description":"The specversion associated with the case.","example":"V1"},"type":{"type":"string","description":"The type associated with the case.","example":"CaseCreated"},"datacontenttype":{"type":"string","description":"The datacontenttype associated with the case.","example":"application/json"},"dataschema":{"type":"string","description":"The dataschema associated with the case.","example":"jsondata"},"subject":{"type":"string","description":"The subject associated with the case.","example":"subject"},"sourcelocator":{"type":"string","description":"The sourcelocator associated with the case.","example":"sourcelocator"},"data":{"type":"string","description":"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\"}]"},"dataBase64":{"type":"string","description":"The dataBase64 associated with the case.","example":"jsondata"},"identifiers":{"type":"array","description":"A list of identifiers associated with the case.","items":{"$ref":"#/components/schemas/IdentifierInstance"}}}},"CaseEscalationRequest":{"type":"object","required":["escalated"],"properties":{"escalated":{"type":"boolean","description":"Whether the case should be escalated or de-escalated","example":true},"reason":{"type":"string","description":"The reason for case escalation or de-escalation","example":"SLA Risk"},"source":{"type":"string","description":"The source for case escalation or de-escalation","example":"Call Center"}}},"RenewalTaskData":{"type":"object","properties":{"documentNumber":{"type":"string","example":"20230405-M-350385"},"source":{"type":"string","example":"SupportTool"},"contractNum":{"type":"string","example":"571016565"},"userId":{"type":"string","example":"abc121243"},"onbaseCaseId":{"type":"string","example":"9280926"},"productName":{"type":"string","example":"CarrierName_1MUTUAL STABLE VOYAGE"},"clientCode":{"type":"string","example":"CarrierName_1"},"taskType":{"type":"string","example":"RenewalTransfer"},"subsequentGuaranteePeriod":{"type":"string","example":"3Year"},"goodOrderDate":{"type":"string","format":"date-time"},"renewalRequestSignDate":{"type":"string","format":"date-time"},"ownerInformation":{"type":"array","items":{"$ref":"#/components/schemas/OwnerInformation"}},"documentReceivedDate":{"type":"string","format":"date-time"}}},"WithdrawalTaskData":{"type":"object","properties":{"documentNumber":{"type":"string","example":"20230405-M-350385"},"source":{"type":"string","example":"DigitalPortal"},"contractNum":{"type":"string","example":"571016565"},"userId":{"type":"string","example":"abc121243"},"onbaseCaseId":{"type":"string","example":"9280926"},"clientCode":{"type":"string","example":"CarrierName_2"},"incomingFaxNumber":{"type":"string","example":""},"sysMailFromAddress":{"type":"string","example":""},"agentEmailAddress":{"type":"string","example":""},"taskType":{"type":"string","example":"WithdrawalTask"},"formRequest":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormRequest"}]}}},"FormRequest":{"type":"object","properties":{"formSource":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormSource"}]},"formData":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormData"}]},"formProgram":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormProgram"}]},"formParty":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormParty"}]},"formDistribution":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormDistribution"}]},"formDisbursement":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormDisbursement"}]},"formRestriction":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormRestriction"}]},"formTaxWithholding":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormTaxWithholding"}]},"formTpaAuthorization":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormTpaAuthorization"}]},"formFullSurrenderAck":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormFullSurrenderAck"}]},"formTaxIdCertificate":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormTaxIdCertificate"}]},"formSignature":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormSignature"}]},"formLoan":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormLoan"}]},"formSpecialInstruction":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormSpecialInstruction"}]},"formIrsData":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FormIrsData"}]}}},"FormSource":{"type":"object","properties":{"businessKey":{"type":"string","example":"20230712-EM-786626"},"channel":{"type":"object","properties":{"text":{"type":"string","example":"EMAIL","enum":["MAIL","FAX","MAVRO","EMAIL","EXL","UNIFIED_WEB"]}}},"cutOffTimeExpireInd":{"type":"boolean","example":true},"formsDBId":{"type":"string","example":"abc121243"},"receivedDate":{"type":"string","example":"2023-07-12"},"receivedDateTime":{"type":"string","example":"2023-07-11T16:51:19-05:00"},"sourceSysId":{"type":"string","example":"ONBASE"},"unstructuredFormInd":{"type":"boolean","example":true}}},"FormData":{"type":"object","properties":{"formExtName":{"type":"string","example":"ANNUITY CONTRACT DIGITAL WD V1"},"metaData":{"type":"object","oneOf":[{"$ref":"#/components/schemas/MetaData"}]}}},"FormProgram":{"type":"object","properties":{"clientCode":{"type":"string","example":"CarrierName_2"},"contractNumber":{"type":"string","example":"5450009139"},"withdrawType":{"type":"object","properties":{"text":{"type":"string","example":"NET","enum":["GROSS","NET"]}}},"amountQualifierType":{"type":"string","example":"NET","enum":["GROSS","NET"]},"program":{"type":"object","properties":{"text":{"type":"string","example":"Withdrawal","enum":["Withdrawal","Systematic Withdrawal"]}}},"programType":{"type":"object","properties":{"text":{"type":"string","example":"Full Surrender","enum":["impossible","Full","Partial","Total Free Amt","GMWB","RMD","SSW","Full Surrender","Withdrawal","TotalFreeAmt","GrossWithdrawal","NetWithdrawal","LAP"]}}},"programSubType":{"type":"object","properties":{"text":{"type":"string","example":"Dollar","enum":["Default","Specific","Dollar","Percentage","Earning Only","Prorata","MaxFree","Maximum Free","Renewal_GuaranteeWD","Pre Tax,After Tax","FixDollar","AnnualFree","Total Free Withdrawal","PercentofAcctValue","InterestEarningDividendsGains","Pecking Order","FixPeriod","GMWB","IRC72TorQ","Dollar Liquidity Last","Auto","Percent Liquidity First","Dollar Liquidity First","Percent Liquidity Last","Prorata New Money"]}}},"programFrequency":{"type":"string","example":"Default","enum":["Default","Annually","BiMonthly","Monthly","QUARTERLY","SemiAnnually"]},"rollover":{"type":"string","example":"PayMe","enum":["PayMe","Partial","Entire","None"]},"rmd":{"type":"string","example":"CustomerProvideAmt","enum":["CustomerProvideAmt","IRCJointLifeNonRecalc","IRCJointLifeAgeRecalc","IRCSingleLifeNonRecalc"]},"programAmount":{"type":"object","properties":{"text":{"type":"string","example":"100"},"amountType":{"type":"string","example":"DOLLAR","enum":["DOLLAR","PERCENT"]}}},"partialAmount":{"type":"object","properties":{"text":{"type":"string","example":""},"amountType":{"type":"string","example":"DOLLAR","enum":["DOLLAR","PERCENT"]}}},"partialPercent":{"type":"object","properties":{"text":{"type":"string","example":""},"amountType":{"type":"string","example":"PERCENT","enum":["DOLLAR","PERCENT"]}}},"partialGrossAmount":{"type":"object","properties":{"text":{"type":"string","example":""},"amountType":{"type":"string","example":"DOLLAR","enum":["DOLLAR","PERCENT"]}}},"partialNetAmount":{"type":"object","properties":{"text":{"type":"string","example":""},"amountType":{"type":"string","example":"DOLLAR","enum":["DOLLAR","PERCENT"]}}},"processRequestType":{"type":"string","example":"IMMED","enum":["IMMED","NOCDSC","AS_OF_DATE"]},"isValidAsOfDate":{"type":"boolean","example":true},"accountCloseReason":{"type":"object","properties":{"text":{"type":"string","example":"SURRENDER","enum":["SURRENDER","CONTRACT_ATTACH","CONTRACT_LOST"]}}},"programSubTypeOptions":{"type":"string","example":""},"asOfDate":{"type":"object","properties":{"text":{"type":"string","example":""}}}}},"FormParty":{"type":"object","properties":{"parties":{"type":"array","items":{"$ref":"#/components/schemas/Party"}}}},"FormDistribution":{"type":"object","properties":{"moneyType":{"type":"object","properties":{"text":{"type":"string","example":"Prorata"}}},"distributionType":{"type":"string","example":""},"oneYearRenewalGurantee":{"type":"string","example":""},"funds":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Fund"}]}}},"FormDisbursement":{"type":"object","properties":{"paymentMethod":{"type":"object","properties":{"text":{"type":"string","example":"Check"}}},"paymentMailType":{"type":"object","properties":{"text":{"type":"string","example":""}}},"bank":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Bank"}]},"paymentToBrokerageAccount":{"type":"boolean","example":true},"payeeType":{"type":"string","example":"OWNER"}}},"FormRestriction":{"type":"object","properties":{"restrictions":{"type":"object","properties":{"text":{"type":"string","example":""}}},"hardship":{"type":"object","properties":{"text":{"type":"string","example":""}}},"emergency":{"type":"string","example":""}}},"FormTaxWithholding":{"type":"object","properties":{"taxWithholding":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholding"}}}},"FormTpaAuthorization":{"type":"object","properties":{"isAuthorization":{"type":"object","properties":{"text":{"type":"string","example":""}}},"isAgreementAttached":{"type":"object","properties":{"text":{"type":"string","example":"No"}}},"signOf":{"type":"object","properties":{"text":{"type":"string","example":""}}},"signature":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Sign"}]}}},"FormFullSurrenderAck":{"type":"object","properties":{"isFinancialProfessionAck":{"type":"object","properties":{"text":{"type":"string","example":""}}},"signature":{"type":"array","items":{"$ref":"#/components/schemas/Sign"}}}},"FormTaxIdCertificate":{"type":"object","properties":{"signatures":{"type":"array","items":{"$ref":"#/components/schemas/Sign"}}}},"FormSignature":{"type":"object","properties":{"isSpousalConsentRequired":{"type":"boolean","example":true},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/Sign"}}}},"FormLoan":{"type":"object","properties":{"isLoanAck":{"type":"object","properties":{"text":{"type":"string","example":"false"}}}}},"FormSpecialInstruction":{"type":"object","properties":{"specialInstructionPresent":{"type":"object","properties":{"text":{"type":"string","example":""}}}}},"FormIrsData":{"type":"object","properties":{"irsApplicable":{"type":"boolean","example":true},"irsSpecified":{"type":"boolean","example":true},"formParty":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Party"}]},"irsTaxWithholding":{"type":"array","items":{"$ref":"#/components/schemas/TaxWithholding"}},"irsSignature":{"type":"boolean","example":true}}},"TaxWithholding":{"type":"object","properties":{"place":{"type":"object","properties":{"text":{"type":"string","example":"Federal"}}},"type":{"type":"object","properties":{"text":{"type":"string","example":"No Tax Withholding"}}},"amount":{"type":"object","properties":{"text":{"type":"string","example":"0"},"amountType":{"type":"string","example":"DOLLAR","enum":["DOLLAR","PERCENT"]}}},"filingStatus":{"type":"object","properties":{"text":{"type":"string","example":""}}},"exemption":{"type":"object","properties":{"text":{"type":"string","example":""}}}}},"Party":{"type":"object","properties":{"partyRoleType":{"type":"string","example":"OWNER","enum":["OWNER","ANNUITANT","ROLLOVER_PAYEE","PAYEE","JOINT_OWNER"]},"firstName":{"type":"string","example":"JAMES"},"middleName":{"type":"string","example":"C"},"lastName":{"type":"string","example":"FORD"},"fullName":{"type":"string","example":"JAMES C FORD"},"suffix":{"type":"string","example":"1"},"dob":{"type":"string","example":""},"taxId":{"type":"string","example":"572621420"},"email":{"type":"string","example":""},"employer":{"type":"string","example":""},"maritalStatus":{"type":"object","properties":{"text":{"type":"string","example":"Single","enum":["Single","Married","Widowed"]}}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}}}},"Address":{"type":"object","properties":{"addressLine1":{"type":"string","example":"560 calle de la sierra"},"addressLine2":{"type":"string","example":""},"addressLine3":{"type":"string","example":""},"addressLine4":{"type":"string","example":""},"addressType":{"type":"string","example":"Default","enum":["Default","Mailing","SADD","HADD","BADD"]},"city":{"type":"string","example":"el cajon"},"country":{"type":"string","example":""},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":"92019-1241"},"zipPlusFour":{"type":"string","example":""}}},"Phone":{"type":"object","properties":{"phoneCountry":{"type":"string","example":"US"},"phoneNumber":{"type":"string","example":"6192001466"},"phoneTypeDesc":{"type":"string","example":"Default"},"phoneType":{"properties":{"text":{"type":"string","example":"Owner_Phone_Day","enum":["Owner_Phone_Day","Owner_Phone_Home"]}}}}},"OwnerInformation":{"type":"object","properties":{"fullName":{"type":"string","example":"TestLast"},"type":{"type":"string","example":"Owner"},"mail":{"type":"string","example":"abc@test.com"},"signature":{"$ref":"#/components/schemas/Signature"}}},"Signature":{"type":"object","properties":{"signaturePresent":{"type":"string","example":"Yes"},"type":{"type":"string","example":"Owner"},"isValidDate":{"type":"boolean","example":true},"signDate":{"type":"string","format":"date"},"name":{"type":"string","example":"TestLast"},"title":{"type":"string","example":"Trustee"}}},"Bank":{"type":"object","properties":{"accountNumber":{"type":"string","example":""},"accountType":{"type":"object","properties":{"text":{"type":"string","example":"Checking"}}},"bankContactPerson":{"type":"string","example":""},"bankFurtherCreditAccount":{"type":"string","example":""},"bankFurtherCreditName":{"type":"string","example":"DEFAULT"},"bankInfoCompleteInd":{"type":"string","example":""},"bankLocation":{"type":"string","example":""},"bankName":{"type":"string","example":""},"bankPhone":{"type":"string","example":""},"nameOnBankAccount":{"type":"string","example":""},"routingNumber":{"type":"string","example":""}}},"Sign":{"type":"object","properties":{"isSigned":{"type":"boolean","example":true},"signDate":{"type":"object","properties":{"text":{"type":"string","example":"2023-05-25"}}},"signExtension":{"type":"object"},"signName":{"type":"string","example":""},"signOtherTitle":{"type":"string","example":""},"signTitle":{"type":"object","properties":{"text":{"type":"string","example":""}}},"signTitles":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":""}}}},"signType":{"type":"object","properties":{"text":{"type":"string","example":"OWNER","enum":["OWNER","JOINT_OWNER","SPOUSE,NOTARY"]}}},"spousalConsent":{"type":"object","properties":{"text":{"type":"string","example":""}}}}},"MetaData":{"type":"object","properties":{"formId":{"type":"integer","example":37825},"formNumber":{"type":"string","example":""},"formType":{"type":"string","example":"ANNUITY CONTRACT DIGITAL WD V1"}}},"Fund":{"type":"object","properties":{"amount":{"type":"object","properties":{"text":{"type":"string","example":"122"},"amountType":{"type":"string","example":"DOLLAR","enum":["DOLLAR","PERCENT"]}}},"fundCode":{"type":"string","example":"056HJ0A"},"fundName":{"type":"string","example":"Fixed"}}},"TaskCreateRequest":{"type":"object","properties":{"taskType":{"type":"string","example":"RenewalTask"},"carrier":{"type":"string","example":"CarrierName_1"},"data":{"oneOf":[{"$ref":"#/components/schemas/RenewalTaskData"},{"$ref":"#/components/schemas/DummyTaskData"},{"$ref":"#/components/schemas/WithdrawalTaskData"}]}}},"TaskUpdateRequest":{"type":"object","properties":{"taskType":{"type":"string","example":"WithdrawalTask"},"carrier":{"type":"string","example":"CarrierName_2"},"status":{"type":"string","example":"DRAFT"},"data":{"oneOf":[{"$ref":"#/components/schemas/WithdrawalTaskData"},{"$ref":"#/components/schemas/DummyTaskData"}]}}},"TaskSummary":{"type":"object","properties":{"taskId":{"type":"string","format":"23432-234234-324234-5345434"},"caseId":{"type":"string","format":"34545-543453-323223-534522"},"taskType":{"type":"string","example":"RenewalTask"},"status":{"type":"string","example":"Pending"},"source":{"type":"string","example":"SupportTool"},"carrier":{"type":"string","example":"CarrierName_1"},"assignedTo":{"type":"string","example":"operator-3"},"createdDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string","example":"operator-1"},"updatedDate":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","example":"operator-2"}}},"TaskSummaryList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskSummary"}}}},"ReferenceDataResponse":{"type":"object","properties":{"referenceData":{"type":"object","properties":{"requestSubType":{"type":"array","items":{"type":"string","example":"INTERNAL CONVERSION"}},"productName":{"type":"array","items":{"type":"string","example":"TOTAL INTEREST ANUITY APPLICATION"}}}}}},"TaskInstance":{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/RenewalTaskData"},{"$ref":"#/components/schemas/DummyTaskData"}]}},"allOf":[{"$ref":"#/components/schemas/TaskSummary"}]},"DummyTaskData":{"type":"object","properties":{"source":{"type":"string","example":"SupportTool"},"contractNum":{"type":"string","example":"571016565"},"userId":{"type":"string","example":"abc121243"},"onbaseCaseId":{"type":"string","example":"9280926"},"productName":{"type":"string","example":"CarrierName_1MUTUAL STABLE VOYAGE"},"clientCode":{"type":"string","example":"CarrierName_1"},"taskType":{"type":"string","example":"RenewalTransfer"}}},"AssignmentServerErrorResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":500},"timestamp":{"type":"string","format":"date-time"},"errorId":{"type":"string","example":"0286d47a-7ad9-499c-8ca0-8f6634d236a3"},"message":{"type":"string","example":"The system was unable to assign the task. Please try again later. If the issue persists, contact support."}}},"AssignmentBadRequestResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":400},"timestamp":{"type":"string","format":"date-time"},"errorId":{"type":"string","example":"0286d47a-7ad9-499c-8ca0-8f6634d236a3"},"message":{"type":"string","example":"You have reached the maximum allowed limit."}}},"AssignmentAccessDeniedResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":400},"timestamp":{"type":"string","format":"date-time"},"errorId":{"type":"string","example":"0286d47a-7ad9-499c-8ca0-8f6634d236a3"},"message":{"type":"string","example":"User is not recognized or authorized."}}},"AssignmentNoContentResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":400},"timestamp":{"type":"string","format":"date-time"},"errorId":{"type":"string","example":"0286d47a-7ad9-499c-8ca0-8f6634d236a3"},"message":{"type":"string","example":"No pending tasks at the moment."}}},"AssignmentResourceNotFoundResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":500},"timestamp":{"type":"string","format":"date-time"},"errorId":{"type":"string","example":"0286d47a-7ad9-499c-8ca0-8f6634d236a3"},"message":{"type":"string","example":"Task not available with provided taskId."}}},"ServerErrorResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":500},"timestamp":{"type":"integer","format":"int64","example":1681395423438},"errorId":{"type":"string","example":"0286d47a-7ad9-499c-8ca0-8f6634d236a3"},"message":{"type":"string","example":"Failed to process request"}}},"CaseModuleErrorResponse":{"type":"object","description":"Canonical error envelope for Case module.","properties":{"message":{"type":"string","description":"High-level error message.","example":"Invalid link type"},"traceId":{"type":"string","description":"Trace/correlation id for debugging (derived from requestId or X-Correlation-Id).","example":"0286d47a-7ad9-499c-8ca0-8f6634d236a3"},"detail":{"type":"string","description":"Detailed message including error code context.","example":"[INVALID_LINK_TYPE] Invalid linkType: foo. Valid values are: CHILD, DUPLICATE, RELATED"},"timestamp":{"type":"integer","format":"int64","description":"Epoch timestamp in milliseconds.","example":1681395423438}}},"CaseLinkDetailsResponse":{"type":"object","description":"Response containing a list of linked cases for a given case","properties":{"linkedCases":{"type":"array","description":"List of linked case records","items":{"$ref":"#/components/schemas/LinkedCaseRecord"},"default":[]}}},"LinkedCaseRecord":{"type":"object","description":"Represents a link between two cases","properties":{"caseDetails":{"$ref":"#/components/schemas/CaseSummary"},"associatedCaseDetails":{"$ref":"#/components/schemas/CaseSummary"},"linkType":{"type":"string","description":"The type of relationship between the cases","enum":["CHILD","RELATED","DUPLICATE"],"example":"CHILD"},"linkReason":{"type":"string","description":"The reason for linking the cases","example":"Child case created for policy amendment"},"linkedCases":{"type":"array","description":"Nested linked cases forming a recursive hierarchy of case relationships","items":{"$ref":"#/components/schemas/LinkedCaseRecord"},"default":[]}}},"CaseSummary":{"type":"object","description":"Summary information about a case in a link relationship","properties":{"id":{"type":"string","description":"The unique case identifier","example":"CA0000425395"},"status":{"type":"string","description":"The current status of the case","enum":["IN_PROGRESS","EXCEPTION","COMPLETED","CANCELED"],"example":"IN_PROGRESS"},"caseGroup":{"type":"string","description":"The case group category","example":"NEW_BUSINESS"},"process":{"type":"string","description":"The business process associated with the case","example":"New Business"},"processSubType":{"type":"string","description":"The sub-type of the business process","example":"Incoming Transfer"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the case was created","example":"2025-01-05T10:30:00.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp when the case was last updated","example":"2025-01-05T14:45:30.000Z"}}},"InvalidCaseResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":404},"timestamp":{"type":"number"},"errorId":{"type":"string","example":"33c88eca-ad13-46cc-b14e-b7f82b4af541"},"message":{"type":"string","example":"Invalid case id - <caseId>"},"error":{"type":"string"}}},"BadRequestResponse":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":400},"timestamp":{"type":"integer","format":"int64","example":1681395423438},"errorId":{"type":"string","example":"0286d47a-7ad9-499c-8ca0-8f6634d236a3"},"message":{"type":"string","example":"status not found in the request"}}},"TaskLinkSearchModel":{"type":"object","required":["caseIds"],"properties":{"caseIds":{"type":"array","items":{"type":"string"},"description":"Mandatory. Case ids to fetch links for.","example":["CA0000425395","CA0000425396"]},"carrier":{"type":"string","description":"Optional.","example":"WELB"},"linkType":{"type":"string","description":"Optional.","enum":["RELATED","CHILD"],"example":"RELATED"}}},"TaskLinkDetailsResponse":{"type":"object","properties":{"caseId":{"type":"string","description":"Case id for which links are returned","example":"CA0000425395"},"linkedTasks":{"type":"array","items":{"$ref":"#/components/schemas/LinkedTaskRecordModel"},"default":[]}}},"LinkedTaskRecordModel":{"type":"object","properties":{"taskDetails":{"$ref":"#/components/schemas/TaskLinkTaskDetailsModel"},"associatedTaskDetails":{"$ref":"#/components/schemas/TaskLinkTaskDetailsModel"},"linkType":{"type":"string","enum":["RELATED","CHILD"],"example":"RELATED"},"linkedTasks":{"type":"array","items":{"$ref":"#/components/schemas/LinkedTaskRecordModel"},"default":[]}}},"TaskLinkTaskDetailsModel":{"type":"object","properties":{"taskId":{"type":"string","example":"TA000000000302"},"taskStatus":{"type":"string","example":"INPROGRESS"},"taskType":{"type":"string","example":"Suitability"},"createdAt":{"type":"string","format":"date-time","example":"2026-01-09T02:07:40.455Z"},"updatedAt":{"type":"string","format":"date-time","example":"2026-01-09T02:10:12.000Z"}}},"TemplateMetadataModel":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","properties":{"info":{"type":"string","example":"New Application has been received to ETP"}}}}},"TaskRequest":{"type":"object","properties":{"id":{"type":"string","nullable":true,"example":"36be3d51-2246-4158-9feb-a29fe5bd0183"},"source":{"type":"string","example":"Zinnia.OnBase"},"taskType":{"type":"string","example":"Suitability"},"status":{"type":"string","example":"NEW"},"scheduledReason":{"type":"string","example":"DOCUMENT_MISSING"},"scheduledDate":{"type":"string","format":"date-time"},"cancellationReason":{"type":"string","example":"CASE_CANCELATION"},"mappedExceptions":{"type":"array","description":"Exceptions to be linked the task","items":{"type":"string"},"example":["EX000000000188"]},"mappedDocuments":{"type":"array","description":"Documents to be linked with the task","items":{"$ref":"#/components/schemas/TaskMappedRequestDocument"}},"data":{"type":"object","example":{}},"linkedTasks":{"type":"array","description":"tasks to be linked with the task","items":{"$ref":"#/components/schemas/RequestLinkedTask"}}}},"TaskModel":{"allOf":[{"$ref":"#/components/schemas/TaskDetailById"}],"type":"object","properties":{"exceptions":{"type":"array","items":{"type":"string"},"example":[]},"data":{"type":"object","additionalProperties":{"type":"object"},"example":{}},"schema":{"type":"object","example":{}}}},"TaskInstanceModel":{"allOf":[{"$ref":"#/components/schemas/TaskInstanceSummaryModel"}],"type":"object","properties":{"schema":{"type":"object","example":{"schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"suitabilityStatus":{"type":"string"},"notes":{"type":"array","items":{"type":"object","properties":{"submissionDate":{"type":"string"},"commentCategory":{"type":"string"},"commentSubCategory":{"type":"string"},"commentDetail":{"type":"string"},"comment":{"type":"string"},"description":{"type":"string"},"createdDate":{"type":"string"},"createBy":{"type":"string"},"noteId":{"type":"integer"}},"required":["submissionDate","commentCategory","commentSubCategory","commentDetail","comment","description","createdDate","createBy","noteId"]}}},"required":["suitabilityStatus"]}}}},"TaskInstanceEsModel":{"description":"Represents the details of the task, including exceptions, data, and schema.","type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the task instance","example":"TA000000000302"},"caseId":{"type":"string","description":"Identifier for the case related to the task","example":"CA0000005579"},"source":{"type":"string","description":"Source of the task instance","example":"BPM.Redemption"},"externalId":{"type":"string","description":"External task identifier","example":"9755818"},"templateId":{"type":"string","description":"Identifier for the template used","example":"aedb60fb-48b1-4b87-a7a2-57593c39cbb1"},"process":{"type":"string","description":"Process associated with the task","example":"New Business"},"carrier":{"type":"string","description":"Carrier associated with the task","example":"Carrier_1"},"taskType":{"type":"string","description":"Type of the task","example":"Suitability"},"taskName":{"type":"string","description":"Name of the task","example":"Suitability Review"},"status":{"type":"string","description":"Current status of the task","example":"NEW","enum":["NEW","INPROGRESS","SCHEDULED","CANCELLED","COMPLETED"]},"mappedExceptions":{"type":"array","description":"Exceptions linked to the task","items":{"type":"string"},"example":["EX000000000188"]},"mappedDocuments":{"type":"array","description":"Documents linked to the task","items":{"$ref":"#/components/schemas/TaskMappedDocument"}},"queue":{"type":"string","description":"Queue to which the task is assigned","example":"queue_withdrawal"},"priority":{"type":"string","description":"Priority level of the task","example":"HIGH"},"escalated":{"type":"boolean","description":"Whether the task is escalated","default":false,"example":false},"assigneePartyId":{"type":"string","description":"Party Id of the User assigned to the task","example":"53dfb347558f42cfb79a0ef3a1147acb"},"assignedAt":{"type":"string","format":"date-time","description":"Timestamp when the task was assigned to the User"},"preferredAssignee":{"type":"string","description":"Preferred user for task assignment","example":"username@se2.com"},"createdBy":{"type":"string","description":"Email Id of the User who created the task","example":"username@se2.com"},"createdByPartyId":{"type":"string","description":"Party Id of the User who created the task","example":"8170b3a1353848d589399254210772ae"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the task was created"},"updatedBy":{"type":"string","description":"Email Id of the User who last updated the task","example":"Satyam.Srivastava@zinnia.com"},"updatedByPartyId":{"type":"string","description":"Party Id of the User who last updated the task","example":"53dfb347558f42cfb79a0ef3a1147acb"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the task was last updated"}}},"TaskInstanceSummaryModel":{"description":"Represents the details of the task, including exceptions, data, and schema.","type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the task instance","example":"TA000000000302"},"caseId":{"type":"string","description":"Identifier for the case related to the task","example":"CA0000005579"},"source":{"type":"string","description":"Source of the task instance","example":"BPM.Redemption"},"externalId":{"type":"string","description":"External task identifier","example":"9755818"},"templateId":{"type":"string","description":"Identifier for the template used","example":"aedb60fb-48b1-4b87-a7a2-57593c39cbb1"},"process":{"type":"string","description":"Process associated with the task","example":"New Business"},"carrier":{"type":"string","description":"Carrier associated with the task","example":"Carrier_1"},"taskType":{"type":"string","description":"Type of the task","example":"Suitability"},"taskName":{"type":"string","description":"Name of the task","example":"Suitability Review"},"taskDetails":{"type":"string","description":"Details of the task","example":"Important task details.."},"status":{"type":"string","description":"Current status of the task","example":"NEW","enum":["NEW","INPROGRESS","SCHEDULED","CANCELLED","COMPLETED"]},"data":{"type":"object","additionalProperties":true,"description":"Additional data related to the task","example":{}},"mappedExceptions":{"type":"array","description":"Exceptions linked to the task","items":{"type":"string"},"example":["EX000000000188"]},"mappedDocuments":{"type":"array","description":"Documents linked to the task","items":{"$ref":"#/components/schemas/TaskMappedDocument"}},"linkedTasks":{"type":"array","description":"tasks linked to the task","items":{"$ref":"#/components/schemas/LinkedTask"}},"queue":{"type":"string","description":"Queue to which the task is assigned","example":"queue_withdrawal"},"scheduledReason":{"type":"string","description":"Reason why the task is scheduled to later time","example":""},"scheduledDate":{"type":"string","format":"date","description":"Date for which the task is scheduled","example":"2024-04-02"},"cancellationReason":{"type":"string","description":"Reason for task cancellation","example":""},"slaDue":{"type":"string","format":"date-time","description":"SLA date of the case"},"priority":{"type":"string","description":"Priority level of the task","example":"HIGH"},"escalated":{"type":"boolean","description":"Whether the task is escalated","default":false,"example":false},"assigneeFirstName":{"type":"string","description":"First Name of the User assigned to the task","example":"Great"},"assigneeLastName":{"type":"string","description":"Last Name of the User assigned to the task","example":"Gatsby"},"assignee":{"type":"string","description":"Email Id of the User assigned to the task","example":"Great.Gatsby@zinnia.com"},"assigneePartyId":{"type":"string","description":"Party Id of the User assigned to the task","example":"53dfb347558f42cfb79a0ef3a1147acb"},"assignedAt":{"type":"string","format":"date-time","description":"Timestamp when the task was assigned to the User"},"preferredAssignee":{"type":"string","description":"Preferred user for task assignment","example":"username@se2.com"},"createdBy":{"type":"string","description":"Email Id of the User who created the task","example":"username@se2.com"},"createdByPartyId":{"type":"string","description":"Party Id of the User who created the task","example":"8170b3a1353848d589399254210772ae"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the task was created"},"updatedBy":{"type":"string","description":"Email Id of the User who last updated the task","example":"Satyam.Srivastava@zinnia.com"},"updatedByPartyId":{"type":"string","description":"Party Id of the User who last updated the task","example":"53dfb347558f42cfb79a0ef3a1147acb"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the task was last updated"}}},"PublicTaskInstanceModel":{"description":"Represents the details of the task.","type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the task instance","example":"TA000000000302"},"process":{"type":"string","description":"Process associated with the task","example":"New Business"},"carrier":{"type":"string","description":"Carrier associated with the task","example":"Carrier_1"},"taskType":{"type":"string","description":"Type of the task","example":"Suitability"},"taskName":{"type":"string","description":"Name of the task","example":"Suitability Review"},"taskDetails":{"type":"string","description":"Details of the task","example":"Important task details.."},"status":{"type":"string","description":"Current status of the task","example":"NEW","enum":["NEW","INPROGRESS","SCHEDULED","CANCELLED","COMPLETED"]},"queue":{"type":"string","description":"Queue to which the task is assigned","example":"queue_withdrawal"},"scheduledReason":{"type":"string","description":"Reason why the task is scheduled to later time","example":""},"scheduledDate":{"type":"string","format":"date","description":"Date for which the task is scheduled","example":"2024-04-02"},"cancellationReason":{"type":"string","description":"Reason for task cancellation","example":""},"assignee":{"type":"string","description":"Email Id of the User assigned to the task","example":"Great.Gatsby@zinnia.com"},"assigneePartyId":{"type":"string","description":"Party Id of the User assigned to the task","example":"53dfb347558f42cfb79a0ef3a1147acb"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the task was created"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the task was last updated"}}},"TaskSearchResponseModel":{"description":"Represents the details of the task, including exceptions, data, and schema.","type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the task instance","example":"TA000000000302"},"caseId":{"type":"string","description":"Identifier for the case related to the task","example":"CA0000005579"},"policyNumber":{"type":"string","description":"policyNumber for the case related to the task","example":"7680002791"},"source":{"type":"string","description":"Source of the task instance","example":"BPM.Redemption"},"externalId":{"type":"string","description":"External task identifier","example":"9755818"},"templateId":{"type":"string","description":"Identifier for the template used","example":"aedb60fb-48b1-4b87-a7a2-57593c39cbb1"},"process":{"type":"string","description":"Process associated with the task","example":"New Business"},"carrier":{"type":"string","description":"Carrier associated with the task","example":"Carrier_1"},"taskType":{"type":"string","description":"Type of the task","example":"Suitability"},"taskName":{"type":"string","description":"Name of the task","example":"Suitability Review"},"taskDetails":{"type":"string","description":"Details of the task","example":"Important task details.."},"status":{"type":"string","description":"Current status of the task","example":"NEW","enum":["NEW","INPROGRESS","SCHEDULED","CANCELLED","COMPLETED"]},"data":{"type":"object","additionalProperties":true,"description":"Additional data related to the task","example":{}},"mappedExceptions":{"type":"array","description":"Exceptions linked to the task","items":{"type":"string"},"example":["EX000000000188"]},"mappedDocuments":{"type":"array","description":"Documents linked to the task","items":{"$ref":"#/components/schemas/TaskMappedDocument"}},"linkedTasks":{"type":"array","description":"tasks linked to the task","items":{"$ref":"#/components/schemas/LinkedTask"}},"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"},"externalId":{"type":"string","description":"The externalId of the agent.","example":"399823932"}}}},"queue":{"type":"string","description":"Queue to which the task is assigned","example":"queue_withdrawal"},"scheduledReason":{"type":"string","description":"Reason why the task is scheduled to later time","example":""},"scheduledDate":{"type":"string","format":"date","description":"Date for which the task is scheduled","example":"2024-04-02"},"cancellationReason":{"type":"string","description":"Reason for task cancellation","example":""},"slaDue":{"type":"string","format":"date-time","description":"SLA date of the case"},"priority":{"type":"string","description":"Priority level of the task","example":"HIGH"},"escalated":{"type":"boolean","description":"Whether the task is escalated","default":false,"example":false},"assigneeFirstName":{"type":"string","description":"First Name of the User assigned to the task","example":"Great"},"assigneeLastName":{"type":"string","description":"Last Name of the User assigned to the task","example":"Gatsby"},"assignee":{"type":"string","description":"Email Id of the User assigned to the task","example":"Great.Gatsby@zinnia.com"},"assigneePartyId":{"type":"string","description":"Party Id of the User assigned to the task","example":"53dfb347558f42cfb79a0ef3a1147acb"},"assignedAt":{"type":"string","format":"date-time","description":"Timestamp when the task was assigned to the User"},"preferredAssignee":{"type":"string","description":"Preferred user for task assignment","example":"username@se2.com"},"createdBy":{"type":"string","description":"Email Id of the User who created the task","example":"username@se2.com"},"createdByPartyId":{"type":"string","description":"Party Id of the User who created the task","example":"8170b3a1353848d589399254210772ae"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the task was created"},"updatedBy":{"type":"string","description":"Email Id of the User who last updated the task","example":"Satyam.Srivastava@zinnia.com"},"updatedByPartyId":{"type":"string","description":"Party Id of the User who last updated the task","example":"53dfb347558f42cfb79a0ef3a1147acb"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the task was last updated"}}},"TaskMessageModel":{"type":"object","properties":{"taskType":{"type":"string","description":"Type of the task","example":"SUITABILITY_REVIEW"},"carrier":{"type":"string","description":"Carrier information","example":"MASS"},"category":{"type":"string","description":"Category of the message","example":"CANCELLATION_REASON"},"messageId":{"type":"string","description":"Unique identifier for the message","example":"DOCUMENT_MISSING"},"message":{"type":"string","description":"The description of the message","example":"DOCUMENT is missing for SUITABILITY_REVIEW for MASS"}}},"TaskMappedDocument":{"type":"object","description":"Metadata for a document mapped to a specific task in the system.","properties":{"documentId":{"type":"string","description":"A unique identifier for the document.","example":"abc12345"},"documentName":{"type":"string","description":"The name of the document.","example":"Report_Q1_2024.pdf"},"documentSource":{"type":"string","description":"The origin or source of the document, such as a system name or module.","example":"Zinnia.OnBase"},"fileType":{"type":"string","description":"Type of document, like pdf or an image.","example":"pdf"},"displayName":{"type":"string","description":"Display name of the document.","example":"Replacement of Life Insurance or Annuities"},"createdDate":{"type":"string","format":"date-time","description":"Timestamp when the document was created."}}},"TaskMappedRequestDocument":{"type":"object","description":"Metadata for a document mapped to a specific task in the system.","properties":{"documentId":{"type":"string","description":"A unique identifier for the document.","example":"abc12345"},"documentName":{"type":"string","description":"The name of the document.","example":"Report_Q1_2024.pdf"},"documentSource":{"type":"string","description":"The origin or source of the document, such as a system name or module.","example":"Zinnia.OnBase"},"fileType":{"type":"string","description":"Type of document, like pdf or an image.","example":"pdf"},"displayName":{"type":"string","description":"Display name of the document.","example":"Replacement of Life Insurance or Annuities"},"operationType":{"type":"string","description":"Specifies the type of operation to be performed on the document.","enum":["REMOVE","ADD"],"example":"REMOVE"},"createdDate":{"type":"string","format":"date-time","description":"Timestamp when the document was created."}}},"AssigneeDetails":{"type":"object","description":"Assignee search criteria. When provided in task search, the service resolves matching users and filters tasks by their assignee partyIds.","properties":{"firstName":{"type":"string","description":"Assignee first name (search criterion).","example":"John"},"lastName":{"type":"string","description":"Assignee last name (search criterion).","example":"Doe"},"email":{"type":"string","description":"Assignee email address (search criterion).","example":"john.doe@example.com"},"fullName":{"type":"string","description":"Assignee full name (search criterion).","example":"John Doe"}}},"RequestLinkedTask":{"type":"object","description":"Metadata for a linked tasks to a specific task in the system.","properties":{"taskId":{"type":"string","description":"Task Instance Id.","example":"TA000000014642"},"externalId":{"type":"string","description":"The identifier how an external system understand it for example used to map onbase taskId.","example":"23bfac3e-e082-47ef-8619-97e96b17695d"},"reason":{"type":"string","description":"Reason for linking the task.","example":"Identified By BPM"}}},"LinkedTask":{"type":"object","description":"Metadata for a linked tasks to a specific task in the system.","properties":{"taskId":{"type":"string","description":"Task Instance Id.","example":"TA000000014642"},"reason":{"type":"string","description":"Reason for linking the task.","example":"Identified By BPM"}}},"TaskAssignmentModel":{"description":"Represents the assignment details of a task, including process, carrier, and status.","type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the task assignment","example":"TA000000000302"},"caseId":{"type":"string","description":"Identifier for the case associated with the task assignment","example":"CA0000005579"},"process":{"type":"string","description":"Process associated with the task assignment","example":"BPM.Redemption"},"carrier":{"type":"string","description":"Carrier involved in the task assignment","example":"Carrier_1"},"taskType":{"type":"string","description":"Type of the task","example":"Suitability"},"taskName":{"type":"string","description":"Name of the task","example":"Suitability Review"},"status":{"type":"string","description":"Current status of the task","example":"NEW","enum":["NEW","INPROGRESS","SCHEDULED","CANCELLED","COMPLETED"]},"queue":{"type":"string","description":"Name of the queue","example":"suitability_review"},"identifiers":{"type":"array","items":{"type":"object","description":"A list of identifiers associated with the task.","properties":{"identifier":{"type":"string","description":"The type of identifier."},"value":{"type":"string","description":"The value of the identifier."}}},"example":[{"identifier":"documentHandle","value":"18389232"},{"identifier":"caseID","value":"9989283"},{"identifier":"contractNumber","value":"5810000002"},{"identifier":"documentNumber","value":"20240715-MAN-389232"}]},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the task assignment was created"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the task assignment was last updated"}}},"FormMetadataModel":{"type":"object","properties":{"formId":{"type":"string","example":"67056202d7795c98bf36f5f1"},"process":{"type":"string","example":"New Business"},"carrier":{"type":"string","example":"Carrier_1"},"taskType":{"type":"string","example":"Suitability"},"formSchema":{"type":"object","properties":{"$schema":{"type":"string","example":"http://json-schema.org/draft-07/schema#"},"title":{"type":"string","example":"Suitability form"},"type":{"type":"string","example":"object","properties":{"applicantInformation":{"type":"object","properties":{"applicantNameFirst":{"type":"string","title":"First name","pattern":"^[a-zA-Z]+$"},"applicantNameMI":{"type":"string","title":"MI","maxLength":1},"applicantNameLast":{"type":"string","title":"Last name"},"applicantAge":{"type":"number","title":"Age","minimum":0},"stateSignedAt":{"type":"string","title":"State Signed at*","enum":["Colorado","Wyoming"],"description":"*Non-resident form is required if different than resident state."},"ssnTaxId":{"type":"string","title":"SSN/Tax ID #","pattern":"^\\d{3}-\\d{2}-\\d{4}$"},"employment":{"type":"object","properties":{"employmentStatus":{"type":"array","title":"Employment Status","items":{"type":"string","enum":["Employed","Unemployed","Retired","Disabled"]},"uniqueItems":true}},"required":["employmentStatus"]},"jointApplicantInformation":{"type":"object","properties":{"jointApplicantNameFirst":{"type":"string","title":"First Name"},"jointApplicantNameMI":{"type":"string","title":"MI","maxLength":1},"jointApplicantNameLast":{"type":"string","title":"Last Name"},"jointApplicantAge":{"type":"number","title":"Age","minimum":0},"employment":{"type":"object","properties":{"jointEmploymentStatus":{"type":"array","title":"Employment Status","items":{"type":"string","enum":["Employed","Unemployed","Retired","Disabled"]},"uniqueItems":true}},"required":["jointEmploymentStatus"]}}}}},"annuityInformation":{"type":"object","properties":{"annuityProductName":{"type":"string","title":"Annuity Product Name"},"anticipatedAmount":{"type":"number","title":"Anticipated Amount $"},"annuityType":{"type":"string","title":"Annuity Type","enum":["Qualified","Non-qualified"]}}},"financialInformation":{"type":"object","properties":{"approximateAnnualIncome":{"type":"number","title":"Approximate annual income $"},"sourceOfIncome":{"type":"string","title":"Source of Income"},"approximateAnnualLivingExpenses":{"type":"number","title":"Approximate annual living expenses $"},"disposableIncome":{"type":"number","title":"Disposable income (question a. minus question b.)"},"anticipatedExpenseIncomeChange":{"type":"object","properties":{"anticipated":{"type":"boolean","title":"Do you anticipate a significant increase in living expenses or decrease in annual income or liquid assets during the surrender charge period of the annuity?"}}},"totalAssets":{"type":"number","title":"Approximate total assets"},"totalDebt":{"type":"number","title":"Approximate total debt","description":"Includes mortgages on properties (excluding any mortgages or debt owed on the Applicant's primary residence), credit card debt, automobile loan or lease payments, student loans, and the outstanding balances of any other amounts owed."},"netWorth":{"type":"number","title":"Approximate net worth","description":"Question e. minus question f."},"residenceType":{"type":"string","title":"Where do you currently reside?","enum":["Personal residence","With family members","Nursing home","Assisted living facility"]},"sufficientFunds":{"type":"object","properties":{"hasSufficientFunds":{"type":"string","title":"Do you have sufficient funds or other assets available, without penalty, for living expenses and in case of emergencies?","enum":["Yes","No"]}}},"federalIncomeTaxBracket":{"type":"object","properties":{"taxBracket":{"type":"string","title":"Federal income tax bracket","enum":["0%","10%","12%","22%","24%","32%","35%","37%","Other"]}}},"liquidAssetsAfterPurchase":{"type":"number","title":"Approximate liquid assets after annuity purchase"},"appliedForGovrnmentBenefits":{"type":"boolean","title":"California Residents Only - Has the Applicant applied, or does the Applicant intend to apply for, means-tested government benefits, including, but not limited to, Medi-Cal or the veterans' aid and attendance benefit?"}}},"basisOfRecommendation":{"type":"object","properties":{"reason":{"type":"string","title":"Explain your reasons for recommending to the Applicant that they purchase this annuity, including how the annuity and its features will effectively address the Applicant`s insurance needs and financial objectives. Include the advantages and disadvantages considered as part of the recommendation."}}}}}}},"uiSchema":{"type":"object","properties":{"applicantInformation":{"type":"object","properties":{"applicantNameFirst":{"type":"object","properties":{"ui":{"type":"object","properties":{"placeholder":{"type":"string","example":"First name"},"helpText":{"type":"string","example":"Applicant's first name"}}}}},"applicantNameLast":{"type":"object","properties":{"ui":{"type":"object","properties":{"placeholder":{"type":"string","example":"Last name"},"helpText":{"type":"string","example":"Applicant's last name"}}}}}}},"basisOfRecommendation":{"type":"object","properties":{"reason":{"type":"object","properties":{"ui":{"type":"object","properties":{"widget":{"type":"string","example":"textarea"}}}}}}}}},"schemaContent":{"type":"object","additionalProperties":true,"description":"Additional data related to the task","example":{}}}},"ExceptionCreateRequest":{"type":"object","properties":{"source":{"type":"string","description":"The system that raised the exception.","example":"Zinnia.OnBase"},"nmID":{"type":"string","description":"The nigo message id.","example":"EM.050"}}},"ExceptionCreateResponse":{"type":"object","properties":{"exceptionId":{"type":"string","description":"The unique identifier of the exception.","example":"EX000000000174"},"caseId":{"type":"string","description":"The unique identifier of the case to which this exception is linked.","example":"CA0000006344"},"source":{"type":"string","description":"The system or entity that raised the exception.","example":"Zinnia.OnBase"},"nmID":{"type":"string","description":"The nigo message id.","example":"EM.050"},"exceptionType":{"type":"string","description":"The exception type of the exception.","example":"Business Exception"},"category":{"type":"string","description":"The category of the exception, selected from a predefined list.","example":"Agent"},"reason":{"type":"string","description":"The specific reason for the exception, chosen from a predefined list.","example":"Appointment Status"},"detailReason":{"type":"string","description":"The detailed reason for the exception.","example":"The agent lacks an appointment in the state where product was sold.s"},"exceptionStatus":{"type":"string","description":"The current status of the exception.","enum":["NEW","UNRESOLVED","RESOLVED","OVERRIDDEN"],"example":"NEW"},"exceptionAdditionalData":{"type":"array","description":"Exception Additional Data","items":{"$ref":"#/components/schemas/ExceptionAdditionalData"}},"createdBy":{"type":"string","description":"The user or system that created the exception.","example":"anurag.chaudhary@se2.com"},"updatedBy":{"type":"string","description":"The user or system that last updated the exception.","example":"anurag.chaudhary@se2.com"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the exception was created, in ISO 8601 format."},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp when the exception was last updated, in ISO 8601 format."}}},"ExceptionPatchRequest":{"type":"object","properties":{"source":{"type":"string","description":"The system that raised the exception.","example":"Zinnia.OnBase"},"exceptionStatus":{"type":"string","description":"The current status of the exception.","example":"NEW"}}},"ExceptionListResponse":{"type":"array","description":"An array containing a list of exception instances, each of which represents an exception raised within a case.","items":{"$ref":"#/components/schemas/ExceptionCreateResponse"}},"ExceptionReferenceRequest":{"type":"object","properties":{"nmId":{"type":"string","description":"Unique identifier for the exception reference","example":"EM.057"},"exceptionType":{"type":"string","description":"Exception Type for the exception reference","example":"Business Exception"},"businessProcess":{"type":"string","description":"The business process related to the exception","example":"New Business"},"category":{"type":"string","description":"The category of the exception","example":"Agent"},"reason":{"type":"string","description":"The reason for the exception","example":"Training Status"},"detailedReason":{"type":"string","description":"Detailed description of the reason for the exception","example":"The agent's anti-money laundering training was not complete at time of sale."}}},"ExceptionReferenceModel":{"type":"object","properties":{"nmId":{"type":"string","description":"Unique identifier for the exception reference","example":"EM.057"},"exceptionType":{"type":"string","description":"Exception Type for the exception reference","example":"Business Exception"},"businessProcess":{"type":"string","description":"The business process in which the exception occurred","example":"New Business"},"category":{"type":"string","description":"The category of the exception","example":"Agent"},"reason":{"type":"string","description":"The reason for the exception","example":"Training Status"},"detailedReason":{"type":"string","description":"Detailed description of the reason for the exception","example":"The agent's anti-money laundering training was not complete at time of sale."},"deleted":{"type":"boolean","description":"Indicates whether the exception reference has been deleted","example":false},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the exception reference was created","example":"2024-09-17T10:00:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the exception reference was last updated","example":"2024-09-17T12:00:00Z"}}},"ReferenceResponseModel":{"type":"object","properties":{"type":{"type":"string","description":"The type of the reference data."},"parentKey":{"type":"string","description":"The key of the parent entity."},"key":{"type":"string","description":"The key of the reference data."},"value":{"type":"string","description":"The value associated with the reference data."}}},"ReferenceResponseTree":{"type":"object","properties":{"type":{"type":"string","description":"The type of the reference data node."},"key":{"type":"string","description":"The key of the reference data node."},"value":{"type":"string","description":"The value associated with the reference data node."},"child":{"type":"array","description":"List of child nodes in the reference data hierarchy.","items":{"$ref":"#/components/schemas/ReferenceResponseTree"}}}},"ExceptionRefDetailsModel":{"type":"object","properties":{"id":{"type":"string","example":"DE.NM.01"},"category":{"type":"string","example":"Form"},"reason":{"type":"string","example":"Redemption Form"},"detailedReason":{"type":"string","example":"Incorrect form provided"},"exceptionSubRefs":{"type":"array","items":{"$ref":"#/components/schemas/ExceptionSubRefModel"}}}},"ExceptionRefDetailsSearchRequest":{"type":"object","properties":{"category":{"type":"array","items":{"type":"string"},"description":"A list of categories for the search","example":["Form","Agent"]},"carrier":{"type":"string","description":"The carrier associated with the request","example":"Carrier_1"},"process":{"type":"string","description":"The process associated with the request","example":"Withdrawal"}}},"ExceptionSubRefModel":{"type":"object","properties":{"subNmId":{"type":"string","example":"DE.01"},"carrier":{"type":"string","example":"Carrier_1"},"process":{"type":"string","example":"Withdrawal"},"subProcess":{"type":"string","example":"Redemption"},"subNmIdDetail":{"type":"string","example":"Incorrect form received"},"deleted":{"type":"boolean","example":false}}},"ExceptionReferenceSearchRequest":{"type":"object","properties":{"category":{"type":"array","items":{"type":"string"},"description":"List of categories to filter the search results","example":["Agent","NB Life Application"]}}},"QueueRequest":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the queue instance","example":"REDEMPTION_QUEUE"},"name":{"type":"string","description":"Name of the queue instance","example":"Suitability Queue"},"description":{"type":"string","description":"Description of the queue instance","example":"Description"},"taskType":{"type":"string","description":"Type of task associated with the queue","example":"Suitability Review"},"process":{"type":"string","description":"Process associated with the queue","example":"New Business"},"carrier":{"type":"string","description":"Carrier associated with the queue","example":"Carrier_1"},"date":{"type":"string","format":"date-time","description":"Date associated with the queue (default is the current date)","example":"2024-09-17T10:00:00Z"}},"required":["id","name","description"]},"QueueResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the queue instance","example":"REDEMPTION_QUEUE"},"name":{"type":"string","description":"Name of the queue instance","example":"Suitability Queue"},"description":{"type":"string","description":"Description of the queue instance","example":"Description"},"taskType":{"type":"string","description":"Type of task associated with the queue","example":"Suitability Review"},"process":{"type":"string","description":"Process associated with the queue","example":"New Business"},"carrier":{"type":"string","description":"Carrier associated with the queue","example":"Carrier_1"},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the queue instance was created","example":"2024-09-17T10:00:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"Date and time when the queue instance was last updated","example":"2024-09-17T12:00:00Z"},"createdBy":{"type":"string","description":"User who created the queue instance","example":"username@se2.com"},"updatedBy":{"type":"string","description":"User who last updated the queue instance","example":"username@se2.com"},"deleted":{"type":"boolean","description":"Indicates whether the queue instance has been deleted","example":false}}},"PageQueueResponse":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/QueueResponse"}},"pageable":{"type":"object","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"sort":{"type":"object","properties":{"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"},"empty":{"type":"boolean"}}},"totalPages":{"type":"integer"},"totalElements":{"type":"integer"},"numberOfElements":{"type":"integer"}}},"totalElements":{"type":"integer"},"last":{"type":"boolean"},"number":{"type":"integer"},"size":{"type":"integer"},"sort":{"type":"object"},"first":{"type":"boolean"},"empty":{"type":"boolean"}}},"ErrorResponse":{"type":"object","properties":{"statusCode":{"type":"integer","example":404},"timestamp":{"type":"string","format":"date-time","example":"2024-09-04T07:26:00.464Z"},"errorId":{"type":"string","example":"a0752b63-6e8f-4422-9022-d2c6defc4e9d"},"message":{"type":"string","example":"case not found for caseId"}}},"ValidationResponseError":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":400},"timestamp":{"type":"string","format":"date-time"},"errorId":{"type":"string","example":"a4a57ed0-2c1b-4922-9959-3b85dd8a96d3"},"message":{"type":"string","example":"Invalid Request"},"error":{"type":"array","items":{"type":"string","example":"source not found in the request"}}}},"TaskStatsSearchModel":{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string"},"description":"List of attributes to group the statistics by"}},"required":["groupBy"]},"TaskStatsResponseModel":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of tasks"},"stats":{"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","description":"The attribute by which tasks are grouped"},"counts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label of the grouped attribute"},"value":{"type":"integer","description":"The count of tasks for the label"}}}}}}}}},"TaskAssigneeSummaryModel":{"type":"object","properties":{"caseId":{"type":"string","description":"The unique identifier of the case"},"tasks":{"type":"array","description":"List of tasks for the case, each with unique assignee details","items":{"type":"object","properties":{"taskId":{"type":"string","description":"The unique identifier of the task"},"uniqueAssigneePartyIds":{"type":"array","description":"Set of unique party IDs assigned to the task","uniqueItems":true,"items":{"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"}}},"StatsSearchModel":{"type":"object","description":"Search criteria for case status comparison","required":["carrier","groupBy"],"properties":{"carrier":{"type":"array","items":{"type":"string"},"description":"List of carriers to filter by","example":["ELIC","SBUL"]},"groupBy":{"type":"array","items":{"type":"string","enum":["caseStatus"]},"description":"Must be set to caseStatus for this endpoint","example":["caseStatus"]}}},"CaseStatusComparisonResponse":{"type":"object","description":"Response containing case status count comparison results","required":["matched","mongoTotal","elasticTotal","totalCountDifference","statusComparison"],"properties":{"matched":{"type":"boolean","description":"Whether the counts match between MongoDB and Elasticsearch","example":false},"mongoTotal":{"type":"integer","format":"int64","description":"Total count from MongoDB","example":1500},"elasticTotal":{"type":"integer","format":"int64","description":"Total count from Elasticsearch","example":1480},"totalCountDifference":{"type":"integer","format":"int64","description":"Absolute difference between total counts","example":20},"statusComparison":{"type":"array","items":{"$ref":"#/components/schemas/CaseStatusCountDiff"},"description":"Detailed comparison for each case status"}}},"CaseStatusCountDiff":{"type":"object","description":"Count comparison for a specific case status","required":["caseStatus","mongoCount","elasticCount","difference"],"properties":{"caseStatus":{"type":"string","description":"The case status being compared","example":"OPEN"},"mongoCount":{"type":"integer","format":"int64","description":"Count from MongoDB for this status","example":250},"elasticCount":{"type":"integer","format":"int64","description":"Count from Elasticsearch for this status","example":235},"difference":{"type":"integer","format":"int64","description":"Absolute difference between the counts","example":15}}}}}}
```