Search
K
Policy

Arrangements

object
attributesobjectrequired
Show Child Parameters
taxWithHoldingarray[object]required
Show Child Parameters
paymentsarray[object]required
Show Child Parameters
feesarray[object]required
Show Child Parameters
arrangementSourcesarray[object]required
Show Child Parameters
loanSegmentsarray[object]required
Show Child Parameters
matchSegmentobjectrequired
Show Child Parameters
deathClaimobjectrequired
Show Child Parameters
Example

LPSPayloadResponse

object
attributesobjectrequired

Attributes

Show Child Parameters
accountValueobjectrequired

Account Value

Show Child Parameters
testValueobjectrequired

Test Value

Show Child Parameters
deathBenefitobjectrequired

Death Benefit

Show Child Parameters
coverageValueobjectrequired

Coverage Value

Show Child Parameters
coveragesarray[object]required

Array of Coverages

Show Child Parameters
partiesarray[object]required

Array of Parties

Show Child Parameters
policyFeeobjectrequired

Policy Fee

Show Child Parameters
featuresobjectrequired

Features

Show Child Parameters
fundAllocationsarray[object]required

Array of Fund Allocations

Show Child Parameters
fundsarray[object]required

Array of Funds

Show Child Parameters
matchSegmentobjectrequired

Match Segment

Show Child Parameters
loanSegmentsarray[object]required

Array of Loan Segments

Show Child Parameters
arrangementsarray[object]required

Array of Arrangements

Show Child Parameters
Example

PolicyFeatureRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)

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

Example:2023-01-01

reverseInitiatornumber

Allowed values:true

policyFeaturesarray[object]
Show Child Parameters
Example

PhoneChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

isPreferredPhonestring

This field is deprecated and will be removed in a future version. Please use phone.isPreferred instead.

Allowed values:YESNO

preferredPhoneIdstring

The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party

Example:1

effectiveDatestring(date)

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

Example:2023-01-01

phoneobject
Show Child Parameters
Example

EmailChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

isPreferredEmailstringDEPRECATED

This field is deprecated and will be removed in a future version. Please use email.isPreferred instead.

Allowed values:YESNO

preferredEmailIdstring

The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file.

Example:1

effectiveDatestring(date)

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

Example:2023-01-01

emailobject
Show Child Parameters
Example