---
title: "EligibilityRequest"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/EligibilityRequest"
---

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

# EligibilityRequest

Optional request body shared by all four eligibility endpoints. planCode and policyNumber are supplied as path parameters, not in the body.

## 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:
    EligibilityRequest:
      type: object
      description: >
        Optional request body shared by all four eligibility endpoints. planCode
        and policyNumber are supplied as path parameters, not in the body.
      properties:
        items:
          type: array
          description: >
            Subject identifiers to evaluate. Semantics depend on the endpoint:
            transaction/cancellation — transaction type codes (e.g.
            FullSurrender); capabilities — capability codes (e.g. ViewPolicy);
            restrictions — restriction type codes (e.g. DIVORCE, OVERPAYMENT).
            When absent or empty, all subjects configured for the plan are
            evaluated.
          items:
            type: string
          example:
            - FullSurrender
            - PartialWithdrawalOneTime
```