---
title: "Metadata"
url: "https://developers.zinnia.com/apis/documents-0-3-0/versions/43d1ee7b-44e7-4303-b0cd-ca813c63b625/schemas/Metadata"
---

> Full API specification: https://developers.zinnia.com/apis/documents-0-3-0/versions/43d1ee7b-44e7-4303-b0cd-ca813c63b625.md

# Metadata

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Enterprise Documents API
  version: 3.0.0
servers:
  - url: https://dev.api.zinnia.io
    description: Dev Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
  - url: https://uat.api.zinnia.io
    description: UAT Environment
  - url: https://api.zinnia.io
    description: PROD Environment
components:
  schemas:
    Metadata:
      required:
        - docClassification
        - fileType
        - documentType
        - documentTypeDescription
        - docCategory
      type: object
      properties:
        zinniaLiveCaseId:
          type: string
          description: Zinnia Live Case ID. Either of policy number, Application Id or ZL
            case Id is required.
          example: ZLC09876
        appId:
          type: string
          description: Application ID. Either of policy number, Application Id or ZL case
            Id is required.
          example: EDJ041120240000000001
        docClassification:
          type: string
          description: Document classification to identify document type
          example: OUTBOUND
          enum:
            - OUTBOUND
            - INBOUND
        source:
          type: string
          description: Source of the document
          example: Email
        docCategory:
          type: string
          description: Document category
          example: NEW_BUSINESS
          enum:
            - NEW_BUSINESS
            - POST_ISSUE
            - DEATH
            - CORRESPONDENCE
            - AGENT
            - SUITABILITY
        fileType:
          type: string
          description: File type
          example: PDF
        documentType:
          type: string
          enum:
            - NB_STATE_REPLACEMENT
            - NB_CONVERSION
            - NB_APPLICATION
            - COST_DISCLOSURE
            - NON_CONTRACTUAL
            - AGENT_REPORT
            - ACCELERATED_BENEFIT_RIDER
            - SURRENDER_COMPARISION
            - CONSENT_PAPERLESS
            - TERMS_OF_USE
            - TERMS_CONDITIONS
            - CHARITY_ELECTION_FORMS
            - AUTHORIZATION_FORMS
            - HIPPA
            - HIV_CONSENT_FORM_ALL_STATE
            - AMENDMENT
            - DISCLOSURES
            - NB_STATE_REPLACEMENT_NOTICE
            - TRUSTEE_STATEMENT
            - TERMS_OF_USE
            - NOTICE_AND_CONSENT
            - PRIVACY_POLICY
            - GLBA_PRIVACY_NOTICE
            - FCRA
            - MIB_PRE_NOTICE
            - ID_VERIFICATION_NOTICE
            - HIPAA
            - ACCELERATED_BENEFIT_RIDER
            - BUYER_GUIDE
            - ILLUSTRATION
            - SUITABILITY
            - APPLICATION
            - SIGNED_APPLICATION
            - REPLACEMENTS_ACKNOWLEDGEMENT
            - 1035_EXCHANGE_SURRENDER
            - EVIDENCE_DOCUMENT
            - AMENDMENT
            - ELECTRONIC_FUNDS_TRANSFER
            - SUPPLEMENTAL_APPLICATION
            - CONFORMING_ILLUSTRATION
            - SIGNED_ILLUSTRATION
            - OVERFLOW_ADDITIONAL_INFORMATION
        documentDate:
          type: string
          description: Date of the document
          format: date-time
        documentTypeDescription:
          type: string
          description: Description of the document type. Refer the mapping sheet shared
            along with specification
          example: Address Change Letter
        planCode:
          type: string
          description: Plan code
          example: "235"
        policyNumber:
          type: string
          description: Policy number. Either of policy number, Application Id or ZL case
            Id is required.
          example: "23576001"
        pageCount:
          type: integer
          description: Total page count
          format: int64
          example: 5
        docAccessLevel:
          type: string
          description: Specifies who can access the document based on their role.
          example: CLIENT_COPY
          enum:
            - CLIENT_COPY
            - AGENT_COPY
        sourceFileName:
          type: string
          description: Source file name
          example: 052725FTADHOCLETTERS_R_20485_1207637_711.pdf
```