---
title: "AttachmentResponse"
url: "https://developers.zinnia.com/apis/market-connect-order-entry/versions/50f981c3-db50-4358-884f-31eb427255ec/schemas/AttachmentResponse"
---

> Full API specification: https://developers.zinnia.com/apis/market-connect-order-entry/versions/50f981c3-db50-4358-884f-31eb427255ec.md

# AttachmentResponse

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Market Connect Order Entry API
  version: 1.0.3
servers:
  - url: https://dev.api.zinnia.io
  - url: https://qa.api.zinnia.io
  - url: https://uat.api.zinnia.io
components:
  schemas:
    AttachmentData:
      type: object
      properties:
        additionalDocumentTypes:
          type: array
          items:
            $ref: "#/components/schemas/AdditionalDocumentType"
          description: Document types the user may optionally upload.
          nullable: true
        documentRules:
          type: array
          items:
            $ref: "#/components/schemas/DocumentRule"
          description: Conditional rules for required or optional documents.
          nullable: true
        documents:
          type: array
          items:
            $ref: "#/components/schemas/AttachmentDocument"
          description: Files already stored for the transaction, including EDS documentId
            and documentSize in bytes.
          nullable: true
        requiredDocuments:
          type: array
          items:
            $ref: "#/components/schemas/RequiredDocument"
          description: Documents still required before submission.
          nullable: true
      additionalProperties: false
      example:
        additionalDocumentTypes:
          - attachmentType: []
            documentType:
              - Wet-signed Paperwork
              - Supporting Documents
              - Trust Certification
              - Green Card
              - Driver License – Proof of Age
              - Illustration
              - POA Paperwork
              - Check Deposit Form
            formType: []
        documentRules:
          - conditions: Owner age < 65
            key: PROOF_OF_AGE
            message: Proof of age documentation may be required.
            value: optional
        documents:
          - documentType: ESIGNATURE
            fileName: NAICBuyerGuideFixedDeferredAnnuitiesMTNM.pdf
            uploadDate: 04/06/2026 11:22:05 PM
            documentId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
            documentSize: 9000000
            attachmentType: null
            formType: null
          - documentType: DRIVER LICENSE – PROOF OF AGE
            fileName: NAICBuyerGuideFixedDeferredAnnuitiesMTNM1.pdf
            uploadDate: 04/06/2026 11:26:07 PM
            documentId: b2c3d4e5-f6a7-8901-bcde-f12345678901
            documentSize: 10000000
            attachmentType: null
            formType: null
        requiredDocuments:
          - attachmentType: APP
            displayName: Signed application
            documentType: APPLICATION
            formType: APP_FULL
            message: Upload the fully signed application prior to submission.
    AdditionalDocumentType:
      type: object
      properties:
        attachmentType:
          type: array
          items:
            type: string
          description: List of attachment type codes
          nullable: true
        documentType:
          type: array
          items:
            type: string
          description: List of document type codes
          nullable: true
        formType:
          type: array
          items:
            type: string
          description: List of form type codes
          nullable: true
      additionalProperties: false
    DocumentRule:
      type: object
      properties:
        conditions:
          type: string
          description: Conditions under which the rule applies
          nullable: true
        key:
          type: string
          description: Rule key
          nullable: true
        message:
          type: string
          description: Rule message shown to the user
          nullable: true
        value:
          type: string
          description: Rule value
          nullable: true
      additionalProperties: false
    AttachmentDocument:
      type: object
      properties:
        attachmentType:
          type: string
          description: Attachment type code when applicable; otherwise null.
          nullable: true
        documentType:
          type: string
          description: Document type label or code.
          nullable: true
        fileName:
          type: string
          description: Original file name as uploaded.
          nullable: true
        formType:
          type: string
          description: Form type code when applicable; otherwise null.
          nullable: true
        uploadDate:
          type: string
          description: Upload timestamp as returned by the attachment service.
          nullable: true
        documentId:
          type: string
          description: Electronic document service (EDS) identifier for the uploaded file.
          nullable: true
        documentSize:
          type: integer
          description: Size of the uploaded file in bytes.
          format: int64
          nullable: true
      additionalProperties: false
      example:
        documentType: ESIGNATURE
        fileName: NAICBuyerGuideFixedDeferredAnnuitiesMTNM.pdf
        uploadDate: 04/06/2026 11:22:05 PM
        documentId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        documentSize: 9000000
        attachmentType: null
        formType: null
    RequiredDocument:
      type: object
      properties:
        attachmentType:
          type: string
          description: Attachment type code
          nullable: true
        displayName:
          type: string
          description: Display name shown to the user
          nullable: true
        documentType:
          type: string
          description: Document type code
          nullable: true
        formType:
          type: string
          description: Form type code
          nullable: true
        message:
          type: string
          description: Instructional message for the required document
          nullable: true
      additionalProperties: false
    AttachmentResponse:
      required:
        - carrierCode
        - data
        - transactionId
      type: object
      properties:
        transactionId:
          minLength: 1
          type: string
          description: Unique identifier for the Order Entry transaction.
        carrierCode:
          minLength: 1
          type: string
          description: Carrier code required to push documents to EDS.
        distributorCode:
          type: string
          description: Optional distributor code.
          nullable: true
        sourceSystem:
          enum:
            - AnnuityNet
            - LifeSpeed
          type: string
          description: "Source system identifier. Allowed values: AnnuityNet, LifeSpeed."
          nullable: true
        caseId:
          type: string
          description: Case identifier associated with the transaction.
          nullable: true
        data:
          allOf:
            - $ref: "#/components/schemas/AttachmentData"
          description: Documents already uploaded, required documents, optional types, and
            document rules.
          example:
            additionalDocumentTypes:
              - attachmentType: []
                documentType:
                  - Wet-signed Paperwork
                  - Supporting Documents
                  - Trust Certification
                  - Green Card
                  - Driver License – Proof of Age
                  - Illustration
                  - POA Paperwork
                  - Check Deposit Form
                formType: []
            documentRules:
              - conditions: Owner age < 65
                key: PROOF_OF_AGE
                message: Proof of age documentation may be required.
                value: optional
            documents:
              - documentType: ESIGNATURE
                fileName: NAICBuyerGuideFixedDeferredAnnuitiesMTNM.pdf
                uploadDate: 04/06/2026 11:22:05 PM
                documentId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                documentSize: 9000000
                attachmentType: null
                formType: null
              - documentType: DRIVER LICENSE – PROOF OF AGE
                fileName: NAICBuyerGuideFixedDeferredAnnuitiesMTNM1.pdf
                uploadDate: 04/06/2026 11:26:07 PM
                documentId: b2c3d4e5-f6a7-8901-bcde-f12345678901
                documentSize: 10000000
                attachmentType: null
                formType: null
            requiredDocuments:
              - attachmentType: APP
                displayName: Signed application
                documentType: APPLICATION
                formType: APP_FULL
                message: Upload the fully signed application prior to submission.
      additionalProperties: false
      example:
        transactionId: "1125715"
        distributorCode: ABCD
        carrierCode: ABCD
        sourceSystem: AnnuityNet
        caseId: CA0000188538
        data:
          additionalDocumentTypes:
            - attachmentType: []
              documentType:
                - Wet-signed Paperwork
                - Supporting Documents
                - Trust Certification
                - Green Card
                - Driver License – Proof of Age
                - Illustration
                - POA Paperwork
                - Check Deposit Form
              formType: []
          documentRules:
            - conditions: Owner age < 65
              key: PROOF_OF_AGE
              message: Proof of age documentation may be required.
              value: optional
          documents:
            - documentType: ESIGNATURE
              fileName: NAICBuyerGuideFixedDeferredAnnuitiesMTNM.pdf
              uploadDate: 04/06/2026 11:22:05 PM
              documentId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
              documentSize: 9000000
              attachmentType: null
              formType: null
            - documentType: DRIVER LICENSE – PROOF OF AGE
              fileName: NAICBuyerGuideFixedDeferredAnnuitiesMTNM1.pdf
              uploadDate: 04/06/2026 11:26:07 PM
              documentId: b2c3d4e5-f6a7-8901-bcde-f12345678901
              documentSize: 10000000
              attachmentType: null
              formType: null
          requiredDocuments:
            - attachmentType: APP
              displayName: Signed application
              documentType: APPLICATION
              formType: APP_FULL
              message: Upload the fully signed application prior to submission.
```