Policy Transactions
EligibilityV3CheckResult
objectEligibility check result for a transaction, action, and target combination.
eligibilityTypestringrequired
Type of eligibility check.
Allowed values:POLICYUSERRESTRICTION
actionstringrequired
Action being evaluated.
Allowed values:ADDUPDATEDELETEINCREASEDECREASENOT_APPLICABLE
targetobjectrequired
The target of the eligibility check.
Show Child Parameters
eligiblebooleanrequired
Whether the action is eligible for the target.
reasonsarray[object]
Structured reason for an ineligible transaction.
Show Child Parameters
Example
EligibilityV3Target
objectThe target of the eligibility check.
typestringrequired
Target type.
Allowed values:RIDERCOVERAGEBENEFIT_OPTIONTRANSACTION
codestringrequired
Target code or identifier.
Example:CITR
Example
EligibilityV3Reason
objectStructured reason for an ineligible transaction.
codestring
Machine-readable reason code.
Example:BPM.NM.050
messagestring
Human-readable explanation.
Example:The effective date entered is not within this policy's free look period.
resolutionstring
Suggested remediation.
Example:Update the effective date (if possible), or submit for NIGO processing.
Example
IdentifierInstance
objectAn object representing an identifier and its corresponding value.
identifierstring
The type of identifier.
Allowed values:eAppIdpolicyNumber
valuestring
The value of the identifier.
Example:ABC123349257367
Example
CreateCaseRequest
objectplanCodestringrequired
Product code provided by the Zinnia system
Example:ABC001
policyNumberstring
In case of Post Issue Policy Number will be mandatory
Example:EVGL1234567
correlationIdstring
The correlationId associated with the case.
Example:218d8992-3783-42ac-b59a-66cbc36adaab
caseTypestringrequired
The type associated with the case.
Allowed values:ReinstatementNew Business
Example:Reinstatement
caseSubTypestringrequired
The type associated with the case.
Allowed values:ReinstatementLife Application
Example:Reinstatement
identifiersarray[object]required
An object representing an identifier and its corresponding value.
Show Child Parameters
Example