---
title: "Initial Death Claim Eligibility Check"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/operations/initialDeathClaimEligibilityCheck"
---

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

# Initial Death Claim Eligibility Check

`POST` `/bpm/v1/policies/{planCode}/{policyNumber}/initialdeathclaim/eligibilitycheck`

Operation ID: `initialDeathClaimEligibilityCheck`

Checks whether an initial death claim can be submitted for the given policy. No request body is required; eligibility is derived from the policy identified by planCode and policyNumber. An eligible policy returns status success; an ineligible policy returns status failure with the reasons in error.

## Path parameters

- `planCode` (string, required) - Plan Code
- `policyNumber` (string, required) - Policy Number

## Responses

- `200` - Eligibility check completed successfully. The policy is eligible for an initial death claim.
- `400` - Bad Request
- `500` - Internal server error. Please check server logs for more details.

## 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
paths:
  /bpm/v1/policies/{planCode}/{policyNumber}/initialdeathclaim/eligibilitycheck:
    post:
      tags:
        - Financial Transactions
      summary: Initial Death Claim Eligibility Check
      description: >
        Checks whether an initial death claim can be submitted for the given
        policy.

        No request body is required; eligibility is derived from the policy
        identified

        by planCode and policyNumber. An eligible policy returns status success;
        an

        ineligible policy returns status failure with the reasons in error.
      operationId: initialDeathClaimEligibilityCheck
      parameters:
        - name: planCode
          in: path
          required: true
          schema:
            type: string
          description: Plan Code
          example: EVIU101
        - name: policyNumber
          in: path
          required: true
          schema:
            type: string
          description: Policy Number
          example: EVIUL7RED022
      responses:
        "200":
          description: Eligibility check completed successfully. The policy is eligible
            for an initial death claim.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionResponse"
              examples:
                success:
                  summary: Policy is eligible
                  value:
                    status: success
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionResponse"
              examples:
                failure:
                  $ref: "#/components/examples/failureTransactionResponse"
        "500":
          description: Internal server error. Please check server logs for more details.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionResponse"
              examples:
                serverError:
                  summary: Internal server error
                  value:
                    status: failure
                    error:
                      - errorCode: BPM.SYS.500
                        error: An unexpected internal server error occurred.
                        resolution: Contact platform support with the correlationId.
      security:
        - Auth0: []
security:
  - Auth0: []
components:
  schemas:
    TransactionResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
            - failure
        error:
          type: array
          items:
            $ref: "#/components/schemas/Error"
        quoteResponse:
          type: object
    Error:
      type: object
      properties:
        errorCode:
          type: string
          example: BPM.NM.002
          description: This is the NIGO id generated by BPM system
        attribute:
          type: string
        error:
          type: string
          description: This is the error generated by BPM system
        resolution:
          type: string
          description: Resolution generated by BPM system to resolve the error
  examples:
    failureTransactionResponse:
      value:
        status: failure
        validationResult:
          - errorCode: BPM.NM.005
            attribute: null
            error: Amount request is invalid.
            resolution: Please check the One Time Premium Amount and submit the request
              again.
          - errorCode: BPM.NM.003
            attribute: null
            error: Party information does not match with information in the Zahara system.
            resolution: Please validate the party information and submit the request again.
  securitySchemes:
    Auth0:
      type: openIdConnect
      openIdConnectUrl: https://login.qa.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          run_on_preflight: true
          scopes_claim:
            - https://qa.api.zinnia.io/permissions
          audience_claim:
            - aud
          audience_required:
            - https://qa.api.zinnia.io
          client_id:
            - client_id
          auth_methods:
            - bearer
        enabled: true
        protocols:
          - grpc
          - grpcs
          - http
          - https
```