Search
K
Policy

PolicyReferenceDataModel

object
policyNumberstringrequired

number/subjective id of policy

Example:127147468264

planCodestring

plan code for policy

Example:11441

productNamestring

product name of policy

Example:Deluxe Universal Life

firstNamestring

policy owner first name

Example:Nick

lastNamestring

policy owner last name

Example:Burdell

fullNamestring

policy owner full name

Example:Nick Burdell

policyStatusstring

status of policy, needs to be enum

Example:IGO

lineOfBusinessstring

line of business, usually LIFE or ANNUITY

Example:LIFE

carrierIdstring

4 character id of carrier, also called clientCode or companyCode

Example:ULPC

companyNamestring

Company associated with policyholder

Example:Google

ssnstring

Social security number of policy holder, masked on return

productTypestring

Type of the product

Example:universal

lastUpdatedstring(date-time)

last time policy was updated

createdAtstring(date-time)required

creation date of the policy

idstring

reference id of the policy, fully unique

Example:3cc99edada4f4a88be77cef53ba0b3fd

partyIdsarray[string]

list of party ids associated with the policy

Example:4fd32e7aecc24888be9c5418d6dc646a, 2739e8897e7141189ccd366f7d054ff0

issueDatestring(date)

Issue date of the policy in YYYY-MM-DD format

Example:2024-09-30

Example

PolicySearchResponse

object
totalnumberrequired

Example:121

countnumberrequired

Example:1

nextstringrequired

Example:/policy/v1/policies/search?offset=10&limit=10

previousstringrequired
resultsarray[object]required

array of policy reference data

Show Child Parameters
Example

InstanceExceptionModel

object
idstring

Exception identifier

Example:exc-123

externalIdstring

External identifier for the exception

Example:EXT-123

statusstring

Current status of the exception

Example:Open

categorystring

Exception category

Example:Documentation

reasonstring

Brief reason for the exception

Example:Missing document

detailedReasonstring

Detailed description of the exception reason

Example:Signature missing on page 3 of application form

processingReasonstring

Processing reason for the exception

Example:Requires manual review

processingResolutionstring

Resolution details for processing

Example:Document resent by applicant

createdAtstring

Date when the exception was created

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

updatedAtstring

Date when the exception was last updated

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

Example

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