Application is healthy
statusstring
Allowed values:UPDOWN
Example:UP
Case Instance
Manages cases for all processes
Case Management Health Check
Returns the health status of the application
get
Response
application/json
Response
application/json
get/case/actuator/health
application/json
Search case metadata
Retrieve the case instances based on the specified carrier and case id.
get
Path Parameters
carrierstringrequired
Carrier name instance id
Example:ELIC
caseIdstringrequired
Case instance id
Example:CA0000425395
Response
application/json
Response
application/json
Successful operation
CaseInstanceSummary
idstring
A unique identifier for the case instance.
Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4
templateIdstring
The identifier of the template associated with the case.
Example:cde717c9-5f7e-4c63-953c-ef50e44c021a
carrierstring
The carrier associated with the case.
Example:CarrierName_1
processstring
The process associated with the case.
Example:Correspondence
parentInstanceIdstring
The identifier of the parent case instance, if any.
Example:15ea7582-262f-4dfe-8a60-1e8b8e763fb1
caseGroupstring
Name of the caseGroup type for case.
Example:Distribution
escalatedboolean
Indicates if the case instance has been escalated.
Default:false
Example:false
deletedboolean
Indicates if the case instance has been deleted.
Default:false
Example:false
applicationTypestring
The application type of the policy.
Example:Digital
caseResultstring
Contextual information regarding the caseStatus especially when case is marked as canceled
caseResultDetailstring
Detailed contextual information regarding the caseStatus
correlationIdstring
An identifier used to correlate related events or instances.
Example:15ea7582-262f-4dfe-8a60-1e8b8e763fb1
primaryboolean
Indicates if this is the primary case instance.
Example:false
processSubTypestring
Subtype of the process/transaction associated with the case.
Example:INCOMING_TRANSFER
policyNumberstring
Policy number/Contract No associated with the case instance.
Example:571001920
productNamestring
Name of the product associated with the Contract/Policy.
Example:CarrierName_1MUTUAL STABLE VOYAGE
caseStatusstring
The current status of the case.
Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED
Example:IN_PROGRESS
stagesarray[object]
A list of stages associated with the case.
Show Child Parameters
exceptionsarray[object]
A list of exceptions associated with the case.
Show Child Parameters
partiesarray[object]
A list of parties associated with the case.
Show Child Parameters
additionalData
One OfAdditional data specific to the case.
CaseAdditionalDataNBobject
Show Child Parameters
identifiersarray[object]
A list of identifiers associated with the case.
Show Child Parameters
createdAtstring(date-time)
The date and time when the case was created.
updatedAtstring(date-time)
The date and time when the case was last updated.
get/case/v1/cases/search/{carrier}/{caseId}
Path Parameters
application/json
Case stats
Retrieve the statistics/count of available cases filtered by the specified criteria and grouped by the specified attribute.
post
Body
application/json
Body
application/json
CaseStatsSearchCriteria
policyNumberstring
The policy number associated with the case.
Example:AU7654098
ssnstring
The ssn associated with the case.
Example:SSN-UTK-0078
ownerFirstNamestring
The first name of the policy owner.
Example:Utkarsh
ownerLastNamestring
The last name of the policy owner.
Example:Jain
caseIdsarray[string]
A list of case IDs to filter the search results.
Example:["NB-12345678"]
applicationTypestring
The application type of the policy.
Example:Digital
isIncludeSecondaryboolean
Indicates whether to include secondary cases in the search results.
Default:false
Example:false
processarray[string]
A list of processes to filter the search results.
Example:["New Business"]
carrierstring
The carrier associated with the case.
Example:CarrierName_1
requestSubTypearray[string]
A list of request subtypes to filter the search results.
Example:["INTERNAL CONVERSION"]
productNamearray[string]
A list of product names to filter the search results.
Example:["TOTAL INTEREST ANUITY APPLICATION"]
caseStatusarray[string]
A list of case statuses to filter the search results.
Example:["Exception"]
notInCaseStatusarray[string]
A list of case statuses to exclude from the search results.
Example:["Exception"]
createdDateStartstring(date-time)
The start date for the creation date range filter.
createdDateEndstring(date-time)
The end date for the creation date range filter.
updatedDateStartstring(date-time)
The start date for the updated date range filter.
updatedDateEndstring(date-time)
The end date for the updated date range filter.
agentFirstNamestring
The first name of the agent associated with the case.
Example:JOHN WESLY
agentLastNamestring
The last name of the agent associated with the case.
Example:BEVAN
brokerDealerNamestring
The name of the broker-dealer associated with the case.
Example:JP MORGAN SECURITIES LLC
identifiersarray[object]
A list of case identifier to search case.
Example:[{"identifier":"documentNumber","value":"20240813-EM-964334"}]
Show Child Parameters
groupByarray[string]
Allowed values:caseStatusprocess
Response
application/json
Response
application/json
Case stats retrieved
CaseStatsSearchResponse
countinteger(int32)
Example:120
statsarray[object]
Show Child Parameters
post/case/v1/cases/stats
Body
{}
application/json
Get Case Detail
Retrieve the case instance details using the system identifier (caseId).
get
Path Parameters
caseIdstringrequired
Case instance id
Example:CA0000360227
Response
application/json
Response
application/json
Case details retrieved
CaseInstance
_idstring
Unique identifier for the case instance.
templateIdstring
Identifier for the template associated with the case instance.
carrierstring
Name of the carrier associated with transaction/case.
processstring
Name of the process/transaction type for case.
caseGroupstring
Name of the caseGroup type for case.
parentInstanceIdstring
Identifier for the parent case instance, if applicable.
correlationIdstring
Identifier used for correlating events as they received.
caseStatusstring
Current status of the case instance.
Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED
caseResultstring
Contextual information regarding the caseStatus especially when case is marked as canceled
caseResultDetailstring
Detailed contextual information regarding the caseStatus
primaryboolean
Indicates if this is the primary case instance.
escalatedboolean
Indicates if the case instance has been escalated.
caseProcessingDetailsarray[object]
List of detail sections for case processing.
Show Child Parameters
linkDetailsobject
Details about linked case instances.
Show Child Parameters
processSubTypestring
Subtype of the process/transaction associated with the case.
policyNumberstring
Policy number/Contract No associated to the case instance.
planCodestring
PlanCode associated to the case instance.
productNamestring
Name of the product associated with Contract/Policy.
documentsarray[object]DEPRECATED
List of document associated to the case. (DEPRECATED)
Show Child Parameters
exceptionsarray[object]
List of all exceptions/NIGOs associated related to the case.
Show Child Parameters
notesarray[object]
List of all note associated to the case.
Show Child Parameters
tasksarray[object]
List of all tasks associated to the case irrespective of different stage/steps.
Show Child Parameters
mappedTasksarray[string]
List of Task Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedExceptionsarray[string]
List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedNotesarray[string]
List of Notes Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedDocumentsarray[string]
List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
partiesarray[object]
List of individuals/parties associated with the contract/policy related to the case
Show Child Parameters
identifiersarray[object]
An object representing an identifier and its corresponding value.
Show Child Parameters
additionalData
One OfDEPRECATED
Additional data related to the case. (DEPRECATED)
CaseAdditionalDataNBobject
Show Child Parameters
stagesarray[object]
List of stages representing milestone in the journey of a case/transaction.
Show Child Parameters
createdAtstring(date-time)
Timestamp when the case instance was created, derived from the time of the initial event.
updatedAtstring(date-time)
Timestamp when the case instance was last updated, derived from the time of the latest event.
systemUpdatedDtstring(date)
The date when the system was last updated.
deletedboolean
Indicates if the case instance has been deleted.
techExceptionStatusstring
Overall status of technical exceptions on the case
techExceptionCountinteger(int32)
Total count of technical exceptions on the case
get/case/v1/cases/{caseId}
Path Parameters
application/json