PolicyReferenceDataModel
objectnumber/subjective id of policy
Example:127147468264
plan code for policy
Example:11441
product name of policy
Example:Deluxe Universal Life
policy owner first name
Example:Nick
policy owner last name
Example:Burdell
policy owner full name
Example:Nick Burdell
status of policy, needs to be enum
Example:IGO
line of business, usually LIFE or ANNUITY
Example:LIFE
4 character id of carrier, also called clientCode or companyCode
Example:ULPC
Company associated with policyholder
Example:Google
Social security number of policy holder, masked on return
Type of the product
Example:universal
last time policy was updated
creation date of the policy
reference id of the policy, fully unique
Example:3cc99edada4f4a88be77cef53ba0b3fd
list of party ids associated with the policy
Example:4fd32e7aecc24888be9c5418d6dc646a, 2739e8897e7141189ccd366f7d054ff0
Issue date of the policy in YYYY-MM-DD format
Example:2024-09-30
PolicySearchResponse
objectExample:121
Example:1
Example:/policy/v1/policies/search?offset=10&limit=10
array of policy reference data
Show Child Parameters
InstanceExceptionModel
objectException identifier
Example:exc-123
External identifier for the exception
Example:EXT-123
Current status of the exception
Example:Open
Exception category
Example:Documentation
Brief reason for the exception
Example:Missing document
Detailed description of the exception reason
Example:Signature missing on page 3 of application form
Processing reason for the exception
Example:Requires manual review
Resolution details for processing
Example:Document resent by applicant
Date when the exception was created
Example:2023-01-15T10:30:00Z
Date when the exception was last updated
Example:2023-01-16T14:45:00Z
IdentifierDocument
objectType of identifier
Example:SSN
Value of the identifier
Example:123-45-6789
CaseSearchModel
objectType of application
Policy number to search for
Example:POL123456789
List of request sub-types to filter by
List of product names to filter by
Social Security Number of policy owner
Full name of the policy owner
Example:John Doe
First name of policy owner
Example:John
Last name of policy owner
Example:Doe
List of processes to filter by
List of carriers to filter by
Example:SBUL
List of case statuses to filter by
Start date for filtering by case creation date
Example:2023-01-01T00:00:00Z
End date for filtering by case creation date
Example:2023-12-31T23:59:59Z
Start date for filtering by case update date
Example:2023-01-01T00:00:00Z
End date for filtering by case update date
Example:2023-12-31T23:59:59Z
First name of the agent
Example:Jane
Last name of the agent
Example:Smith
Social Security Number of agent
Name of the broker-dealer
Example:ABC Financial Services
List of case IDs to search for
Example:CASE123, CASE456
Field to sort results by
Example:createdAt
Direction of sorting (asc or desc)
Allowed values:ascdesc
Example:desc
Offset for pagination
Example:0
Limit for pagination - number of results to return
Example:25
List of case statuses to exclude from results
Whether to include secondary cases
Example:true
Flag to filter for primary cases only
Example:true
List of exceptions to search for
Show Child Parameters
List of identifiers to search for