---
title: "Submit Partial Withdrawal OneTime"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/operations/partialWithdrawalOneTime1"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# Submit Partial Withdrawal OneTime

`POST` `/policy/v1/transactions/{planCode}/{policyNumber}/partialwithdrawalonetime`

Operation ID: `partialWithdrawalOneTime1`

## Path parameters

- `planCode` (string, required)
- `policyNumber` (string, required)

## Request body (required)

Content types: `application/json`

## Responses

- `202` - Submit Transaction Successful
- `500` - Internal server error. Please check server logs for more details.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.8
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
paths:
  /policy/v1/transactions/{planCode}/{policyNumber}/partialwithdrawalonetime:
    post:
      x-kong-plugin-pre-function:
        config:
          access:
            - >
              local path = kong.request.get_path()

              local new_path = path:gsub("^/policy/v1/transactions",
              "/bpm/v1/policies")

              kong.service.request.set_path(new_path)
      tags:
        - Financial Transactions
      summary: Submit Partial Withdrawal OneTime
      operationId: partialWithdrawalOneTime1
      parameters:
        - name: planCode
          in: path
          required: true
          schema:
            type: string
        - name: policyNumber
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PartialWithdrawalOneTimeRequest"
        required: true
      responses:
        "202":
          description: Submit Transaction Successful
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionAcceptedResponse"
        "500":
          description: Internal server error. Please check server logs for more details.
      security:
        - Auth0: []
security:
  - Auth0: []
