Search
K
Documents

Searches for documents

finds documents based on filters like document classification, document type, policy number etc

post

Query Parameters

limitinteger(int32)

Default:10

<= 1000

Example:25

offsetinteger(int32)

Default:0

Example:1

Headers

Authorizationstringrequired

Authorization token

Example:Bearer <token>

x-correlation-idstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

Body

application/json

SearchRequest

SearchRequest
Any Of
documentStartDatestring(date)required

Start date of the document period for filtering results

Example:2024-10-01

documentEndDatestring(date)required

End date of the document period for filtering results

Example:2024-10-31

parentCarrierCodestring

Client code associated with the document search

Example:EVGL

documentClassificationstring

Classification of the document indicating type, e.g., outbound or inbound

Allowed values:OUTBOUNDINBOUND

Example:OUTBOUND

documentTypestring

Type of document, defining its primary purpose

Example:NB Application

documentCategorystring

Category of the document, such as New Business or Claim

Allowed values:NEW_BUSINESSPOST_ISSUEDEATHCORRESPONDENCEAGENTSUITABILITY

Example:NEW_BUSINESS

policyNumberstring

Policy number associated with the document, used for identification

Example:23109168

planCodestring

Plan code associated with the document, used for identification

Example:plan67890f

documentStatusarray[string]

List of statuses the document may have, supporting filtering by multiple statuses

Allowed values:ACTIVEINACTIVE

Example:["ACTIVE","INACTIVE"]

appIdstring

Application ID tied to the document for tracking and retrieval

Example:EDJ041120240000000001

zinniaLiveCaseIdstring

Unique case ID in the Zinnia system associated with the document

Example:ZLC09876

orderBystring

The field used to order search results; default is document Date

Example:documentDate

orderByDirectionstring

Direction of the sort order for search results, either ascending or descending

Allowed values:ASCDESC

Example:DESC

recipientstring

Recipient of the document

Allowed values:AGENTCLIENT

Example:AGENT

appVersioninteger(int32)

App Version

Example:1

masterAgentNumberstring

Master Agent Number

Example:MA98416687

Response

application/json

documents retrieved successfully

SearchDocumentResponse

countinteger(int32)

Number of total documents found matching the search criteria

Example:100

documentsarray[object]
Show Child Parameters
correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

post/document/v3/documents/search

Body

{}
 
application/json

TaxForms V3

Retrieves tax forms

Fetches tax forms based on client and year filters

get

Query Parameters

parentCarrierCodestring

Carrier code

Example:EVGL

policyNumberstring

Policy number (either policyNumber or ssn is mandatory)

Example:7720001823

planCodestring

Plan Code

Example:132007A04

ssnstring

Social Security Number (either policyNumber or ssn is mandatory)

Example:123456

taxYearinteger(int32)

Example:2022

numYearsinteger(int32)

Default:1

>= 1<= 5

Example:1

Headers

Authorizationstringrequired

Authorization token

Example:Bearer <token>

x-correlation-idstring

UUID for the request

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

Response

application/json

OK

TaxformResponseList

countinteger(int32)

Number of tax forms found

Example:10

itemsarray[object]
Show Child Parameters
correlationIdstring

Unique ID for correlating requests

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

get/document/v3/tax-forms
 
application/json

Downloads a tax form

Retrieves a tax form by its unique ID

get

Query Parameters

parentCarrierCodestring

Carrier code

Example:EVGL

policyNumberstring

Policy number (either policyNumber or ssn is mandatory)

Example:7720001823

planCodestring

Plan Code

Example:132007A04

ssnstring

Social Security Number (either policyNumber or ssn is mandatory)

Example:123456

taxYearinteger(int32)

Example:2022

fCharstring

Unique string character associated with the tax-form name

Example:R

Path Parameters

formIdstringrequired

Unique form id for the tax-form

Example:44101

Headers

Authorizationstringrequired

Authorization token

Example:Bearer <token>

x-correlation-idstring

UUID for the request

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

Response

application/json

OK

TaxformDownloadResponse

fileExtensionstring

File extension of the document

Example:pdf

binaryDatastring

Binary data of the document

Example:wdvb2ekllkk189w0enjansle..

correlationIdstring

Unique ID for correlating requests

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

get/document/v3/tax-forms/{formId}/download
 
application/json

MetadataByIdResponse

object
metadataobject
Show Child Parameters
correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

Example