Validate Business Rules for Payee/Payor/Owner/TPD/Beneficiary and Add new Payee/Payor/Owner/ThirdPartyDesignee/PrimaryBeneficiary/ContingentBeneficiary based on the request
Party for which details are being entered. Possible values are - Owner, Payor, Payee, PrimaryBeneficiary, ContingentBeneficiary, ThirdPartyDesignee
Allowed values:PayeePayorOwnerThirdPartyDesigneePrimaryBeneficiaryContingentBeneficiary
Example:Owner
The unique ID to track transaction request across all systems
Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d
Date the Party was added to the Policy
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
TBD
Example:0017b000010N4bCAAS
Option available for Owner, Payor, TPD and Beneficiary
Allowed values:TRUSTEETRUSTEEOFMINORTRUSTEEOFINCOMPETENTPOWEROFATTORNEYCONTROLLINGPERSONOFENTITYBROTHERCHILDDAUGHTERDOMESTICPARTNEREXECUTORSFATHERFIANCEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFOTHER
Zinnia Live Case ID
Example:CA0000007389
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Success
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
Zinnia Live Case ID
Example:CA0000369469
Zinnia Live Case Status
Example:IN_PROGRESS
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
Evaluates whether the policy is eligible for a billing feature change transaction.
Plan Code
Policy Number
Billing Feature Change Eligibility Success Response
Allowed values:successfailure
Validates the billing feature change request against business rules before submission.
Plan Code
Policy Number
Request body for billing feature change validation
(POST /bpm/v1/policies/{planCode}/{policyNumber}/billingfeaturechange/validation
and policy API alias).
Plan code (may duplicate path parameter)
Policy number (may duplicate path parameter)
Zinnia Live Case ID
Example:CA0000007389
The unique ID to track transaction request across all systems
Example:e3bdb22b-790f-4357-ae60-42cdb0ff0d12
Carrier identifier
Example:FNWL
Effective date for the billing feature change
Example:2026-07-24
Reason for initiating the billing feature change transaction
Allowed values:AMOUNTFREQUENCYPAYMENTDUEDATE
Example:AMOUNT
Billing policy feature details for the change request
>= 1 items
Signature details for billing feature change
Supporting document reference for billing feature change
Whether the request originated from a self-serve flow
Example:true
Indicates whether supporting documents are attached
Example:true
Billing Feature Change Validation Success Response
Allowed values:successfailure
If freelook endDate is less than or equal to policy effective Date, cancel the policy based on the request
Policy Number
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Property to isolate source transaction(s) that initiated the reversal
Zinnia Live Case ID
Example:CA0000007389
Success
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
Zinnia Live Case ID
Example:CA0000369469
Zinnia Live Case Status
Example:IN_PROGRESS
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
Policy Number
PartyId for which address need to be updated it be avaible under SOR Policy Details
AddressId for which address need to be updated it be avaible under SOR Policy Details
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
Indicates whether the address being added should be set as default or not.
Allowed values:YESNO
Property to isolate source transaction(s) that initiated the reversal
Default:false
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Zinnia Live Case ID
Example:CA0000007389
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Success
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
Zinnia Live Case ID
Example:CA0000369469
Zinnia Live Case Status
Example:IN_PROGRESS
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