Policy Transactions
Manage Rider Eligibility Check
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Response
application/json
Response
application/json
Manage Rider Eligibility Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/managerider/eligibilitycheck
Authentication
Path Parameters
application/json
Validate Manage Rider Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
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
Response
application/json
Manage Rider Validation Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/managerider/validation
Authentication
Path Parameters
Body
{
"riders": [
{}
]
}
application/json
Submit Manage Rider Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
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
Response
application/json
Submit Transaction Successful
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
pdfIdstring
Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.
Example:DOC-10004567
post/policy/v1/transactions/{planCode}/{policyNumber}/managerider
Authentication
Path Parameters
Body
{
"riders": [
{}
]
}
application/json
FullSurrender Eligibility Check endpoint
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
FullSurrenderRequest
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
overrideboolean
BPM will have to override the rules if this variable is marked as true
taxWithholdingInstructionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
transactionAmountsobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Full Surrender Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/fullsurrender/eligibilitycheck
Authentication
Path Parameters
Body
{}
application/json
Fullsurrender Validation Endpoint
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
FullSurrenderRequest
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
overrideboolean
BPM will have to override the rules if this variable is marked as true
taxWithholdingInstructionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
transactionAmountsobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Full Surrender Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/fullsurrender/validation
Authentication
Path Parameters
Body
{}
application/json