Search
K
Documents

Documents

0.4.5OAS 3.0

Zinnia API service for documents and tax-forms.

Version History

  • Draft version 0.4.3
    • Update tax form request and response fields for both search and download
      -Removed fields which are not required for download taxform
      -Added format for date-time fields
      -Added fromDate, toDate, limit, offset for filtering taxforms
      -Added uplaod document API
      -added Metadata, DocumentUploadResponse, DocumentUploadBadRequest, DocumentUploadForbidden schema for document uplaod API
      -Updated taxYear, fromDate, toDate fields description
API Base URL
  • Server 1:https://dev.api.zinnia.io

    Dev Environment

  • Server 2:https://qa.api.zinnia.io

    QA Environment

  • Server 3:https://uat.api.zinnia.io

    UAT Environment

  • Server 4:https://api.zinnia.io

    PROD Environment

Security
basic (http)

Basic authentication is a simple authentication scheme built into the HTTP protocol.
To use it, send your HTTP requests with an Authorization header that contains the word Basic
followed by a space and a base64-encoded string username:password.

Example: Authorization: Basic ZGVtbzpwQDU1dzByZA==

Auth0 (openIdConnect)

Documents V2

getDocuments

this is an endpoint to get a list of document metadata

get

Query Parameters

sourcestring

Source of the document

Example:correspondence

clientCodestring

Carrier code of the document

Example:EVGL

contractNumberstring

This will be conditional mandatory. Either of contract number or date range is required in order to retrieve the documents.

Example:A000000071

documentDatestring(date-time)

Date on which document has been added in Zinnia system

Example:2025-01-01T10:20:00

documentStartDatestring(date-time)

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

documentEndDatestring(date-time)

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

documentTypestring

Type of the document

Example:NB Application

importStartDatestring(date-time)

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

importEndDatestring(date-time)

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

masterNumberstring

Unique number assigned to the agent

Example:MA00186973

docStatusstring

Status of the document. Can be provided in comma separated value. Default will be ‘active’

Example:Active,Removed,Archived

caseIdstring

Unique number assigned to case

Example:0987654321

documentNumberstring

Document number

Example:1234567890

recipientstring

Recipient of the document

Allowed values:AgentClient

Example:Agent

zinniaLiveCaseIdstring

Unique case ID in the Zinnia system associated with the document

Example:ZLC09876

periodsarray[object]

Periods of the document

Example:[{"PeriodYear":"2020","PeriodQuarters":["Q1","Q2","Q3","Q4"]}]

Show Child Parameters

Headers

Authorizationstringrequired

This will be passed as Bearer plus “token” as generated by above token API.

Example:Bearer eykjsfjfjasdasdad

Response

application/json

OK

InlineResponse200

countnumberrequired
itemsarray[object]required
Show Child Parameters
get/document/v2/documents
 
application/json

getDocument

this is an endpoint to get a specific documents metadata

get

Query Parameters

docTypestringrequired

Type of the document

Example:NB Application

sourcestring

Source of the document

Example:correspondence

clientCodestring

Carrier code of the document

Example:EVGL

Path Parameters

documentIdstringrequired

Unique number assigned to the document

Example:1234567890

Headers

Authorizationstringrequired

This will be passed as Bearer plus “token” as generated by above token API.

Example:Bearer eykjsfjfjasdasdad

Response

application/json

OK

Document

clientInstitutionstringrequired
lobstringrequired
contractstringrequired
agentNumberstringrequired
externalIdstringrequired
documentNumberstringrequired
processCompanyCodestringrequired
contractStatusCodestringrequired
systemstringrequired
productLinestringrequired
productNamestringrequired
productCompanyCodestringrequired
ssNTaxIdstringrequired
caseIdstringrequired
batchIdstringrequired
routestringrequired
sourcestringrequired
sysMailToAddressstringrequired
sysMailFromAddressstringrequired
dateReceivedstringrequired
onBaseDtstringrequired
queueNamestringrequired
transactionTypestringrequired
sysDocumentHandlestringrequired
agentTaxIdstringrequired
documentTypeGroupstringrequired
distributionChannelstringrequired
businessUnitstringrequired
productCategorystringrequired
deliveryMethodstringrequired

Allowed values:EmailFaxMail

get/document/v2/documents/{documentId}
 
application/json

downloadDocument-v2

this is an endpoint to download a document

get

Query Parameters

sourcestring

Source of the document

Example:correspondence

clientCodestring

Carrier code of the document

Example:EVGL

policyNumberstring

Policy number associated with the document, used for identification

Example:1234567890

planCodestring

Plan code associated with the document, used for identification

Example:1234567890

Path Parameters

documentIdstringrequired

Unique number assigned to the document

Example:1234567890

Headers

Authorizationstringrequired

This will be passed as Bearer plus “token” as generated by above token API.

Example:Bearer eykjsfjfjasdasdad

Response

OK

DownloadDocumentResponse

fileExtensionstringrequired
binaryDatastringrequired
get/document/v2/documents/{documentId}/download