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

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

# EligibilityV3CheckResult

Eligibility check result for a transaction, action, and target combination.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.9
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    EligibilityV3Target:
      type: object
      description: The target of the eligibility check.
      required:
        - type
        - code
      properties:
        type:
          type: string
          description: Target type.
          enum:
            - RIDER
            - COVERAGE
            - BENEFIT_OPTION
            - TRANSACTION
        code:
          type: string
          description: Target code or identifier.
          example: CITR
    EligibilityV3Reason:
      type: object
      description: Structured reason for an ineligible transaction.
      properties:
        code:
          type: string
          description: Machine-readable reason code.
          example: BPM.NM.050
        message:
          type: string
          description: Human-readable explanation.
          example: The effective date entered is not within this policy's free look
            period.
        resolution:
          type: string
          description: Suggested remediation.
          example: Update the effective date (if possible), or submit for NIGO processing.
    EligibilityV3CheckResult:
      type: object
      description: Eligibility check result for a transaction, action, and target
        combination.
      required:
        - eligibilityType
        - action
        - target
        - eligible
      properties:
        eligibilityType:
          type: string
          description: Type of eligibility check.
          enum:
            - POLICY
            - USER
            - RESTRICTION
        action:
          type: string
          description: Action being evaluated.
          enum:
            - ADD
            - UPDATE
            - DELETE
            - INCREASE
            - DECREASE
            - NOT_APPLICABLE
        target:
          $ref: "#/components/schemas/EligibilityV3Target"
        eligible:
          type: boolean
          description: Whether the action is eligible for the target.
        reasons:
          type: array
          description: Reasons for ineligibility. Present only when eligible is false.
          items:
            $ref: "#/components/schemas/EligibilityV3Reason"
```
