Zinnia

Zinnia Documents V2 API

The Documents V2 API from Zinnia — 3 operation(s) for documents v2.

Documentation GitHub OpenAPI

Operations 3

GET /document/v2/documents Get documents #

GET /document/v2/documents/{documentId} Get document #

GET /document/v2/documents/{documentId}/download Download document v2 #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zinnia:zinnia-documents-v2-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Enterprise Documents Documents V2 API
  description: 'The Enterprise Document Service (EDS) API is the system of record for documents

    across the Zinnia life insurance and annuity platform.'
  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
tags:
- name: Documents V2
  description: ''
paths:
  /document/v2/documents:
    get:
      operationId: getDocuments
      summary: Get documents
      description: this is an endpoint to get a list of document metadata
      parameters:
      - name: Authorization
        required: true
        in: header
        schema:
          type: string
        description: This will be passed as Bearer plus "token" as generated by above token API.
        example: Bearer eykjsfjfjasdasdad
      - name: source
        required: false
        in: query
        schema:
          type: string
        description: Source of the document
        example: correspondence
      - name: clientCode
        required: false
        in: query
        schema:
          type: string
        description: Carrier code of the document
        example: EVGL
      - name: contractNumber
        required: false
        in: query
        schema:
          type: string
        description: This will be conditional mandatory. Either of contract number or date range is required in order to retrieve the documents.
        example: A000000071
      - name: documentDate
        required: false
        in: query
        schema:
          format: date-time
          type: string
        description: Date on which document has been added in Zinnia system
        example: '2025-01-01T10:20:00'
      - name: documentStartDate
        required: false
        in: query
        schema:
          format: date-time
          type: string
        description: This will be conditional mandatory. Either of contract number or date range is required in order to retrieve the documents. Date to define the document list based on document date range. Document Start Date
        example: '2025-01-01T10:20:00'
      - name: documentEndDate
        required: false
        in: query
        schema:
          format: date-time
          type: string
        description: This will be conditional mandatory. Either of contract number or date range is required in order to retrieve the documents. Date to define the document list based on document date range. Document End Date
        example: '2025-03-01T10:20:20'
      - name: documentType
        required: false
        in: query
        schema:
          type: string
        description: Type of the document
        example: NB Application
      - name: importStartDate
        required: false
        in: query
        schema:
          format: date-time
          type: string
        description: This will be conditional mandatory. Either of contract number or date range is required in order to retrieve the documents. Date to define the document list based on import date range
        example: '2023-01-01T15:41:16'
      - name: importEndDate
        required: false
        in: query
        schema:
          format: date-time
          type: string
        description: This will be conditional mandatory. If document start date is provided, then it should be madatorily provided. Date to define the document list based on import date range
        example: '2023-03-01T15:41:16'
      - name: masterNumber
        required: false
        in: query
        schema:
          type: string
        description: Unique number assigned to the agent
        example: MA00186973
      - name: docStatus
        required: false
        in: query
        schema:
          type: string
        description: Status of the document. Can be provided in comma separated value. Default will be 'active'
        example: Active,Removed,Archived
      - name: caseId
        required: false
        in: query
        schema:
          type: string
        description: Unique number assigned to case
        example: 0987654321
      - name: documentNumber
        required: false
        in: query
        schema:
          type: string
        description: Document number
        example: '1234567890'
      - name: recipient
        required: false
        in: query
        schema:
          $ref: '#/components/schemas/Recipient'
        description: Recipient of the document
        example: Agent
      - name: zinniaLiveCaseId
        required: false
        in: query
        schema:
          type: string
        description: Unique case ID in the Zinnia system associated with the document
        example: ZLC09876
      - name: periods
        required: false
        in: query
        description: Periods of the document
        example:
        - PeriodYear: '2020'
          PeriodQuarters:
          - Q1
          - Q2
          - Q3
          - Q4
        schema:
          type: array
          items:
            type: object
            properties:
              PeriodYear:
                type: string
              PeriodQuarters:
                type: array
                items:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse400'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse401'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse404'
      tags:
      - Documents V2
      security:
      - Auth0: []
      x-summary-source: derived
  /document/v2/documents/{documentId}:
    get:
      operationId: getDocument
      summary: Get document
      description: this is an endpoint to get a specific documents metadata
      parameters:
      - name: Authorization
        required: true
        in: header
        schema:
          type: string
        description: This will be passed as Bearer plus "token" as generated by above token API.
        example: Bearer eykjsfjfjasdasdad
      - name: documentId
        required: true
        in: path
        schema:
          type: string
        description: Unique number assigned to the document
        example: '1234567890'
      - name: docType
        required: true
        in: query
        schema:
          type: string
        description: Type of the document
        example: NB Application
      - name: source
        required: false
        in: query
        schema:
          type: string
        description: Source of the document
        example: correspondence
      - name: clientCode
        required: false
        in: query
        schema:
          type: string
        description: Carrier code of the document
        example: EVGL
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse400'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse401'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse404'
      tags:
      - Documents V2
      security:
      - Auth0: []
      x-summary-source: derived
  /document/v2/documents/{documentId}/download:
    get:
      operationId: downloadDocument-v2
      summary: Download document v2
      description: this is an endpoint to download a document
      parameters:
      - name: documentId
        required: true
        in: path
        schema:
          type: string
        description: Unique number assigned to the document
        example: '1234567890'
      - name: Authorization
        required: true
        in: header
        schema:
          type: string
        description: This will be passed as Bearer plus "token" as generated by above token API.
        example: Bearer eykjsfjfjasdasdad
      - name: source
        required: false
        in: query
        schema:
          type: string
        description: Source of the document
        example: correspondence
      - name: clientCode
        required: false
        in: query
        schema:
          type: string
        description: Carrier code of the document
        example: EVGL
      - name: policyNumber
        required: false
        in: query
        schema:
          type: string
        description: Policy number associated with the document, used for identification
        example: '1234567890'
      - name: planCode
        required: false
        in: query
        schema:
          type: string
        description: Plan code associated with the document, used for identification
        example: '1234567890'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadDocumentResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/DownloadDocumentResponse'
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse4001'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse401'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineResponse404'
      tags:
      - Documents V2
      security:
      - Auth0: []
      x-summary-source: derived
