---
title: "NewLoanRequest"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/NewLoanRequest"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# NewLoanRequest

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    AdhocTransactionAmount:
      type: object
      properties:
        requestedAmount:
          type: number
          format: double
          example: 1000
          description: The initial premium amount (deposit amount) paid by the party
        amountType:
          $ref: "#/components/schemas/AmountType"
        disbursementType:
          $ref: "#/components/schemas/DisbursementType"
        disbursementPaymentForm:
          $ref: "#/components/schemas/DisbursementPaymentForm"
        distributionCode:
          $ref: "#/components/schemas/DistributionCode"
        loanType:
          $ref: "#/components/schemas/LoanType"
        loanInterestType:
          $ref: "#/components/schemas/LoanInterestType"
        accountNumber:
          type: string
          example: "123456789"
          description: The unique identifier representing the policy or account associated
            with the transaction for DTCC money movement.
        participantId:
          type: string
          example: DTCC12345
          description: The DTCC Participant ID (also known as DTCC Number or Participant
            Number) assigned by DTCC to financial institutions.
    AdhocFundAllocation:
      type: object
      properties:
        allocationOption:
          $ref: "#/components/schemas/AllocationOption"
        amountType:
          $ref: "#/components/schemas/AmountType"
    AdhocTaxWithholdingInstructions:
      type: object
      properties:
        appliesToPartyId:
          type: string
          description: Party ID at Policy Level that comes in from External source (for
            Everly it will be Acord 103). This ties to the Party Type this tax
            withholding corresponds to.
          example: Party_PI_1
        taxWithholdingType:
          $ref: "#/components/schemas/TaxWithholdingType"
        effectiveDate:
          type: string
          format: date
          example: 2024-01-01
          description: Date on which the tax withholding instruction becomes effective for
            the party.
        endDate:
          type: string
          format: date
          example: 2024-12-31
          description: Date on which the tax withholding instruction is no longer
            applicable for the party.
        taxRateToUse:
          $ref: "#/components/schemas/TaxRateToUse"
        filingStatus:
          $ref: "#/components/schemas/FilingStatus"
        dollar:
          type: number
          description: The dollar amount of tax withheld
          format: double
          example: 0
        percentage:
          type: number
          description: The percentage amount of tax withheld
          format: double
          example: 0
        exemptions:
          type: number
          description: The total exemptions claimed for tax purposes
          format: int32
          example: 0
        taxJurisdiction:
          type: string
          description: This is not input field i.e. user does not select or set this
            value. For Tax Withholding Type = State , DAML will set this value
            using PartyLevelAddressCountry_PartyLevelAddressState referring to
            ACCORD standard. For Tax Withholding Type = Federal , DAML will set
            this value using PartylevelAddressCountry using ACCORD standard.For
            FedeFor MVP, NRA jurisdictions are out of scope
          example: USA_WY
        contribution:
          $ref: "#/components/schemas/Contribution"
        taxFormType:
          $ref: "#/components/schemas/TaxFormType"
        w4p:
          $ref: "#/components/schemas/W4P"
        partyRole:
          $ref: "#/components/schemas/PartyRole"
    Charge:
      type: object
      properties:
        chargeType:
          $ref: "#/components/schemas/TransactionChargeType"
        chargeWaiverIndicator:
          $ref: "#/components/schemas/ChargeWaiverIndicator"
        chargeWaiverReason:
          type: string
          description: The reason why a charge was waived (e.g., Promotional Waiver,
            Policy Exception)
          example: "100"
        partyId:
          type: string
          description: The partyId to which the charge is applied.
          example: Party_PI_1
    PayeeOrBeneficiary:
      type: object
      properties:
        partyId:
          type: string
          description: A unique identifier linking the party to the policy
          example: Party_PI_1
        paymentForm:
          $ref: "#/components/schemas/PaymentForm"
        allocationPercentage:
          type: number
          description: The percentage of the total disbursement allocated to the payee
          example: 100
          format: double
        bankId:
          type: string
          example: Bank_1
          description: A unique identifier for the financial institution handling the
            transaction
      required:
        - allocationPercentage
    AdhocDisbursementParty:
      type: object
      properties:
        partyRole:
          $ref: "#/components/schemas/PartyRole"
        partyId:
          type: string
          description: unique identifier linking the party to the policy
          example: Party_PI_1
        paymentForm:
          $ref: "#/components/schemas/PaymentForm"
        allocationPercentage:
          type: number
          description: The percentage of the total disbursement allocated to the payee
          example: 100
          format: double
        bankId:
          type: string
          description: A unique identifier for the financial institution handling the
            transaction
          example: Bank_1
        addressId:
          type: string
          description: A unique identifier for the address associated with the payee or
            policyholder
          example: "1"
        forBenefitOfOrForFurtherCredit:
          type: string
          description: 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
        forBenefitOfOrForFurtherCreditIndicator:
          type: boolean
          example: true
          description: Indicates whether the outgoing funds are being requested for the
            benefit of or for further credit to another person or organization.
    AdhocExternalIdentifiers:
      type: object
      properties:
        referenceNumber:
          type: string
          description: The unique payment reference number for all premium-related
        externalTransactionId:
          type: string
          description: The unique ID to identify transaction on carrier side
    Suppression:
      type: object
      properties:
        suppressionType:
          $ref: "#/components/schemas/SuppressionType"
        suppressionReason:
          type: string
          description: Specifies the specific reason or justification for applying the
            suppression. It explains why the suppression was applied.
    AmountType:
      type: string
      enum:
        - AMOUNT
        - PERCENTAGE
        - MAX
        - FREEWITHDRAWALAMOUNT
        - WITHDRAWALUNTILBASIS
        - EARNINGSONLY
        - PRORATA
        - PERCENT
        - MODIFIEDEARNINGSONLY
        - SUNINCOMEMAXIMIZERONLYLBRMAXIMUM
        - SUNINCOMEMAXIMIZERNETONETIMEACCESS
        - NONSUNINCOMEMAXIMIZERLBRSWDMAXIMUM
        - SUNINCOMEMAXIMIZERGROSSONETIMEACCESS
        - YEARTODATEFIXEDEARNINGS
        - EARNINGSLIQUIDITYFIRST
        - EARNINGSLIQUIDITYLAST
        - GUARANTEEDWITHDRAWALBENEFIT
        - FIXEDMODIFIEDEARNINGS
        - ACCUMULATEDEARNINGS
        - LIFEEXPECTANCY
        - DEFAULT
    DisbursementType:
      type: string
      enum:
        - GROSS
        - NET
        - NETNET
    DisbursementPaymentForm:
      type: string
      enum:
        - DTCC
        - EFT
        - ACH
        - CHECK
        - WIRE
    DistributionCode:
      type: string
      enum:
        - DEFAULT
        - PREMATUREDISTRIBUTION
        - EXCEPTIONAPPLIES
        - DISABILITY
        - DEATH
        - DEATHEXCLUSION
        - DEATHROLLOVER
        - EXCHANGE1035
        - NORMALDISTRIBUTION
        - COSTOFCURRENTLIFEINSURANCEPROTECTION
        - QUALIFIEDROLLOVER
        - ROTHDISTRIBUTIONNOEXCEPTION
        - QUALIFIEDLOANDISTRIBUTION
        - PREMATURELOANDISTRIBUTION
        - QUALIFIEDROTHINDIVIDUALRETIREMENTARRANGEMENTDISTRIBUTION
        - ROTHINDIVIDUALRETIREMENTACCOUNTSDISTRIBUTIONEXCEPTIONAPPLIES
        - EXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSTAXABLEIN2009
        - NONTAXABLEEVENT
        - GROSSPAIDTOATTORNEY
        - OTHERINCOME
        - NONEMPLOYEECOMPENSATION
        - PREMATUREEXCEPTION
        - ROYALTIES
        - DEATHTRANSFER4H
        - PROHIBITEDTRANSACTION
        - TENYEARTAXOPTION
        - TRUSTEETOTRUSTEETRANSFER
        - QUALIFIEDDOMESTICRELATIONSORDERLIKETOLIKENO1099
        - DISTRIBUTIONSUNDEREMPLOYEEPLANSCOMPLIANCERESOLUTIONSYSTEM
        - CHARITABLEGIFT
        - LOANSASDISTRIBUTIONS
        - QUALIFIEDPLANLOANOFFSET
        - RECHARACTERIZEDINDIVIDUALRETIREMENTARRANGEMENTCURRENTYEAR
        - EXCESSCONTRIBUTION1YEARPRIORTAX
        - RECHARACTERIZEDINDIVIDUALRETIREMENTACCOUNTSPREVIOUSYEAR
        - EARLYDISTRIBUTIONFROMSAVINGSINCENTIVEMATCHPLANFOREMPLOYEES
        - DIRECTTRANSFER
        - EXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSANDOREARNINGSTAXABLEIN2024
        - EXCESSCONTRIBUTIONS2YEARPRIORTAX
        - DIRECTROLLOVERQUALPLANTAXSHELTEREDANNUITY
        - SEPARATIONFROMSERVICE
        - INDIVIDUALRETIREMENTARRANGEMENTTOROTHINDIVIDUALRETIREMENTARRANGEMENT
        - QUALIFIEDDOMESTICRELATIONSORDERROLLOVERTOINDIVIDUALRETIREMENTARRANGEMENT2G
        - QUALIFIEDDOMESTICRELATIONSORDERPAYMENTTOSPOUSE
        - FIRSTTIMEHOMEBUYERINDIVIDUALRETIREMENTARRANGEMENTONLY
        - EDUCATIONEXPENSE
        - MEDICALEXPENSE
        - FEEADMIN
        - FEEASSET
        - FEECONTRIBUTION
        - FEELUMPSUMDEATH
        - FEELUMPSUMDISABILITY
        - FEELUMPSUMPURCHASEDANNUITY
        - FEELUMPSUMOTHER
        - FEENEWRETIREEWITHPERPAYMENT
        - FEEEXISTINGRETIREMENTINFORCE
        - FEECONTRACT
        - FEEEXISTINGRETIREMENTINCREASE
        - FEETHIRDPARTY
        - LUMPSUMDEATH
        - LUMPSUMDISABILITY
        - LUMPSUMPURCHASEDANNUITY
        - LUMPSUMOTHER
        - FEEINTERNATIONALPROGRAMSGROUPEXPENSE
        - FROMFUND
        - RELEASERESERVE
        - HEALTHDEDUCTION
        - FEEMARKETVALUE
        - FEEANNUITYADMINISTRATION
        - SECTION1035EXCHANGEPARTIAL
        - QUALIFIEDDOMESTICRELATIONSORDERNORMALDISTRIBUTION
        - QUALIFIEDDOMESTICRELATIONSORDERSECTION1035
        - FEELONGTERMCAREINSURANCE
        - DESIGNATEDROTHACCOUNTDISTRIBUTION
        - REPORTABLEDEATHBENEFITSUNDERSECTION6050Y
        - DISTRIBUTIONOFTRADITIONALINDIVIDUALRETIREMENTARRANGEMENTASSETSNOTHAVINGAREADILYAVAILABLEFAIRMARKETVALUE
        - DIVIDENDSDISTRIBUTEDFROMANEMPLOYEESTOCKOWNERSHIPPLANSUNDERSECTION404K
        - DIRECTROLLOVEROFADESIGNATEDROTHACCOUNT
        - DEATHQUALIFIEDCHARITABLEDISTRIBUTION
        - NORMALQUALIFIEDCHARITABLEDISTRIBUTION
    LoanType:
      type: string
      enum:
        - PREFERRED
        - NONPREFERREDSTANDARDLOAN
        - INDEXLOAN
    LoanInterestType:
      type: string
      enum:
        - FIXED
        - INDEXED
        - VARIABLE
        - ADJUSTABLE
    AllocationOption:
      type: string
      enum:
        - PRORATA
        - DOLLAR
        - SPECIFYPERCENTAGE
        - SPECIFIEDFUNDS
        - SPECIFIEDSEGMENTS
        - DEFAULT
        - PECKINGORDER
        - EARNINGSONLY
        - SPECIFICFUNDPERCENTAGE
        - FIXEDONLY
        - VARIABLEONLY
        - CURRENTHOLDINGS
    TaxWithholdingType:
      type: string
      enum:
        - FEDERAL
        - STATE
        - NRA
        - BACKUP
    TaxRateToUse:
      type: string
      enum:
        - NOWITHHOLDINGELECTED
        - USEVALUESENTERED
        - NOWITHHOLDINGALLOWED
        - USEDEFAULTTABLE
        - ADDITIONALWITHHOLDING
        - TAKEINPUTTEDVALUE
    FilingStatus:
      type: string
      enum:
        - SINGLE
        - DOMESTICPARTNERSHIP
        - DEFAULT
        - MARRIED
        - HEADOFHOUSEHOLD
        - WIDOWED
        - DIVORCED
        - MARRIEDFILINGSEPARATELY
    Contribution:
      type: string
      enum:
        - NOTAPPLICABLE
        - EMPLOYEEVOLUNTARY
        - EMPLOYEEDISCRETIONARY
    TaxFormType:
      type: string
      enum:
        - T1035COSTBASIS
        - T1035LOANTRANSFER
        - T1035SURRENDER
        - T1035TAXADVANTAGE
        - T1099R
        - TAXDISCLOSUREFORMW4P
        - TAXDISCLOSUREFORMW8
        - USW4TAXFORM
        - W9
        - VOIDCHECK
    W4P:
      type: object
      properties:
        totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities:
          type: number
          format: double
          example: 12.12
          description: "Below Amounts are for periodic Payments Only  - Certain States
            Require these amounts to be entered "
        totalAmountOfClaimsAndOtherCredits:
          type: number
          format: double
          example: 213.73
          description: "This indicates the total amount of tax claims and credits party is
            eligible for to reduce the tax liabilities "
        otherIncome:
          type: number
          format: double
          example: 144.53
          description: "Not from Jobs or Pension/Annuities "
        otherDeduction:
          type: number
          format: double
          example: 42.83
          description: If Standard Deduction is not used
    PartyRole:
      type: string
      enum:
        - OWNER
        - PRIMARYBENEFICIARY
        - CONTINGENTBENEFICIARY
        - INSURED
        - PAYOR
        - PAYEE
        - AGENT
        - PRIMARYWRITINGAGENT
        - PRIMARYSERVICINGAGENT
        - ADDITIONALSERVICINGAGENT
        - ADDITIONALWRITINGAGENT
        - THIRDPARTYDESIGNEE
        - JOINTOWNER
        - COVERAGEINSURED
        - ASSIGNEE
        - ANNUITANT
        - EXCHANGECOMPANY
        - JOINTANNUITANT
        - GRANTOR
        - TRUSTEE
        - POWEROFATTORNEY
        - AUTHORIZEDSIGNATORY
        - OTHERINTERESTEDPARTY
        - CONTINGENTOWNER
        - THIRDPARTYADMINISTRATOR
        - CARRIER
        - SUCCESSORTRUSTEE
        - COVERAGEJOINTINSURED
    TransactionChargeType:
      type: string
      enum:
        - COSTOFINSURANCE
        - EXPENSECHARGE
        - UNITEXPENSECHARGE
        - RIDERCHARGE
        - SURRENDERCHARGE
        - WITHDRAWALCHARGE
        - PAYMENTCHARGE
        - COVERAGECHARGE
        - COVERAGECREDIT
        - PREMIUMTAX
        - MARKETVALUEADJUSTMENT
        - BONUSRECAPTURE
        - EQUITYINDEXADJUSTMENT
        - PRODUCTLIMITS
        - DEATHBENEFITINTEREST
        - FUTURECHARGESFORTRANSACTION
        - REDEMPTIONFEE
        - MAILCHARGE
        - FUNDFEE
        - INEFFECT
        - ALL
        - OVERNIGHTMAIL
        - WIRE
    ChargeWaiverIndicator:
      type: string
      enum:
        - Yes
        - No
    PaymentForm:
      type: string
      enum:
        - DTCC
        - CREDITCARD
        - ACH
        - CHECK
        - WIRE
        - EXCHANGE
        - PREMIUMLOAN
    SuppressionType:
      type: string
      description: Specifies the category or type of suppression being applied to a
        transaction. It indicates what kind of suppression is in effect.
      enum:
        - CORRESPONDENCE
        - TAX
        - DISBURSEMENT
        - COMMISSION
    NewLoanRequest:
      type: object
      properties:
        correlationId:
          type: string
          example: 657b717b7dcf554abf9ef067
          description: The unique ID to track transaction request across all systems
        effectiveDate:
          type: string
          example: 2023-01-01
          description: Date (with pattern "yyyy-mm-dd") when the transaction was
            originally scheduled or expected to happen, can be a non-business
            day
        reverseInitiator:
          type: boolean
          description: Property to isolate source transaction(s) that initiated the reversal
          default: false
        transactionAmounts:
          $ref: "#/components/schemas/AdhocTransactionAmount"
        fundAllocation:
          $ref: "#/components/schemas/AdhocFundAllocation"
        taxWithholdingInstructions:
          type: array
          items:
            $ref: "#/components/schemas/AdhocTaxWithholdingInstructions"
        charges:
          type: array
          items:
            $ref: "#/components/schemas/Charge"
        payeeOrBeneficiary:
          type: array
          items:
            $ref: "#/components/schemas/PayeeOrBeneficiary"
        parties:
          type: array
          items:
            $ref: "#/components/schemas/AdhocDisbursementParty"
        externalIdentifiers:
          $ref: "#/components/schemas/AdhocExternalIdentifiers"
        suppression:
          type: array
          items:
            $ref: "#/components/schemas/Suppression"
```