Policy Transactions
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
PolicyCoverageChangesPartyRole
stringRole the party plays on the policy for this transaction
Allowed values:INSUREDOWNERBENEFICIARYPAYORTRUSTEE
Example
PolicyCoverageChangesPersonalInformation
objectfirstNamestring
Legal first name of the individual party; mandatory if partyType=INDIVIDUAL
Example:John
middleNamestring
Legal middle name
Example:M
lastNamestring
Legal last name; mandatory if partyType=INDIVIDUAL
Example:Doe
suffixstring
Name suffix
Example:SR
prefixstring
Name prefix/title
Example:MR
dateOfBirthstring(date)
Date of birth; mandatory if partyType=INDIVIDUAL
Example:1990-01-01
genderstring
Gender of the individual party
Allowed values:MALEFEMALEUNKNOWN
Example:MALE
birthSexstring
Birth sex, used for underwriting/rating
Allowed values:MALEFEMALEUNKNOWN
Example:MALE
birthCountrystring
Country of birth (ISO-3166 alpha-2)
Example:US
citizenCountrystring
Country of citizenship (ISO-3166 alpha-2)
Example:US
Example
PolicyCoverageChangesPartyIdentifier
objecttypestring
Type of government or legal identification document
Allowed values:PASSPORTSSNDRIVERSLICENSENATIONALID
Example:PASSPORT
valuestring
Value/number of the identifier
Example:123456789
descriptionstring
Free-text description of the identifier
Example:Passport number
sourcestring
Issuing authority or source
Example:State of California
issueDatestring(date)
Date issued
Example:2015-08-15
expirationDatestring(date)
Date of expiration
Example:2025-08-15
statusstring
Current status of the identifier
Allowed values:ACTIVEEXPIREDINACTIVE
Example:ACTIVE
countryOfIssuestring
Country that issued the identifier (ISO-3166 alpha-2)
Example:US
Example