components:
  schemas:
    DocumentMetadata:
      type: object
      properties:
        documentID:
          type: string
        pageCount:
          type: string
        documentDate:
          format: date-time
          type: string
        importDate:
          format: date-time
          type: string
        fileName:
          type: string
        fileType:
          type: string
        displayName:
          type: string
        sourceFileName:
          type: string
        status:
          type: string
        documentType:
          type: string
        contractNumber:
          type: string
        masterNumber:
          type: string
        repMan:
          type: string
        clientID:
          type: string
        history:
          type: boolean
        docStatus:
          type: string
        documentNumber:
          type: string
        caseId:
          type: number
        zinniaLiveCaseId:
          type: string
        docPopUrl:
          type: string
        attachmentType:
          type: string
        periodYear:
          type: string
        periodQuarter:
          type: string
      required:
      - documentID
      - pageCount
      - documentDate
      - importDate
      - fileName
      - fileType
      - displayName
      - sourceFileName
      - status
      - documentType
      - contractNumber
      - masterNumber
      - repMan
      - clientID
      - history
      - docStatus
      - documentNumber
      - caseId
      - zinniaLiveCaseId
      - docPopUrl
      - attachmentType
      - periodYear
      - periodQuarter
    Document:
      type: object
      properties:
        clientInstitution:
          type: string
        lob:
          type: string
        contract:
          type: string
        agentNumber:
          type: string
        externalId:
          type: string
        documentNumber:
          type: string
        processCompanyCode:
          type: string
        contractStatusCode:
          type: string
        system:
          type: string
        productLine:
          type: string
        productName:
          type: string
        productCompanyCode:
          type: string
        ssNTaxId:
          type: string
        caseId:
          type: string
        batchId:
          type: string
        route:
          type: string
        source:
          type: string
        sysMailToAddress:
          type: string
        sysMailFromAddress:
          type: string
        dateReceived:
          type: string
        onBaseDt:
          type: string
        queueName:
          type: string
        transactionType:
          type: string
        sysDocumentHandle:
          type: string
        agentTaxId:
          type: string
        documentTypeGroup:
          type: string
        distributionChannel:
          type: string
        businessUnit:
          type: string
        productCategory:
          type: string
        deliveryMethod:
          type: string
          enum:
          - Email
          - Fax
          - Mail
      required:
      - clientInstitution
      - lob
      - contract
      - agentNumber
      - externalId
      - documentNumber
      - processCompanyCode
      - contractStatusCode
      - system
      - productLine
      - productName
      - productCompanyCode
      - ssNTaxId
      - caseId
      - batchId
      - route
      - source
      - sysMailToAddress
      - sysMailFromAddress
      - dateReceived
      - onBaseDt
      - queueName
      - transactionType
      - sysDocumentHandle
      - agentTaxId
      - documentTypeGroup
      - distributionChannel
      - businessUnit
      - productCategory
      - deliveryMethod
    InnerError:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
        stacktrace:
          type: string
      required:
      - message
      - type
      - stacktrace
    InlineResponse400:
      type: object
      properties:
        xCorrelationId:
          type: string
        status:
          type: number
        errorDesc:
          type: string
        errorDetailedDesc:
          type: string
      required:
      - xCorrelationId
      - status
      - errorDesc
      - errorDetailedDesc
    Message:
      type: object
      properties:
        lang:
          type: string
        value:
          type: string
      required:
      - lang
      - value
    InlineResponse401:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InlineResponse200:
      type: object
      properties:
        count:
          type: number
        items:
          type: array
          items:
            $ref: '#/components/schemas/DocumentMetadata'
      required:
      - count
      - items
    InlineResponse404:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InlineResponse4001:
      type: object
      properties:
        odataError:
          $ref: '#/components/schemas/OdataError'
      required:
      - odataError
    DownloadDocumentResponse:
      type: object
      properties:
        fileExtension:
          type: string
        binaryData:
          type: string
      required:
      - fileExtension
      - binaryData
    OdataError:
      type: object
      properties:
        code:
          type: string
        message:
          $ref: '#/components/schemas/Message'
        innererror:
          $ref: '#/components/schemas/InnerError'
      required:
      - code
      - message
      - innererror
    Recipient:
      type: string
      enum:
      - Agent
      - Client
  securitySchemes:
    basic:
      type: http
      scheme: basic
    Auth0:
      type: openIdConnect
      openIdConnectUrl: https://login.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          run_on_preflight: true
          scopes_claim:
          - https://api.zinnia.io/permissions
          audience_claim:
          - aud
          audience_required:
          - https://api.zinnia.io
          client_id:
          - bGOIRPRq2ZnjCujDXC7ikwR5ez7VH5GZ
          auth_methods:
          - bearer
          scopes: []
        enabled: true
        protocols:
        - grpc
        - grpcs
        - http
        - https