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

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

# MetadataSearchResponse

## 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:
    MetadataSearchResponse:
      type: object
      properties:
        documentClassification:
          type: string
          description: Document classification to identify document type
          example: OUTBOUND
          enum:
            - OUTBOUND
            - INBOUND
        sourceFileName:
          type: string
          description: Actual name of the document
          example: 123456.pdf
        planCode:
          type: string
          description: Plan code associated with the document
          example: "235"
        documentStatus:
          type: integer
          description: Indicates the current status of the document. '1' for ACTIVE, '0'
            for INACTIVE.
          format: int32
          example: 1
        documentId:
          type: string
          description: Unique ID of the document
          example: 67124697f3bef2497b6accfb
        documentDate:
          type: string
          description: Date associated with the document
          format: date-time
        documentType:
          type: string
          description: Type of the document
          example: NB Application
        documentCategory:
          type: string
          description: Category of the document
          example: New Business
        documentTypeDescription:
          type: string
          description: Detailed description of the document type
          example: Deferred Annuity Application
        zinniaLiveCaseId:
          type: string
          description: Zinnia live case ID associated with the document
          example: ZLC09876
        appId:
          type: string
          description: Application ID related to the document
          example: XXXXEDJ041120240000000001
        mailTrackingNumber:
          type: string
          description: Tracking ID for the document
          example: "4453166346"
        policyNumber:
          type: string
          description: Policy number linked to the document
          example: "23576001"
        createDate:
          type: string
          description: Creation date of the document (in UTC timezone)
          format: date-time
          example: 2024-03-18T14:30:00.000Z
        correlationId:
          type: string
          description: Correlation ID for the document
          example: 12345-corr-67890
        periodYear:
          type: integer
          description: Year related to the document period
          format: int32
          example: 2024
        periodQuarter:
          type: string
          description: Quarter related to the document period
          example: Q2
        fileType:
          type: string
          description: File type of the document
          example: pdf
        displayName:
          type: string
          description: Display name for the document
          example: New Business Policy Document
        brokerMasterNumber:
          type: string
          description: Master number of the broker associated with the document
          example: BKR123456
        repMasterNumber:
          type: string
          description: Master number of the representative associated with the document
          example: REP987654
        documentNumber:
          type: string
          description: Document number associated with the document (if present) else
            document Id
          example: 670e23dfab593b4387210b81 or 20241230-M-463066
        formNumber:
          type: string
          description: formNumber
          example: "1234"
        importDate:
          type: string
          format: date-time
          description: Document creation timestamp(in UTC timezone)
          example: 2024-09-23T10:30:00.000Z
```