---
title: "DocumentInformation"
url: "https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7/schemas/DocumentInformation"
---

> Full API specification: https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7.md

# DocumentInformation

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia New Business Annuity API
  version: 0.6.0
servers:
  - url: https://qa.api.zinnia.io
    description: QA Environment
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://uat.api.zinnia.io
    description: UAT Environment
  - url: https://api.zinnia.io
    description: PROD Environment
components:
  schemas:
    DocumentDetail:
      type: object
      required:
        - documentId
        - binaryData
        - formId
        - formName
        - documentCategory
        - documentFileType
      properties:
        documentId:
          type: string
          description: Unique Identifier for the individual document. Duplicate document
            Ids will be rejected.
          example: 0ca10708-4b53-464c-b745-355c8f6f0edb
        binaryData:
          type: string
          description: Base 64 encoded binary stream
          example: SGVsbG8gV29ybGQ=
        formId:
          type: string
          description: Unique ID for a Form
          example: FR2279
        formName:
          type: string
          description: Unique Name for a form
          example: Fixed Annuity Order Entry Cover Sheet
        documentCategory:
          type: string
          description: Category of the document as per OnBase system
          example: NB Supporting Document
        documentFileType:
          type: string
          enum:
            - pdf
          description: Type of file
          example: pdf
    DocumentInformation:
      type: object
      required:
        - appId
        - version
        - effectiveDate
        - totalDocumentCount
        - documentDetails
      properties:
        appId:
          type: string
          description: Unique Identifier against an e-App application. First 4 letters
            represent the receiving company, next 3 letters represent the firm,
            next 8 positions represent the date eApp is submitted, next 10
            positions represents the sequential number of the eApps from the
            eApp instance. For Orion - Accept integers upto 15 digits
          example: XXXXEDJ041120240000000001
        version:
          type: string
          description: Version for that case - 3 digits, incremental if same case if
            submitted more than once in case of errors. For Orion - Accept
            integers upto 15 digits
          example: "000"
        effectiveDate:
          type: string
          format: date
          pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
          description: e-App submitted date to Zinnia (with pattern "yyyy-mm-dd").
          example: 2023-12-19
        totalDocumentCount:
          type: number
          example: 1
        documentDetails:
          type: array
          items:
            $ref: "#/components/schemas/DocumentDetail"
```