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

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

# MatchSegment

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    MatchSegment:
      type: object
      properties:
        segmentId:
          type: string
          description: TBA unique identifier assigned to a specific match segment within
            the policy, used to track matched contributions or benefits
          example: Match1
        matchAccountValue:
          type: number
          description: The present value of the matched amount/bonus in the segment,
            reflecting any growth, deductions, or adjustments
          format: double
          example: 1.985116
        cumulativeMatchPaymentAmount:
          type: number
          description: The total amount of matching contributions or eligible bonus
            contributions accumulated over time within the policy
          format: double
          example: 1.98
        yearToDateMatchValue:
          type: number
          description: The amount of matching contributions or eligible bonus
            contributions accumulated over the current policy year
          format: double
          example: 1.98
        maximumLifeTimeVestingAmount:
          type: number
          description: The highest total amount that can be matched or highest total
            eligible bonus over the lifetime of the policy, as per policy terms
          format: double
          example: 300
        maximumAnnualVestingAmount:
          type: number
          description: The maximum amount that can be matched or eligible bonus for
            current policy year
          format: double
          example: 300
        minimumPaymentsForMatch:
          type: number
          description: The minimum amount that can be matched or minimum eligible bonus
            over the lifetime of the policy, as per policy terms
          format: double
          example: 0
        unvestedPremiumBonus:
          type: number
          example: 10.12
          description: This is the current value that is not fully vested to the policy
            holder. It would be recaptured partially/fully at
            withdrawal/surrender.
          format: double
        totalRecapturedPremiumBonus:
          type: number
          example: 10.12
          description: The total amount of the premium bonus that was deducted from the
            policy value as a result of a partial or full withdrawal during the
            vesting period.
          format: double
        matchVestingDate:
          type: string
          description: The date on which the matched amount/ bonus becomes fully vested,
            meaning the policyholder gains full ownership rights over the
            matched funds/bonus.(match amount/bonus becomes part of account
            value)
          format: date
          example: 2023-01-01
        generalLedgerFundCode:
          type: string
          description: The accounting code used in the insurer’s general ledger system to
            track match/bonus related transactions
          example: V2201
        vestingPeriod:
          type: number
          description: The duration required before matched amount/bonus are fully vested,
            typically expressed in years or policy terms
          format: int32
          example: 10
```