--- title: "BaseCoverageUpdate" url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/BaseCoverageUpdate" --- > Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md # BaseCoverageUpdate ## 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 components: schemas: BaseCoverageUpdate: type: object properties: planCode: type: string example: IU0101 description: planCode (may duplicate path parameter) policyNumber: type: string example: FNWLIUL3908872 description: policyNumber (may duplicate path parameter) effectiveDate: type: string format: date example: 2026-03-26 correlationId: type: string example: e3bdb22b-790f-4357-ae60-dute9hdsur6253f0d1d carrierId: type: string example: FNWL requestedCoverageAmount: type: string example: "10000" permissionToViewMedicalRecord: type: boolean example: false mecAckProvidedBoolean: type: boolean example: false eSignaturePresent: type: boolean example: false signatures: type: array items: type: object properties: isSignedPresent: type: boolean example: false signDate: type: string nullable: true example: null signDesignation: type: string nullable: true example: null signType: type: string example: OWNER signTypeForUI: type: string example: Owner evidenceOfInsurabilityDocuments: type: array items: type: object properties: documentId: type: string example: "1234" medicalRecordsDocuments: type: array items: type: object properties: documentId: type: string example: "1234" taxWithholdingInstructions: type: array items: type: object properties: partyId: type: string example: "2314134" taxWithholdingType: type: string example: FEDERAL partyRole: type: string example: OWNER taxRateToUse: type: string example: NOWITHHOLDINGELECTED filingStatus: type: string example: MARRIED dollar: type: integer example: 0 percentage: type: integer example: 0 exemptions: type: integer example: 0 taxJurisdiction: type: string example: string contribution: type: string example: NOTAPPLICABLE w4p: type: object properties: totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities: type: integer example: 0 totalAmountOfClaimsAndOtherCredits: type: integer example: 0 otherIncome: type: integer example: 0 otherDeduction: type: integer example: 0 taxFormType: type: string example: T1035COSTBASIS fundDistributions: type: array items: type: object properties: fundId: type: string example: "1231414" fundName: type: string example: Fixed distributionAmountType: type: string example: PERCENTAGE/AMOUNT/UNIT totalFundValue: type: integer example: 10000 requestedAmount: type: integer example: 1000 fundDistributionSegments: type: array items: type: object properties: segmentId: type: string example: "1231414" currentAmount: type: integer example: 10000 requestedAmount: type: integer example: 1000 authorizationDetails: type: object properties: emails: type: object properties: type: type: string example: PERSONAL address: type: string example: rishal.srivastava@zinnia.com phone: type: object properties: type: type: string example: MOBILE countryCode: type: string example: "1" areaCode: type: string example: "234" dialNumber: type: string example: "5678900" extension: type: string example: "1234" parties: type: array items: type: object properties: partyId: type: string example: 134535214eedf32412 partyRole: type: string example: OWNER partyType: type: string example: INDIVIDUAL paymentMethod: type: string example: ACH ownershipPercentage: type: integer example: 100 forBenefitOfOrForFurtherCredit: type: string example: ABCD personalInformation: type: object properties: firstName: type: string example: Jordan middleName: type: string nullable: true example: null lastName: type: string example: Taylor fullName: type: string example: Jordan Taylor gender: type: string example: FEMALE dateOfBirth: type: string format: date example: 1987-11-03 birthCountry: type: string example: US citizenshipCountry: type: string example: US birthState: type: string example: CA addresses: type: array items: type: object properties: addressId: type: string example: 134535214eedf32412 addressType: type: string example: RESIDENTIAL line1: type: string example: 123 Main St line2: type: string example: Apt 5B line3: type: string nullable: true example: null 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 overnightCheckInfo: type: object properties: accountType: type: string example: USPS/FEDX/UPS/DHL accountName: type: string example: Security Benefit accountNumber: type: string example: "11434552525" signatures: type: object properties: signaturesType: type: string example: ESIGN/WETSIGN designation: type: string example: INDIVIDUAL name: type: string example: test b signatureDate: type: string example: 2023-12-01T00:00:00.000Z state: type: string example: NY identifications: type: array items: type: object properties: identificationType: type: string example: SSN 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 bankDetails: type: object properties: bankId: type: string example: "1232423525" nameOnAccount: type: string example: Alex J Taylor accountStatus: type: string example: ACTIVE accountType: type: string example: CHECKING accountNumber: type: string example: "000111222333" routingNumber: type: string example: "121000358" ibanNumber: type: string nullable: true example: null financialInstitutionName: type: string example: Acme Bank branchName: type: string nullable: true example: null bankAccountPurpose: type: string example: PAYOUT address: type: object properties: addressType: type: string example: MAILING line1: type: string example: 500 Market Street line2: type: string example: Suite 200 line3: type: string nullable: true example: null city: type: string example: San Francisco state: type: string example: CA postalCode: type: string example: "94103" postalCodeExtension: type: string example: "5678" country: type: string example: US charges: type: array items: type: object properties: partyId: type: string example: Party_PI_1 chargeType: type: string example: COSTOFINSURANCE chargeWaiverIndicator: type: string example: YES chargeWaiverReason: type: string example: Client Approved ```