Search
K
Case Management

Get reference data

Get Reference data keys for the cases based on criteria

post

Body

application/json

RefDataSearchCriteria

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
keysarray[string]

Allowed values:requestSubTypeproductName

Response

application/json

reference data for provided keys retrieved

ReferenceDataResponse

referenceDataobject
Show Child Parameters
post/case/v1/refdata

Body

{}
 
application/json

Add label config

Creates mappings for display values of labels

post

Body

application/json

LabelConfigModel

keystringrequired

Unique key for the label

Example:process

valuestringrequired

Value associated with the label

Example:LOAN PAYMENT

displayValuestringrequired

Display value of the label

Example:ONE-TIME LOAN PAYMENT

Response

application/json

reference data for provided keys retrieved

LabelConfigModel

keystringrequired

Unique key for the label

Example:process

valuestringrequired

Value associated with the label

Example:LOAN PAYMENT

displayValuestringrequired

Display value of the label

Example:ONE-TIME LOAN PAYMENT

post/case/v1/refdata/labelconfigs

Body

{ "key": "process", "value": "LOAN PAYMENT", "displayValue": "ONE-TIME LOAN PAYMENT" }
 
application/json

Get all label config

get all mappings for display values of labels

get

Response

application/json

reference data for provided keys retrieved

LabelConfigResponse

labelconfigsarray[object]
Show Child Parameters
get/case/v1/refdata/labelconfigs
 
application/json

Search label config

Search mappings for display values of labels

get

Query Parameters

keystringrequired

Label config key

valuestring

Label config value

Response

application/json

reference data for provided keys retrieved

LabelConfigResponse

labelconfigsarray[object]
Show Child Parameters
get/case/v1/refdata/labelconfigs/search
 
application/json

Retrieve Reference Data Hierarchy

Retrieves a hierarchical structure of reference data based on the specified type as parent.

get

Path Parameters

refTypestringrequired

The starting parent type in the hierarchy.

Example:DOCUMENT_CATEGORY

Response

application/json

Retrieved Document hierarchical reference data.

ReferenceResponseTree

typestring

The type of the reference data node.

keystring

The key of the reference data node.

valuestring

The value associated with the reference data node.

childarray[object]

List of child nodes in the reference data hierarchy.

Show Child Parameters
get/case/v1/refdata/{refType}/tree
 
application/json