Search
K
Policy Transactions

MecAuthorizationRequest

object
planCodestring

Plan code (may duplicate path parameter)

Example:IU0101

policyNumberstring

Policy number (may duplicate path parameter)

Example:FIUL713008350

effectiveDatestring(date)

Example:2026-04-09

correlationIdstring(uuid)

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

carrierIdstring

Example:FNWL

valueAdjustmentobject
Show Child Parameters
signaturesarray[object]
Show Child Parameters
documentsarray[object]
Show Child Parameters
supportingDocumentAttachedboolean
Example

TaxWithholdingChangeRequest

object

Request body for tax withholding change (POST /bpm/v1/policies/{planCode}/{policyNumber}/parties/taxwithholding
and validation). Extends transaction case fields with effective date and one or more withholding instruction lines.

planCodestring

Plan code (may duplicate path parameter)

Example:EVIU101

policyNumberstring

Policy number (may duplicate path parameter)

Example:EVIUL7RED012

effectiveDatestring(date)required

Effective date for the tax withholding change

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2026-06-17

correlationIdstring(uuid)

The unique ID to track transaction request across all systems

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

carrierIdstring

Carrier identifier

Example:FNWL

caseIdstring

Zinnia Live Case ID

Example:CA0000007389

taxWithholdingInstructionsarray[object]required

Tax withholding instruction lines for the request

>= 1 items

Show Child Parameters
Example

BillingFeatureChangeTransactionReason

string

Reason for initiating the billing feature change transaction

Allowed values:AMOUNTFREQUENCYPAYMENTDUEDATE

Example

BillingFeatureChangePolicyFeature

object

Billing policy feature details for the change request

featureTypestringrequired

Type of the policy feature

Allowed values:BILLING

Example:BILLING

paymentAmountnumber(double)

Billing payment amount

Example:1000

approvalDatestring(date)

Date on which the feature change was approved

Example:2026-07-24

frequencystring

frequency

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALBIANNUALQUARTERLYANNUALSINGLEPAYMENTDEFAULT

Example

BillingFeatureChangeSignature

object

Signature details for billing feature change

isSignedPresentboolean

Example:true

signDatestring(date)

Example:2026-06-26

signDesignationstring
signTypestring

Signature type code

Example:OWNER

signTypeForUIstring

Signature type label for UI display

Example:Owner

Example