Search
K
Policy

IriPolicyParty

object
typestringrequired

Type of party.

Allowed values:individualentity

firstNamestring

First name of the individual party.

>= 1 characters<= 100 characters

Example:John

middleNamestring

Middle name of the individual party.

>= 1 characters<= 100 characters

Example:Q

lastNamestring

Last name of the individual party.

>= 1 characters<= 100 characters

Example:Public

namestring

Entity name of the party.

>= 1 characters<= 100 characters

Example:Public Family Trust

taxIdstringrequired

Tax identification number for the party.

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

>= 9 characters<= 9 characters

Example:123456789

relationshipsarray[string]required

Relationships the party has to the policy.

Allowed values:ownerjointOwnerannuitantjointAnnuitantprimaryBeneficiarycontingentBeneficiary

>= 1 items<= 6 items

paymentFormstring

Party-level payment form for the systematic program.

Allowed values:DTCCACHCHECKWIREEXCHANGE

allocationPercentagenumber

Percentage share assigned to the party.

>= 0<= 100

Example:100

bankobject

Financial institution details.

Show Child Parameters
addressobject

Physical or mailing address details.

Show Child Parameters
phonesarray[object]

Phone numbers associated with the party.

Show Child Parameters
emailsarray[object]

Email addresses associated with the party.

Show Child Parameters
identificationsarray[object]

Identifications associated with the party.

Show Child Parameters
taxWithholdingInstructionsarray[object]

Tax withholding instructions associated with the party.

Show Child Parameters
deathDetailsobject

Death details associated with the party.

Show Child Parameters
Example

IriPolicyParties

object
startIndexnumberrequired

Used for pagination to indicate where the returned page starts within the full result set.

>= 0

itemsCountnumberrequired

Number of records included in the current response page.

>= 0

Example:1

totalItemsCountnumberrequired

Total number of records available that match the request criteria, independent of pagination.

>= 0

Example:1

partiesarray[object]required

Individuals or entities associated with the policy, including identity, relationship, and servicing instructions.

Show Child Parameters
Example

IriRiderType

string

Classification of the rider.

Allowed values:BASERIDERINTEGRATED_RIDERBENEFIT_RIDERINCOME_RIDERDEATH_BENEFIT_RIDERLTC_RIDERGMWB_RIDERGMDB_RIDERGMAB_RIDERCHARGE_RIDERDISCOUNTBASE_INCREASERIDER_INCREASEOTHERUNKNOWN

IriUnderwritingStatus

string

Underwriting decision for the rider.

Allowed values:APPROVEDDECLINED

IriRiderStatus

string

Current status of the rider.

Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED