Search
K
Policy

ApiRequestHeader

object
externalIdstringrequired
externalUserIdstringrequired
externalSystemIdstringrequired
externalUserCompHrchyIdstringrequired
muleCorrelationIdstringrequired
timestampstring(date-time)required
apiRequestUUIDstringrequired
apiNamestringrequired
externalTransactionNamestringrequired
clientCodestringrequired
externalUserIDValidbooleanrequired
Example

PolicyCommonRequest

object
contractNumbernumberrequired
companyIdnumberrequired
companyHierarchyIdnumberrequired
planCodestringrequired
policyNumbernumberrequired
cvgIdnumberrequired
Example

FundDetail

object
chAccountDescstringrequired
chDivisionDescstringrequired
chAccountDivisionDescstringrequired
inAccTypenumberrequired
inDivTypenumberrequired
chAccountstringrequired
chDivisionstringrequired
Example

AllPolicyFundsResponse

object
apiRequestHeaderobjectrequired
Show Child Parameters
policyCommonRequestobjectrequired
Show Child Parameters
statusstringrequired

Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED

fundDetailsarray[object]required
Show Child Parameters
Example

PolicySearchRequest

object
firstNamestring

policy owner first name

policyNumberstring

number/subjective id of policy. Optionally, you can partial search if SSN is also using partial search (e.g. *1234)

lastNamestring

policy owner last name

fullNamestring

policy owner full name. Optionally support partial search

policyStatusstring

status of policy, needs to be enum

planCodestring

plan code for policy

lastUpdatedstring(date-time)

last time policy was updated

createdAtstring(date-time)

creation time of the policy

ssnstring

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)

idstring

reference id of the policy, fully unique

lineOfBusinessstring

line of business to search for, options are LIFE or Annuity Product

partyIdsarray[string]

list of party ids associated with the policy

Example:4fd32e7aecc24888be9c5418d6dc646a, 2739e8897e7141189ccd366f7d054ff0

issueDateFromstring(date)

Start date for issue date range query in YYYY-MM-DD format

Example:2024-01-01

issueDateTostring(date)

End date for issue date range query in YYYY-MM-DD format

Example:2024-12-31

Example