Search
K
Case Management

Create a new exception reference

post

Body

application/json

Exception reference to be created

ExceptionReferenceRequest

nmIdstring

Unique identifier for the exception reference

Example:EM.057

exceptionTypestring

Exception Type for the exception reference

Example:Business Exception

businessProcessstring

The business process related to the exception

Example:New Business

categorystring

The category of the exception

Example:Agent

reasonstring

The reason for the exception

Example:Training Status

detailedReasonstring

Detailed description of the reason for the exception

Example:The agent's anti-money laundering training was not complete at time of sale.

Response

application/json

Exception reference created successfully

ExceptionReferenceModel

nmIdstring

Unique identifier for the exception reference

Example:EM.057

exceptionTypestring

Exception Type for the exception reference

Example:Business Exception

businessProcessstring

The business process in which the exception occurred

Example:New Business

categorystring

The category of the exception

Example:Agent

reasonstring

The reason for the exception

Example:Training Status

detailedReasonstring

Detailed description of the reason for the exception

Example:The agent's anti-money laundering training was not complete at time of sale.

deletedboolean

Indicates whether the exception reference has been deleted

Example:false

createdAtstring(date-time)

The date and time when the exception reference was created

Example:2024-09-17T10:00:00Z

updatedAtstring(date-time)

The date and time when the exception reference was last updated

Example:2024-09-17T12:00:00Z

post/case/v1/exceptionrefs

Body

{}
 
application/json

Search for exception references

post

Body

application/json

Criteria for searching exception references

ExceptionReferenceSearchRequest

categoryarray[string]

List of categories to filter the search results

Example:["Agent","NB Life Application"]

Response

application/json

Search results

nmIdstring

Unique identifier for the exception reference

Example:EM.057

exceptionTypestring

Exception Type for the exception reference

Example:Business Exception

businessProcessstring

The business process in which the exception occurred

Example:New Business

categorystring

The category of the exception

Example:Agent

reasonstring

The reason for the exception

Example:Training Status

detailedReasonstring

Detailed description of the reason for the exception

Example:The agent's anti-money laundering training was not complete at time of sale.

deletedboolean

Indicates whether the exception reference has been deleted

Example:false

createdAtstring(date-time)

The date and time when the exception reference was created

Example:2024-09-17T10:00:00Z

updatedAtstring(date-time)

The date and time when the exception reference was last updated

Example:2024-09-17T12:00:00Z

post/case/v1/exceptionrefs/search

Body

{}
 
application/json

Search for exception references and its sub reference details

post

Body

application/json

Criteria for searching exception references and its sub reference details

ExceptionRefDetailsSearchRequest

categoryarray[string]

A list of categories for the search

Example:["Form","Agent"]

carrierstring

The carrier associated with the request

Example:Carrier_1

processstring

The process associated with the request

Example:Withdrawal

Response

application/json

Search results

idstring

Example:DE.NM.01

categorystring

Example:Form

reasonstring

Example:Redemption Form

detailedReasonstring

Example:Incorrect form provided

exceptionSubRefsarray[object]
Show Child Parameters
post/case/v1/exceptionrefs/nigos/search

Body

{}
 
application/json

Find an exception reference by NM ID

get

Path Parameters

nmIdstringrequired

Example:EM.053

Response

application/json

Exception reference found

ExceptionReferenceModel

nmIdstring

Unique identifier for the exception reference

Example:EM.057

exceptionTypestring

Exception Type for the exception reference

Example:Business Exception

businessProcessstring

The business process in which the exception occurred

Example:New Business

categorystring

The category of the exception

Example:Agent

reasonstring

The reason for the exception

Example:Training Status

detailedReasonstring

Detailed description of the reason for the exception

Example:The agent's anti-money laundering training was not complete at time of sale.

deletedboolean

Indicates whether the exception reference has been deleted

Example:false

createdAtstring(date-time)

The date and time when the exception reference was created

Example:2024-09-17T10:00:00Z

updatedAtstring(date-time)

The date and time when the exception reference was last updated

Example:2024-09-17T12:00:00Z

get/case/v1/exceptionrefs/{nmId}
 
application/json

Update an exception reference

put

Path Parameters

nmIdstringrequired

Body

application/json

Updated exception reference details

ExceptionReferenceRequest

nmIdstring

Unique identifier for the exception reference

Example:EM.057

exceptionTypestring

Exception Type for the exception reference

Example:Business Exception

businessProcessstring

The business process related to the exception

Example:New Business

categorystring

The category of the exception

Example:Agent

reasonstring

The reason for the exception

Example:Training Status

detailedReasonstring

Detailed description of the reason for the exception

Example:The agent's anti-money laundering training was not complete at time of sale.

Response

application/json

Exception reference updated successfully

ExceptionReferenceModel

nmIdstring

Unique identifier for the exception reference

Example:EM.057

exceptionTypestring

Exception Type for the exception reference

Example:Business Exception

businessProcessstring

The business process in which the exception occurred

Example:New Business

categorystring

The category of the exception

Example:Agent

reasonstring

The reason for the exception

Example:Training Status

detailedReasonstring

Detailed description of the reason for the exception

Example:The agent's anti-money laundering training was not complete at time of sale.

deletedboolean

Indicates whether the exception reference has been deleted

Example:false

createdAtstring(date-time)

The date and time when the exception reference was created

Example:2024-09-17T10:00:00Z

updatedAtstring(date-time)

The date and time when the exception reference was last updated

Example:2024-09-17T12:00:00Z

put/case/v1/exceptionrefs/{nmId}

Body

{}
 
application/json