Search
K
New Business - Life

Policy

object
policyNumberstring

If no policy number is provided, Zinnia will generate policy number according to business rules in BPM

Example:1234567890

previousPolicyNumberstring

Previous policy number in case of Policy Conversion

Example:1234567890

planCodestringrequired

Plan code for the policy

Example:TL0101

productTypestringrequired

Type of insurance product

Allowed values:INDEXEDUNIVERSALLIFEUNIVERSALLIFETERM

Example:INDEXEDUNIVERSALLIFE

policyStatusstringrequired

Status of the policy

Allowed values:APPLIEDFORAPPROVEDSUBMITTEDTOUNDERWRITINGPENDINGDECLINEDQUOTEDRISKNOTACCEPTABLENOTTAKENPENDINGISSUEDISSUEDCLOSEDCANCELLEDEXPIREDCONVERSION

Example:ISSUED

policyHoldingFormstring

Policy holding form (Individual, Organization, or Trust)

Allowed values:INDIVIDUALGROUPJOINTINDIVIDUAL

Example:INDIVIDUAL

policyEffectiveDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example:2022-01-01

issueStatestringrequired

Abbreviated names for states

Allowed values:ALAKAZARASAAAEAPCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTMPNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUTUMVTVAVIWAWVWIWY

Example:CA

issueCountrystringrequired

Policy Issue Country

Allowed values:US

Example:US

coverageobjectrequired
Show Child Parameters
ridersarray[object]

List of riders details

Show Child Parameters
featureobject
Show Child Parameters
fundDetailsarray[object]
Show Child Parameters
paymentobjectrequired
Show Child Parameters
Example

PolicyPatch

object
policyNumberstring

If no policy number is provided, Zinnia will generate policy number according to business rules in BPM

Example:1234567890

previousPolicyNumberstring

Previous policy number in case of Policy Conversion

Example:1234567890

planCodestring

Plan code for the policy

Example:TL0101

productTypestring

Type of insurance product

Allowed values:INDEXEDUNIVERSALLIFEUNIVERSALLIFETERM

Example:INDEXEDUNIVERSALLIFE

policyStatusstring

Status of the policy

Allowed values:APPLIEDFORAPPROVEDSUBMITTEDTOUNDERWRITINGPENDINGDECLINEDQUOTEDRISKNOTACCEPTABLENOTTAKENPENDINGISSUEDISSUEDCLOSEDCANCELLEDEXPIREDCONVERSION

Example:ISSUED

policyHoldingFormstring

Policy holding form (Individual, Organization, or Trust)

Allowed values:INDIVIDUALGROUPJOINTINDIVIDUAL

Example:INDIVIDUAL

policyEffectiveDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example:2022-01-01

issueStatestring

Abbreviated names for states

Allowed values:ALAKAZARASAAAEAPCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTMPNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUTUMVTVAVIWAWVWIWY

Example:CA

issueCountrystring

Policy Issue Country

Allowed values:US

Example:US

coverageobject
Show Child Parameters
ridersarray[object]

List of riders details

Show Child Parameters
featureobject
Show Child Parameters
fundDetailsarray[object]
Show Child Parameters
paymentobject
Show Child Parameters
Example

Owner

object
partyIdstring(uuid)required

Unique identifier for the party

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

partyRolestringrequired

Type of party role

Allowed values:OWNERJOINTOWNERCONTINGENTOWNER

Example:OWNER

partyTypestringrequired

Type of party

Allowed values:INDIVIDUALORGANIZATIONTRUST

Example:INDIVIDUAL

relationshipobjectrequired
Show Child Parameters
personalInformationOne Of
required
PersonalInformationOwnerobject
Show Child Parameters
partyCommunicationstringrequired

Allowed values:REGULARMAILEMAILPHONE

Example:REGULARMAIL

identifiersAny Of
array

Array of identifiers for this party

PassportIdentifierobject
Show Child Parameters
addressobjectrequired
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
Example

OwnerPatch

object
partyIdstring(uuid)

Unique identifier for the party

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

partyRolestring

Type of party role

Allowed values:OWNERJOINTOWNERCONTINGENTOWNER

Example:OWNER

partyTypestring

Type of party

Allowed values:INDIVIDUALORGANIZATIONTRUST

Example:INDIVIDUAL

relationshipobject
Show Child Parameters
personalInformationOne Of
PersonalInformationOwnerPatchobject
Show Child Parameters
partyCommunicationstring

Allowed values:REGULARMAILEMAILPHONE

identifiersAny Of
array

Array of identifiers for this party

Example:[]

PassportIdentifierPatchobject
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
Example

OwnerResponse

object
partyIdstring(uuid)

Unique identifier for the party

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

partyRolestring

Type of party role

Allowed values:OWNERJOINTOWNERCONTINGENTOWNER

Example:OWNER

partyTypestring

Type of party

Allowed values:INDIVIDUALORGANIZATIONTRUST

Example:INDIVIDUAL

relationshipobject
Show Child Parameters
personalInformationOne Of
PersonalInformationOwnerResponseobject
Show Child Parameters
partyCommunicationstring

Allowed values:REGULARMAILEMAILPHONE

identifiersAny Of
array

Array of identifiers for this party

Example:[]

PassportIdentifierResponseobject
Show Child Parameters
addressobject
Show Child Parameters
phoneNumberobject
Show Child Parameters
emailobject
Show Child Parameters
Example