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

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

# CaseEligibilityResponse

Top-level case eligibility response envelope.

## 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:
    CaseEligibilitySubjectResult:
      type: object
      description: >
        Composed eligibility result for a single case feature. Null fields are
        omitted from the JSON response. Evaluated results include the configured
        check sections; unavailable or unmapped features include
        notAvailable/notConfigured metadata.
      required:
        - eligibilityItem
        - eligible
      properties:
        eligibilityItem:
          type: string
          description: Case feature identifier evaluated.
          example: cancelTransaction
        eligible:
          type: boolean
          description: >
            true only when every enabled blocking check for this feature returns
            PASSED. FAILED or COULD_NOT_DETERMINE on any enabled blocking check
            forces eligible=false.
        caseStatusEligibility:
          $ref: "#/components/schemas/CaseEligibilitySectionResult"
        carrierEligibility:
          $ref: "#/components/schemas/CaseEligibilitySectionResult"
        userEligibility:
          $ref: "#/components/schemas/CaseEligibilitySectionResult"
        zaharaTransactionEligibility:
          $ref: "#/components/schemas/CaseEligibilitySectionResult"
        checkResults:
          type: object
          description: Map of all configured check results keyed by check name.
          additionalProperties:
            $ref: "#/components/schemas/CaseEligibilitySectionResult"
          example:
            CASE_STATUS:
              status: PASSED
            CARRIER_ONBOARDED:
              status: PASSED
            USER_PERMISSION:
              status: PASSED
            ZAHARA_TRANSACTION_STATUS:
              status: PASSED
        notAvailable:
          type: boolean
          description: True when the requested feature is not enabled for the resolved
            case transaction.
        notConfigured:
          type: boolean
          description: True when the case cannot be mapped to a configured transaction.
        message:
          type: string
          description: Human-readable explanation accompanying notAvailable or
            notConfigured.
          example: Feature Not Available
    CaseEligibilitySectionResult:
      type: object
      description: One case eligibility check result section.
      properties:
        status:
          type: string
          enum:
            - PASSED
            - FAILED
            - SKIPPED
            - COULD_NOT_DETERMINE
          example: PASSED
        reason:
          $ref: "#/components/schemas/EligibilityReason"
    EligibilityReason:
      type: object
      description: Structured reason for a non-passing or indeterminate section.
      properties:
        code:
          type: string
          description: Machine-readable reason code.
          example: INSUFFICIENT_PERMISSIONS
        message:
          type: string
          description: Human-readable explanation.
          example: Caller does not hold the required permissions for this transaction
        error:
          type: string
          description: Validation error text. Used by rule-validation reasons.
          example: The effective date entered is not within this policy's free look
            period.
        resolution:
          type: string
          description: Suggested remediation. Used by rule-validation reasons.
          example: Update the effective date (if possible), or submit for NIGO processing.
    CaseEligibilityResponse:
      type: object
      description: Top-level case eligibility response envelope.
      required:
        - eligibilityType
        - caseId
        - results
      properties:
        eligibilityType:
          type: string
          description: Case eligibility response type.
          enum:
            - case
          example: case
        caseId:
          type: string
          description: Case identifier evaluated.
          example: CA0001552404
        carrierCode:
          type: string
          nullable: true
          description: Carrier code resolved from Case Management.
          example: EVGL
        processTypeKey:
          type: string
          nullable: true
          description: Process key resolved from Case Management.
          example: Withdrawal
        processSubTypeKey:
          type: string
          nullable: true
          description: Process subtype key resolved from Case Management.
          example: Full Surrender
        transactionType:
          type: string
          nullable: true
          description: Transaction type resolved from case process mapping.
          example: FullSurrender
        results:
          type: array
          description: One entry per evaluated case feature.
          items:
            $ref: "#/components/schemas/CaseEligibilitySubjectResult"
```