Search
K
Documents

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

Example

SearchDocumentResponse

object
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

Example

DownloadDocumentResponse

object
fileExtensionstringrequired
binaryDatastringrequired
Example

Message

object
langstringrequired
valuestringrequired
Example

InnerError

object
messagestringrequired
typestringrequired
stacktracestringrequired
Example