Policy Transactions
PolicyCoverageChangesUnderwriting
objectUnderwriting decision evaluated for this policy update, present when an underwriting case was evaluated
underwritingCaseIdstringrequired
Identifier of the underwriting case evaluated for this policy update
Example:CA1234567890
decisionstringrequired
Underwriting decision rendered for the requested change
Allowed values:APPROVEDDECLINEDPOSTPONED
Example:APPROVED
statusstringrequired
Case-level underwriting status classification
Allowed values:CLEAN_CASEFLAGGED_CASE
Example:CLEAN_CASE
underwritingSourceNamestring
Name of the underwriting engine/source
Example:Source Details
underwritingRiskClassstring
Risk classification assessed by underwriting
Allowed values:ULTRANONTOBACCOELITENONTOBACCOPREFERREDNONTOBACCOSTANDARDNONTOBACCOSTANDARDTOBACCOSTANDARDAGGREGATESUBSTANDARDNONTOBACCOSUBSTANDARDTOBACCOSTANDARDPLUSNONTOBACCOPREFERREDTOBACCOSTANDARDCONVERSIONNONTOBACCOSTANDARDCONVERSIONTOBACCO
Example:ULTRANONTOBACCO
decisionRiskClassstring
Risk classification assessed by underwriting
Allowed values:ULTRANONTOBACCOELITENONTOBACCOPREFERREDNONTOBACCOSTANDARDNONTOBACCOSTANDARDTOBACCOSTANDARDAGGREGATESUBSTANDARDNONTOBACCOSUBSTANDARDTOBACCOSTANDARDPLUSNONTOBACCOPREFERREDTOBACCOSTANDARDCONVERSIONNONTOBACCOSTANDARDCONVERSIONTOBACCO
Example:ULTRANONTOBACCO
underwritingMethodstring
Underwriting method applied
Allowed values:FULLUNDERWRITINGSIMPLIFIEDISSUEGUARANTEEDISSUEACCELERATEDUNDERWRITING
Example:FULLUNDERWRITING
tobaccoPremiumBasisstring
Tobacco/nicotine rating basis
Allowed values:SMOKERNONSMOKER
Example:SMOKER
approvedFaceAmountnumber(double)
Face amount approved by underwriting; required when a policyUpdateRequest item affects face amount (BASECOVERAGEUPDATE, RIDERADD)
Example:250000
approvedFaceAmountMaximumnumber(double)
Maximum face amount underwriting will allow; required when a policyUpdateRequest item affects face amount (BASECOVERAGEUPDATE, RIDERADD)
Example:250000
ridersarray[object]
Show Child Parameters
exclusionReviewarray[object]
Show Child Parameters
Example
PolicyCoverageChangesUnderwritingRider
objecttypestring
Rider product/plan code
Allowed values:Rider_OWPRider_ABRTRMRider_CTRRider_ABRCHRRider_ADRRider_WPRRider_CGRRider_GIBRRider_OPRRider_OWDRRider_WDRRider_NHRRider_ABRCRI
Example:Rider_ABRTRM
approvedRiderFaceAmountMaximumnumber(double)
Maximum face amount approved for the rider
Example:100000
Example
PolicyCoverageChangesExclusionReview
objectdescriptionstring
Description of the exclusion reviewed
Example:Aviation Activities
reasonCodestring
Coded reason for the exclusion reviewed
Allowed values:AVIATIONAVOCATIONMILITARYOTHER
Example:AVIATION
Example
PolicyCoverageChangesIdentifierDocument
objectBusiness identifier associated with the case, using Zinnia’s existing {identifier, value} convention
identifierstringrequired
Type/name of the business identifier (e.g. zlCaseId, policyNumber; extensible)
Example:zlCaseId
valuestringrequired
Value of the identifier
Example:CA0001296422
Example
OnetimeRmdRequest
objectcaseIdstring
Zinnia Live Case ID
Example:CA0000007389
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)
Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
externalIdentifiersobject
Show Child Parameters
transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
chargesarray[object]
Show Child Parameters
Example