Search
K
Case Management

Case Management API

1.0.0OAS 3.0

Maintains cases and tasks apis related to the policy lifecycle.

API Base URL
  • Server 1:https://dev.api.zinnia.io/

    Dev Environment

  • Server 2:https://qa.api.zinnia.io/

    QA Environment

  • Server 3:https://uat.api.zinnia.io/

    UAT Environment

  • Server 4:https://api.zinnia.io/

    PROD Environment

Security
Auth0 (openIdConnect)

Case Instance

Manages cases for all processes

Search cases

Retrieve the list of available case instances based on the specified criteria.

post

Body

application/json

CasePageSearchCriteria

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
sortBystring

The field by which to sort the search results.

Allowed values:updatedAtcreatedAtcarrierprocesscaseStatus

Example:createdAt

sortDirectionstring

The direction to sort the search results, either ascending (asc) or descending (desc).

Allowed values:ascdesc

offsetinteger(int32)

The offset for pagination, indicating the starting point for the results.

Example:2

limitinteger(int32)

The maximum number of results to return.

Example:20

Response

application/json

Successful operation

CaseListInstanceResponse

dataarray[object]
Show Child Parameters
countinteger(int32)

Example:5

offsetinteger(int32)

Example:4

limitinteger(int32)

Example:5

totalinteger(int32)

Example:13

statusinteger(int32)

Example:200

messagestring

Example:Successfully retrieved data!

post/case/v1/cases/search

Body

{}
 
application/json