---
title: "DocumentRequest"
url: "https://developers.zinnia.com/apis/new-business/versions/b8532e16-b28e-4393-9305-def50b91e40e/schemas/DocumentRequest"
---

> Full API specification: https://developers.zinnia.com/apis/new-business/versions/b8532e16-b28e-4393-9305-def50b91e40e.md

# DocumentRequest

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia New Business API.
  version: 0.9.8
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:
    DocumentRequest:
      type: object
      properties:
        caseId:
          type: string
          description: Zinnia Live case
          example: CA0000005656
        externalDocumentId:
          type: string
          description: Unique number assigned to given document by the source system
        binaryData:
          type: string
          format: base64
          description: Base 64 encoded binary stream
        formNumber:
          type: string
          description: Unique Number for a form
          example: "123456"
        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
          example: TERMS_OF_USE
        category:
          type: string
          enum:
            - NEW_BUSINESS
          description: Category of the document as per OnBase system
          example: NEW_BUSINESS
        fileName:
          type: string
          description: Source File Name
          example: E0001_Signed_Application.PDF, E0002 Unsigned Application.PDF
        displayName:
          type: string
          description: Source File Name
          example: Signed_Application.PDF, Unsigned Application.PDF
        fileType:
          type: string
          enum:
            - pdf
          description: Type of file
      required:
        - correlationId
        - eappId
        - carrier
        - caseId
        - binaryData
        - documentType
        - fileName
        - fileType
        - displayName
        - category
```