components:
  schemas:
    PartialWithdrawalOneTimeRequest:
      type: object
      description: Partial withdrawal one-time transaction request including
        transaction amounts, fund allocation, parties, tax withholding, and
        signatures.
      allOf:
        - $ref: "#/components/schemas/PartialWithdrawalOneTime"
      properties:
        caseId:
          type: string
          example: CA0000007389
          description: Zinnia Live Case ID
        override:
          type: boolean
          description: BPM will have to override the rules if this variable is marked as
            true
    TransactionAcceptedResponse:
      type: object
      properties:
        correlationId:
          type: string
          example: 3a2a3435-2089-4b81-9959-e0d569ccf4f0
          description: Unique identifier which used by every system to trace the request
        caseId:
          type: string
          example: CA0000369469
          description: Zinnia Live Case ID
        caseStatus:
          type: string
          example: IN_PROGRESS
          description: Zinnia Live Case Status
        pdfId:
          type: string
          description: Identifier for the generated or associated PDF document (e.g.
            OnBase document number). Returned on systematic program setup and
            update submit when available.
          example: DOC-10004567
    PartialWithdrawalOneTime:
      type: object
      description: Request body for partial withdrawal one-time eligibility,
        validation, and submit endpoints.
      properties:
        correlationId:
          type: string
          example: test-112132141
          description: The unique ID to track transaction request across all systems
        effectiveDate:
          type: string
          format: date
          example: 2026-03-17
          description: Date when the transaction was originally scheduled or expected to
            happen. It can be a non-business day
        reverseInitiator:
          type: boolean
          description: Property to isolate source transaction(s) that initiated the reversal
          default: false
        selfServeFlow:
          type: boolean
          description: Whether the request originated from a self-serve flow
          example: false
        transactionType:
          $ref: "#/components/schemas/PartialWithdrawalTransactionType"
        externalIdentifiers:
          $ref: "#/components/schemas/PartialWithdrawalExternalIdentifiers"
        transactionReason:
          $ref: "#/components/schemas/PartialWithdrawalTransactionReason"
        transactionAmounts:
          $ref: "#/components/schemas/PartialWithdrawal.TransactionAmounts"
        fundAllocation:
          $ref: "#/components/schemas/PartialWithdrawalFundAllocation"
        taxWithholdingInstructions:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalTaxWithholdingInstruction"
        fundDistributions:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalFundDistribution"
        parties:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalParty"
        charges:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalCharge"
        suppression:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalSuppression"
        signatures:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalSignature"
      required:
        - effectiveDate
        - transactionAmounts
        - fundAllocation
        - parties
    PartialWithdrawalTransactionType:
      type: string
      enum:
        - PARTIAL_WITHDRAWAL
      description: Transaction type for partial withdrawal one-time requests
      example: PARTIAL_WITHDRAWAL
    PartialWithdrawalExternalIdentifiers:
      type: object
      properties:
        externalTransactionId:
          type: string
          description: The unique ID to identify transaction on carrier side
          example: "14141414"
        referenceNumber:
          type: string
          description: The unique payment reference number for all premium-related
            transactions by carrier
          example: "141414141"
    PartialWithdrawalTransactionReason:
      type: string
      enum:
        - ONETIMEPREMIUM
        - GRACEPERIODPREMIUM
        - REINSTATEMENTPREMIUM
        - EXCHANGE1035
        - SURRENDER
        - AMOUNTEXCESSTOMEC
        - AMOUNTEXCESSTOGUIDELINE
        - CURRENTVALUE
        - COSTBASIS
        - GUIDELINESINGLEPREMIUM
        - GUIDELINELEVELPREMIUM
        - SEVENPAYPREMIUM
        - TOTALYTDPREMIUMAMOUNT
        - FACEDECREASECOVERAGE
        - INITIALPREMIUMEXPIRATION
        - COMPLIANCE
        - NOTRANSACTIONREASON
        - STARTINGPRICE
        - LUMPSUM
        - FIVEYEARDEFERRAL
        - SPOUSALCONTINUATION
        - DISCOUNT
        - CONTROLBUSINESSINDICATOR
        - NATIONALCHANGEOFADDRESS
        - DATEOFDEATH
        - INITIALDEATHNOTIFICATION
        - PRODUCTDEFAULT
        - AMOUNT
        - GWBRIDERDISBURSEMENT
        - GWBPHASECHANGE
        - FREQUENCY
        - PREMIUMLOAN
        - PAYMENTDUEDATE
      description: Reason for the partial withdrawal one-time transaction
      example: ONETIMEPREMIUM
    PartialWithdrawal.TransactionAmounts:
      type: object
      properties:
        requestedAmount:
          type: number
          format: double
          example: 1000
        amountType:
          $ref: "#/components/schemas/PartialWithdrawalAmountType"
        disbursementType:
          $ref: "#/components/schemas/PartialWithdrawalDisbursementType"
        distributionCode:
          $ref: "#/components/schemas/PartialWithdrawalDistributionCode"
        disbursementPaymentForm:
          $ref: "#/components/schemas/PartialWithdrawalDisbursementPaymentForm"
        accountNumber:
          type: string
          example: "11434552525"
        participantId:
          type: string
          example: "1236"
        withdrawalReason:
          $ref: "#/components/schemas/PartialWithdrawalWithdrawalReason"
        severanceDate:
          type: string
          format: date
          example: 2026-03-17
        firstRothIRADate:
          type: string
          format: date
          example: 2026-03-17
        hardshipType:
          $ref: "#/components/schemas/PartialWithdrawalHardshipType"
        emergencyType:
          $ref: "#/components/schemas/PartialWithdrawalEmergencyType"
      required:
        - requestedAmount
        - amountType
        - disbursementType
    PartialWithdrawalFundAllocation:
      type: object
      properties:
        allocationOption:
          $ref: "#/components/schemas/PartialWithdrawalAllocationOption"
      required:
        - allocationOption
    PartialWithdrawalTaxWithholdingInstruction:
      type: object
      properties:
        partyId:
          type: string
          example: "2314134"
          description: Impacted party for tax withholding
        taxWithholdingType:
          $ref: "#/components/schemas/TaxWithholdingType"
        partyRole:
          $ref: "#/components/schemas/PartialWithdrawalPartyRole"
        taxRateToUse:
          $ref: "#/components/schemas/TaxRateToUse"
        filingStatus:
          $ref: "#/components/schemas/PartialWithdrawalFilingStatus"
        dollar:
          type: number
          format: double
          example: 0
        percentage:
          type: number
          format: double
          example: 0
        exemptions:
          type: number
          format: int32
          example: 0
        taxJurisdiction:
          type: string
          example: string
        contribution:
          $ref: "#/components/schemas/PartialWithdrawalW4rContribution"
        w4r:
          $ref: "#/components/schemas/PartialWithdrawalW4r"
        taxFormType:
          $ref: "#/components/schemas/PartialWithdrawalTaxFormType"
      required:
        - partyId
        - taxWithholdingType
    PartialWithdrawalFundDistribution:
      type: object
      properties:
        fundId:
          type: string
          example: "1231414"
        fundName:
          type: string
          example: Fixed
        distributionAmountType:
          $ref: "#/components/schemas/PartialWithdrawalDistributionAmountType"
        totalFundValue:
          type: number
          format: double
          example: 10000
        requestedAmount:
          type: number
          format: double
          example: 1000
        fundDistributionSegments:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalFundDistributionSegment"
    PartialWithdrawalParty:
      type: object
      properties:
        partyId:
          type: string
          example: 134535214eedf32412
        addressId:
          type: string
          example: 134535214eedf32412
        bankId:
          type: string
          example: "1232423525"
        partyRole:
          $ref: "#/components/schemas/PartialWithdrawalPartyRole"
        partyType:
          $ref: "#/components/schemas/PartialWithdrawalPartyType"
        paymentForm:
          $ref: "#/components/schemas/PaymentForm"
        allocationPercentage:
          type: number
          format: double
          example: 100
        forBenefitOfOrForFurtherCredit:
          type: string
          example: ABCD
        relationshipToOwner:
          type: string
          example: string
        preferredContactMethod:
          $ref: "#/components/schemas/PartialWithdrawalPreferredContactMethod"
        personalInformation:
          $ref: "#/components/schemas/PartialWithdrawalPersonalInformation"
        organisationDetails:
          $ref: "#/components/schemas/PartialWithdrawalOrganisationDetails"
        phones:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalPhone"
        emails:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalEmail"
        addresses:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalAddress"
        overnightCheckInfo:
          $ref: "#/components/schemas/PartialWithdrawalOvernightCheckInfo"
        identifications:
          type: array
          items:
            $ref: "#/components/schemas/PartialWithdrawalIdentification"
        bankDetails:
          $ref: "#/components/schemas/PartialWithdrawalBankDetails"
      required:
        - partyId
        - partyRole
        - paymentForm
        - allocationPercentage
    PartialWithdrawalCharge:
      type: object
      properties:
        partyId:
          type: string
          example: Party_PI_1
        chargeType:
          $ref: "#/components/schemas/PartialWithdrawalChargeType"
        chargeWaiverIndicator:
          $ref: "#/components/schemas/PartialWithdrawalChargeWaiverIndicator"
        chargeWaiverReason:
          type: string
          example: Client Approved
    PartialWithdrawalSuppression:
      type: object
      properties:
        suppressionType:
          $ref: "#/components/schemas/PartialWithdrawalSuppressionType"
        suppressionReason:
          type: string
          example: Client Approved
    PartialWithdrawalSignature:
      type: object
      properties:
        signType:
          type: string
          example: OWNER
          description: Signature type code
        signDate:
          type: string
          format: date
          example: 2026-07-10
        signDesignation:
          type: string
          example: Executor
        isSignedPresent:
          type: boolean
          example: true
    PartialWithdrawalAmountType:
      type: string
      enum:
        - AMOUNT
        - PERCENTAGE
        - FREEWITHDRAWALAMOUNT
        - EARNINGSONLY
        - MAX
        - MODIFIEDEARNINGSONLY
        - WITHDRAWALUNTILBASIS
        - PERCENTAGEOFACCOUNTVALUE
      example: AMOUNT
    PartialWithdrawalDisbursementType:
      type: string
      enum:
        - GROSS
        - NET
        - NETBEFORETAX
      example: GROSS
    PartialWithdrawalDistributionCode:
      type: string
      enum:
        - CHARITABLEGIFT
      example: CHARITABLEGIFT
    PartialWithdrawalDisbursementPaymentForm:
      type: string
      enum:
        - CHECK
        - WIRE
        - DTCC
        - ACH
        - OVERNIGHTCHECK
      example: CHECK
    PartialWithdrawalWithdrawalReason:
      type: string
      enum:
        - NORMALDISTRIBUTION
        - PREMATUREDISTRIBUTION
        - DISABILITY
        - SEPARATIONFROMEMPLOYMENT
        - UNFORESEEABLEEMERGENCY
        - INSERVICEDISTRIBUTION
        - HARDSHIP
        - DEATH
      example: NORMALDISTRIBUTION
    PartialWithdrawalHardshipType:
      type: string
      enum:
        - MEDICAL
        - HOMEPURCHASE
        - EDUCATION
        - EVICTIONPREVENTION
        - FUNERAL
        - DISASTER
        - OTHER
      example: MEDICAL
    PartialWithdrawalEmergencyType:
      type: string
      enum:
        - MEDICAL
        - CASUALTYLOSS
        - OTHERUNFORESEEABLEEMERGENCY
      example: MEDICAL
    PartialWithdrawalAllocationOption:
      type: string
      enum:
        - DEFAULT
        - FIXEDPRORATA
        - VARIABLEPRORATA
        - PRORATA
        - SPECIFIEDFUNDS
        - SPECIFIEDSEGMENTS
      description: Defines how funds are removed for the partial withdrawal
      example: PRORATA
    TaxWithholdingType:
      type: string
      enum:
        - FEDERAL
        - STATE
        - NRA
        - BACKUP
    PartialWithdrawalPartyRole:
      type: string
      enum:
        - OWNER
        - PRIMARYBENEFICIARY
        - CONTINGENTBENEFICIARY
        - INSURED
        - PAYOR
        - PAYEE
        - AGENT
        - CARRIER
        - THIRDPARTYDESIGNEE
        - THIRDPARTYADMINISTRATOR
        - JOINTOWNER
        - COVERAGEINSURED
        - COVERAGEJOINTINSURED
        - ASSIGNEE
        - PRIMARYWRITINGAGENT
        - PRIMARYSERVICINGAGENT
        - ADDITIONALSERVICINGAGENT
        - ADDITIONALWRITINGAGENT
        - ANNUITANT
        - EXCHANGECOMPANY
        - JOINTANNUITANT
        - GRANTOR
        - TRUSTEE
        - POWEROFATTORNEY
        - AUTHORIZEDSIGNATORY
        - OTHERINTERESTEDPARTY
        - CONTINGENTOWNER
        - SUCCESSORTRUSTEE
      example: OWNER
    TaxRateToUse:
      type: string
      enum:
        - NOWITHHOLDINGELECTED
        - USEVALUESENTERED
        - NOWITHHOLDINGALLOWED
        - USEDEFAULTTABLE
        - ADDITIONALWITHHOLDING
      description: How tax rate should be applied for withholding
    PartialWithdrawalFilingStatus:
      type: string
      enum:
        - SINGLE
        - MARRIED
        - DEFAULT
        - DOMESTICPARTNER
        - DOMESTICPARTNERSHIP
        - HEADOFHOUSEHOLD
        - MARRIEDFILINGSEPARATELY
        - WIDOWED
        - DIVORCED
      description: Filing status for partial withdrawal tax withholding
      example: MARRIED
    PartialWithdrawalW4rContribution:
      type: string
      enum:
        - NOTAPPLICABLE
      example: NOTAPPLICABLE
    PartialWithdrawalW4r:
      type: object
      properties:
        filingStatus:
          $ref: "#/components/schemas/PartialWithdrawalFilingStatus"
        dollar:
          type: number
          format: double
          example: 0
        percentage:
          type: number
          format: double
          example: 0
        exemptions:
          type: number
          format: int32
          example: 0
    PartialWithdrawalTaxFormType:
      type: string
      enum:
        - T1035COSTBASIS
      example: T1035COSTBASIS
    PartialWithdrawalDistributionAmountType:
      type: string
      enum:
        - PERCENTAGE
        - AMOUNT
        - UNIT
      example: AMOUNT
    PartialWithdrawalFundDistributionSegment:
      type: object
      properties:
        segmentId:
          type: string
          example: "1231414"
        currentAmount:
          type: number
          format: double
          example: 10000
        requestedAmount:
          type: number
          format: double
          example: 1000
    PartialWithdrawalPartyType:
      type: string
      enum:
        - INDIVIDUAL
        - ORGANIZATION
      example: INDIVIDUAL
    PaymentForm:
      type: string
      enum:
        - DTCC
        - CREDITCARD
        - ACH
        - CHECK
        - WIRE
        - EXCHANGE
        - EFT
      description: Mode of payment
    PartialWithdrawalPreferredContactMethod:
      type: string
      enum:
        - MAIL
        - PHONE
        - EMAIL
      example: MAIL
    PartialWithdrawalPersonalInformation:
      type: object
      properties:
        prefix:
          $ref: "#/components/schemas/PartialWithdrawalNamePrefix"
        suffix:
          $ref: "#/components/schemas/PartialWithdrawalNameSuffix"
        firstName:
          type: string
          example: Jordan
        middleName:
          type: string
          nullable: true
        lastName:
          type: string
          example: Taylor
        fullName:
          type: string
          example: Jordan Taylor
        gender:
          $ref: "#/components/schemas/PartialWithdrawalGender"
        dateOfBirth:
          type: string
          format: date
          example: 1987-11-03
        birthCountry:
          type: string
          example: US
        citizenshipCountry:
          type: string
          example: US
        birthState:
          type: string
          example: CA
    PartialWithdrawalOrganisationDetails:
      type: object
      properties:
        fullName:
          type: string
          example: xyz
        organizationCode:
          type: string
          example: 76A
        entityType:
          $ref: "#/components/schemas/PartialWithdrawalEntityType"
        trustDate:
          type: string
          format: date
          nullable: true
        trustType:
          $ref: "#/components/schemas/PartialWithdrawalTrustType"
        trustTitle:
          type: string
          example: TrustTitle
    PartialWithdrawalPhone:
      type: object
      properties:
        startDate:
          type: string
          format: date
          example: 2023-01-01
        endDate:
          type: string
          format: date
          example: 2023-01-01
        phoneType:
          $ref: "#/components/schemas/PartialWithdrawalPhoneType"
        countryCode:
          type: string
          example: "9"
        areaCode:
          type: string
          example: "973"
        dialNumber:
          type: string
          example: "765789"
        extension:
          type: string
          nullable: true
        bestTime:
          type: string
          nullable: true
        timezone:
          type: string
          nullable: true
        isPreferred:
          type: boolean
          example: false
        phoneId:
          type: string
          example: "1"
    PartialWithdrawalEmail:
      type: object
      properties:
        startDate:
          type: string
          format: date
          example: 2023-01-01
        endDate:
          type: string
          format: date
          example: 2023-01-01
        emailType:
          $ref: "#/components/schemas/PartialWithdrawalEmailType"
        emailAddress:
          type: string
          format: email
          example: user@example.com
        isPreferred:
          type: boolean
          example: false
        emailId:
          type: string
          example: "1"
    PartialWithdrawalAddress:
      type: object
      properties:
        addressId:
          type: string
          example: 134535214eedf32412
        addressType:
          $ref: "#/components/schemas/PartialWithdrawalAddressType"
        line1:
          type: string
          example: 123 Main St
        line2:
          type: string
          example: Apt 5B
        line3:
          type: string
          nullable: true
        city:
          type: string
          example: San Francisco
        state:
          type: string
          example: CA
        postalCode:
          type: string
          example: "94105"
        postalCodeExtension:
          type: string
          example: "1234"
        country:
          type: string
          example: US
    PartialWithdrawalOvernightCheckInfo:
      type: object
      properties:
        accountType:
          $ref: "#/components/schemas/PartialWithdrawalOvernightAccountType"
        accountName:
          type: string
          example: Security Benefit
        accountNumber:
          type: string
          example: "11434552525"
    PartialWithdrawalIdentification:
      type: object
      properties:
        identificationType:
          $ref: "#/components/schemas/PartialWithdrawalIdentificationType"
        identificationValue:
          type: string
          example: 123-45-6789
        issueState:
          type: string
          example: CA
        issueCountry:
          type: string
          example: US
        expirationDate:
          type: string
          format: date
          example: 2035-12-31
    PartialWithdrawalBankDetails:
      type: object
      properties:
        bankId:
          type: string
          example: "1232423525"
        nameOnAccount:
          type: string
          example: Alex J Taylor
        accountStatus:
          $ref: "#/components/schemas/PartialWithdrawalBankAccountStatus"
        accountType:
          $ref: "#/components/schemas/PartialWithdrawalBankAccountType"
        accountNumber:
          type: string
          example: "000111222333"
        routingNumber:
          type: string
          example: "121000358"
        ibanNumber:
          type: string
          nullable: true
        financialInstitutionName:
          type: string
          example: Acme Bank
        branchName:
          type: string
          nullable: true
        bankAccountPurpose:
          $ref: "#/components/schemas/PartialWithdrawalBankAccountPurpose"
        address:
          $ref: "#/components/schemas/PartialWithdrawalAddress"
    PartialWithdrawalChargeType:
      type: string
      enum:
        - COSTOFINSURANCE
        - EXPENSECHARGE
        - UNITEXPENSECHARGE
        - RIDERCHARGE
        - SURRENDERCHARGE
        - WITHDRAWALCHARGE
        - PREMIUMTAX
        - MARKETVALUEADJUSTMENT
        - OVERNIGHTMAIL
        - WIRE
        - PAYMENTCHARGE
        - COVERAGECHARGE
        - COVERAGECREDIT
      example: WITHDRAWALCHARGE
    PartialWithdrawalChargeWaiverIndicator:
      type: string
      enum:
        - YES
        - NO
      example: YES
    PartialWithdrawalSuppressionType:
      type: string
      enum:
        - CORRESPONDENCE
        - TAX
        - DISBURSEMENT
        - COMMISSION
      example: CORRESPONDENCE
    PartialWithdrawalNamePrefix:
      type: string
      enum:
        - MR
        - MS
        - MISS
        - DR
        - MRS
      example: MR
    PartialWithdrawalNameSuffix:
      type: string
      enum:
        - JR
        - SR
        - I
        - II
        - III
        - IV
        - V
        - VI
        - VII
      example: JR
    PartialWithdrawalGender:
      type: string
      enum:
        - FEMALE
        - MALE
        - OTHER
      example: FEMALE
    PartialWithdrawalEntityType:
      type: string
      enum:
        - SOLEPROPRIETORSHIP
        - GENERALPARTNERSHIP
        - LIMITEDPARTNERSHIP
        - SCORPORATION
        - CCORPORATION
        - LIMITEDLIABILITYCOMPANY
        - CHARITABLEORGANIZATION
        - ESTATE
        - TRUST
        - CORPORATION
        - UNKNOWN
      example: CORPORATION
    PartialWithdrawalTrustType:
      type: string
      enum:
        - INDIVIDUALTRUST
        - CORPORATETRUST
        - TESTAMENTARYTRUST
        - INTERVIVOSTRUST
        - GRANTORTRUST
        - PETTRUST
      example: INDIVIDUALTRUST
    PartialWithdrawalPhoneType:
      type: string
      enum:
        - MOBILE
        - HOME
        - BUSINESS
        - CLAIMCENTER
        - CUSTOMERSERVICE
        - CORPORATEOFFICE
        - FAX
        - UNKNOWN
        - OTHER
      example: MOBILE
    PartialWithdrawalEmailType:
      type: string
      enum:
        - PERSONAL
        - BUSINESS
        - CUSTOMERSERVICE
        - OTHER
      example: PERSONAL
    PartialWithdrawalAddressType:
      type: string
      enum:
        - RESIDENCE
        - BUSINESS
        - POBOX
        - SEASONAL
        - SECONDARY
        - MAILING
      example: RESIDENCE
    PartialWithdrawalOvernightAccountType:
      type: string
      enum:
        - USPS
        - FEDEX
        - UPS
        - DHL
      example: USPS
    PartialWithdrawalIdentificationType:
      type: string
      enum:
        - SSN
        - EIN
        - TIN
        - DRIVERSLICENSE
        - PASSPORT
      example: SSN
    PartialWithdrawalBankAccountStatus:
      type: string
      enum:
        - ACTIVEBANKACCOUNT
        - TERMINATEDBANKACCOUNT
      example: ACTIVEBANKACCOUNT
    PartialWithdrawalBankAccountType:
      type: string
      enum:
        - CHECKING
        - SAVINGS
        - CREDITCARD
        - DEBITCARD
        - BROKERAGEACCOUNT
        - CERTIFICATEOFDEPOSIT
        - WIRE
      example: CHECKING
    PartialWithdrawalBankAccountPurpose:
      type: string
      enum:
        - LOANINTERESTBILLING
        - DISBURSEMENTS
        - LOANPRINCIPALBILLING
        - PREMIUMBILLING
        - ONETIMEPREMIUMBILLING
        - PAYOUT
        - ONETIMEWIRE
      example: DISBURSEMENTS
  securitySchemes:
    Auth0:
      type: openIdConnect
      openIdConnectUrl: https://login.uat.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          run_on_preflight: true
          scopes_claim:
            - https://uat.api.zinnia.io/permissions
          audience_claim:
            - aud
          audience_required:
            - https://uat.api.zinnia.io
          client_id:
            - client_id
          auth_methods:
            - bearer
        enabled: true
        protocols:
          - grpc
          - grpcs
          - http
          - https
```