Policy Transactions

Zinnia Policy Transactions API.

1.0.9OAS 3.1

Enterprise API for enforcing policy transactions and validations. This API provides a comprehensive interface for - Policy transaction validation and processing
- Financial and non-financial transaction management
- Policy party management and updates
- Systematic program management
Version History * Draft version 1.0.6
- Added Two Endpoints- Reinstatement eligibility check api, Reinstatement actual transaction api
* Draft Specifications (Subject to Change Upon Review)

API Base URL
  • Server 1:https://dev.api.zinnia.io

    DEV Environment

  • Server 2:https://qa.api.zinnia.io

    QA Environment

Security
Auth0 (openIdConnect)

Financial Transactions

Financial Transactions

base coverage update

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Response

application/json

basecoverageupdate Eligibility Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/basecoverageupdate/eligibilitycheck
 
application/json

Manage Rider Eligibility Check

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Response

application/json

Manage Rider Eligibility Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/managerider/eligibilitycheck
 
application/json

Validate Manage Rider Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Body

application/json

ManageRiderRequest

Self-serve request body for manage rider eligibility, validation, and submit endpoints
(POST /bpm/v1/policies/{planCode}/{policyNumber}/managerider/eligibilitycheck,
/managerider/validation, and /managerider). Assumes all referenced parties and rider
participants already exist on the policy, identified by partyId only.

correlationIdstring

The unique ID to track transaction request across all systems

Example:e3bdb22b-790f-4357-ae60-42cdb0ff0d12

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

Default:false

externalIdentifiersobject
Show Child Parameters
transactionReasonstring

Reason for initiating the manage rider transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCENOTRANSACTIONREASONSTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESSDATEOFDEATHINITIALDEATHNOTIFICATIONPRODUCTDEFAULTAMOUNTGWBRIDERDISBURSEMENTGWBPHASECHANGEFREQUENCYPREMIUMLOANPAYMENTDUEDATERIDERUPDATEGLWBACTUARIALPRESENTVALUEJUVENILETOADULT

Example:RIDERUPDATEGLWB

ridersarray[object]required

A single rider being added, updated, or removed on the policy

Show Child Parameters
partiesarray[object]

A payee or owner party referenced for the rider’s payout (self-serve; party already exists on the policy)

Show Child Parameters

Response

application/json

Manage Rider Validation Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/managerider/validation

Body

{ "riders": [ {} ] }
 
application/json