Search
K
Policy

NewLoanRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

Example:2023-01-01

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

Default:false

transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
externalIdentifiersobject
Show Child Parameters
Example

NewLoanQuoteTransactionAmounts

object
requestedAmountnumber
appliedAmountnumber
taxableAmountnumber
amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

disbursementTypestring

Allowed values:GROSSNETNETNET

disbursementPaymentFormstring

Allowed values:DTCCEFTACHCHECKWIRE

Example

NewLoanQuotePayeeOrBeneficiary

object
partyIdstring
allocationPercentagenumber
bankIdstring
paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

disbursementAmountnumber
payeeGrossAmountnumber

Example:20

Example

NewLoanQuoteParty

object
partyRolestring

Allowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNERTHIRDPARTYADMINISTRATORCARRIER

partyIdstring

unique identifier linking the party to the policy

Example:Party_PI_1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

allocationPercentagenumber(double)

The percentage of the total disbursement allocated to the payee

Example:100

bankIdstring

A unique identifier for the financial institution handling the transaction

Example:Bank_1

addressIdstring

A unique identifier for the address associated with the payee or policyholder

Example:1

forBenefitOfOrForFurtherCreditstring

FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)

Example:John Doe

disbursementAmountnumber
payeeGrossAmountnumber(double)

TBD

Example:20

Example

NewLoanQuoteResponse

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
taxWithheldAmountsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
policyobject
Show Child Parameters
Example