Case Management
ExceptionResolveRequest
objectRequest to resolve one or more open exceptions on a case, identified by their externalIds. The case itself is identified by the caseId path parameter, not by a field in this body. Resolving more than one externalId in a single request is all-or-none — if any externalId can’t be found under the given caseId, or isn’t eligible for resolution, none are resolved.
externalIdsarray[string]required
The externalIds of the exceptions to resolve. Must all belong to the caseId in the path.
Example:23bfac3e-e082-47ef-8619-97e96b17695d
Example
ExceptionReferenceRequest
objectnmIdstring
Unique identifier for the exception reference
Example:EM.057
exceptionTypestring
Exception Type for the exception reference
Example:Business Exception
messageTypestring
The messageType of the exception.
Example:NIGO
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.
Example
ExceptionReferenceModel
objectnmIdstring
Unique identifier for the exception reference
Example:EM.057
exceptionTypestring
Exception Type for the exception reference
Example:Business Exception
messageTypestring
The messageType of the exception.
Example:NIGO
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
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
Example
ExceptionReferenceModelWithProcessingDetails
objectnmIdstring
Unique identifier for the exception reference
Example:EM.057
exceptionTypestring
Exception Type for the exception reference
Example:Business Exception
messageTypestring
The messageType of the exception.
Example:NIGO
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
processingDetailsarray[object]
List of processing details for the exception reference
Show Child Parameters
deletedboolean
Indicates whether the exception reference has been deleted
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
Example
ExceptionReferenceProcessingDetailModel
objectcarrierstring
The carrier associated with the exception processing detail
Example:SBGC
detailedReasonstring
The detailed reason for the exception
Example:The agent's anti-money laundering training was not complete at time of sale.
processingReasonstring
The processing reason for the exception
Example:AML training incomplete
processingInstructionstring
The processing instruction for the exception
Example:Verify agent training status before proceeding.
processingResolutionstring
The processing resolution for the exception
Example:Agent completed AML training and the case was resumed.
Example