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

PolicyEvent

object
policyNumberstring

The Policy Number is a unique identifier assigned to a life insurance or annuity contract by the insurance carrier. It serves as the official reference number for tracking, managing, and servicing the policy throughout its lifetime

eventstring

The transaction type of the current policy snapshot

timestampstring(date-time)
versioninteger(int32)
Example