Policy Transactions
PolicyCoverageChangesAddress
objectaddressTypestring
Classification of the address
Allowed values:RESIDENCEMAILINGBUSINESS
Example:RESIDENCE
addressLine1stringrequired
Primary street address line
Example:123 Main St
addressLine2string
Secondary address line
Example:Apt 4B
addressLine3string
Tertiary address line
Example:Apt 4B
citystringrequired
City of the address
Example:San Francisco
statestringrequired
State or province
Example:CA
zipCodestring
Postal/ZIP code
Example:94105
zipCodeExtstring
ZIP+4 extension
Example:4465
countrystringrequired
Country of the address (ISO-3166 alpha-2)
Example:US
Example
PolicyCoverageChangesOneTimePayment
objectOne-time payment accompanying this transaction, present only when the transaction includes a one-time payment
requestedAmountnumber(double)required
Gross amount of the one-time payment being requested
Example:25000
partiesarray[object]required
Payor/party details for this one-time payment
>= 1 items
Show Child Parameters
Example
PolicyCoverageChangesOneTimePaymentParty
objectpartyIdstringrequired
partyId reference identifying the source/payor of this one-time payment; must reference an entry in the transaction’s top-level parties array
Example:Party_PI_1
paymentFormstringrequired
Mode of payment
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEEFT
bankIdstring
Reference identifier of the bank account funding this payment
Example:bank_1
partyRolestringrequired
Role the party plays on the policy for this transaction
Allowed values:INSUREDOWNERBENEFICIARYPAYORTRUSTEE
Example:INSURED
Example
PolicyCoverageChangesIllustration
objectsourcestring
System that generated the illustration supporting the requested change
Allowed values:ZINNIAEXTERNAL
Example:ZINNIA
illustrationIdstring
Unique identifier of the illustration
Example:Q12345
Example
PolicyCoverageChangesParty
objectpartyIdstringrequired
Unique identifier assigned to a party under this transaction; cross-referenced from policyUpdateRequest[].party and payment.party
Example:2ad51ecf-9923-437f-a6f0-70968e464cdb
partyRolestringrequired
Role the party plays on the policy for this transaction
Allowed values:INSUREDOWNERBENEFICIARYPAYORTRUSTEE
Example:INSURED
partyTypestringrequired
Indicates whether the party is a natural person or a non-person entity
Allowed values:INDIVIDUALENTITY
Example:INDIVIDUAL
personalInformationobject
Show Child Parameters
partyCommunicationstring
Preferred communication method for this party
Example:REGULARMAIL
identifiersarray[object]
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
signaturesarray[object]
Show Child Parameters
Example