Search
K
New Business - Life

Beneficiaries

object
primaryarray[object]required

List of primary beneficiaries

Show Child Parameters
contingentarray[object]

List of contingent beneficiaries

Show Child Parameters
Example

BeneficiariesPatch

object
primaryarray[object]

List of primary beneficiaries

Show Child Parameters
contingentarray[object]

List of contingent beneficiaries

Show Child Parameters
Example

BeneficiaryDetail

object
partyIdstring(uuid)required

Reference to the beneficiary party ID

Example:5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f

percentageintegerrequired

Percentage share of the benefit

>= 0<= 100

Example:50

irrevocableboolean

Indicates if the beneficiary designation is irrevocable

Example:true

Example

BeneficiaryDetailPatch

object
partyIdstring(uuid)

Reference to the beneficiary party ID

Example:5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f

percentageinteger

Percentage share of the benefit

>= 0<= 100

Example:50

irrevocableboolean

Indicates if the beneficiary designation is irrevocable

Example:true

Example

PaymentV2

object
referenceNumberstringrequired

Example:5f2e0c1a-6b3d-4d3f-8b7f-3f7b6d5e4c3a

methodstringrequired

Allowed values:CREDITCARDACHCHECKWIREEXCHANGEDTCC

Example:ACH

frequencystringrequired

Frequency of premium payments

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT

Example:MONTHLY

amountnumber(double)required

Example:250000

automaticPaymentbooleanrequired

Default:true

Example:true

draftDatestring(date)required

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

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

Example:2023-01-01

paymentDatestring(date)required

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

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

Example:2023-01-01

externalTransactionIdstring

Transaction ID from external system

Example:A12345

externalArrangementIdstring

Arrangement ID from external system

Example:B45678

partyarray[string]

Associated PartyIds for given payment

Example:5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f

bankInformationobject
Show Child Parameters
Example