AllPolicyFundsResponse
objectShow Child Parameters
Show Child Parameters
Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED
Show Child Parameters
PolicySearchRequest
objectpolicy owner first name
number/subjective id of policy. Optionally, you can partial search if SSN is also using partial search (e.g. *1234)
policy owner last name
policy owner full name. Optionally support partial search
status of policy, needs to be enum
plan code for policy
last time policy was updated
creation time of the policy
Policy owner social security number. SSN should be 9 digits, or the last four (e.g. *1234) when policy number is also last four (partial search)
reference id of the policy, fully unique
line of business to search for, options are LIFE or Annuity Product
list of party ids associated with the policy
Example:4fd32e7aecc24888be9c5418d6dc646a, 2739e8897e7141189ccd366f7d054ff0
Start date for issue date range query in YYYY-MM-DD format
Example:2024-01-01
End date for issue date range query in YYYY-MM-DD format
Example:2024-12-31
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