Search
K
Policy

IdentifierDocument

object
identifierstring

Type of identifier

Example:SSN

valuestring

Value of the identifier

Example:123-45-6789

Example

CaseSearchModel

object
applicationTypestring

Type of application

policyNumberstring

Policy number to search for

Example:POL123456789

requestSubTypearray[string]

List of request sub-types to filter by

productNamearray[string]

List of product names to filter by

ssnstring

Social Security Number of policy owner

ownerNamestring

Full name of the policy owner

Example:John Doe

ownerFirstNamestring

First name of policy owner

Example:John

ownerLastNamestring

Last name of policy owner

Example:Doe

processarray[string]

List of processes to filter by

carrierarray[string]

List of carriers to filter by

Example:SBUL

caseStatusarray[string]

List of case statuses to filter by

createdDateStartstring(date-time)

Start date for filtering by case creation date

Example:2023-01-01T00:00:00Z

createdDateEndstring(date-time)

End date for filtering by case creation date

Example:2023-12-31T23:59:59Z

updatedDateStartstring(date-time)

Start date for filtering by case update date

Example:2023-01-01T00:00:00Z

updatedDateEndstring(date-time)

End date for filtering by case update date

Example:2023-12-31T23:59:59Z

agentFirstNamestring

First name of the agent

Example:Jane

agentLastNamestring

Last name of the agent

Example:Smith

agentSsnstring

Social Security Number of agent

brokerDealerNamestring

Name of the broker-dealer

Example:ABC Financial Services

caseIdsarray[string]

List of case IDs to search for

Example:CASE123, CASE456

sortBystring

Field to sort results by

Example:createdAt

sortDirectionstring

Direction of sorting (asc or desc)

Allowed values:ascdesc

Example:desc

offsetstring

Offset for pagination

Example:0

limitstring

Limit for pagination - number of results to return

Example:25

notInCaseStatusarray[string]

List of case statuses to exclude from results

isIncludeSecondaryboolean

Whether to include secondary cases

Example:true

primaryboolean

Flag to filter for primary cases only

Example:true

exceptionsarray[object]

List of exceptions to search for

Show Child Parameters
identifiersarray[object]

List of identifiers to search for

Show Child Parameters
Example

CaseInstanceStageSummary

object
idstring

Stage identifier

Example:stage-123

labelstring

Display label for the stage

Example:Document Review

stageStatusstring

Current status of the stage

Example:Completed

Example

PartyDetailsModel

object
partyRolestring

Role of the party in the case

Example:Owner

partyTypestring

Type of party

Example:Individual

firstNamestring

First name of the party

Example:John

middleNamestring

Middle name of the party

Example:A

lastNamestring

Last name of the party

Example:Doe

fullNamestring

Full name of the party

Example:John A Doe

prefixstring

Name prefix

Example:Mr

suffixstring

Name suffix

Example:Jr

genderstring

Gender of the party

Example:Male

ssnstring

Social Security Number (masked)

Example:XXX-XX-1234

percentstring

Percentage value associated with the party

Example:50

externalIdstring

External identifier for the party

Example:EXT-PARTY-123

Example

CaseInstanceSummaryModel

object
idstring

Case instance identifier

Example:case-123

templateIdstring

Template identifier used for the case

Example:template-456

carrierstring

Insurance carrier name

Example:Acme Insurance

processstring

Process name

Example:New Business

parentInstanceIdstring

Parent instance identifier

Example:parent-case-789

correlationIdstring

Correlation identifier

Example:corr-123

caseStatusstring

Current status of the case

Example:In Progress

processSubTypestring

Process sub-type

Example:New Application

policyNumberstring

Policy number

Example:POL123456789

productNamestring

Name of the insurance product

Example:Term Life 20

primarybooleanrequired

Indicates if this is a primary case

Example:true

deletedbooleanrequired

Indicates if the case has been deleted

stagesarray[object]

List of case stages

Show Child Parameters
additionalDataobjectrequired

Additional data associated with the case

Example:{"key1":"value1","key2":"value2"}

identifiersarray[object]required

List of identifiers for the case

Show Child Parameters
createdAtstring

Date when the case was created

Example:2023-01-15T10:30:00Z

updatedAtstring

Date when the case was last updated

Example:2023-01-16T14:45:00Z

partiesarray[object]

List of parties involved in the case

Show Child Parameters
exceptionsarray[object]

List of exceptions associated with the case

Show Child Parameters
applicationTypestring

Type of application

Example:policy

caseResultstring

Result of the case processing

Example:Approved

caseResultDetailstring

Detailed result information

Example:Approved with standard rates

Example