Search
K
Documents

InlineResponse401

object
messagestringrequired
Example

InlineResponse404

object
messagestringrequired
Example

Document

object
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

Example

MetadataSearchResponse

object
documentClassificationstring

Document classification to identify document type

Allowed values:OUTBOUNDINBOUND

Example:OUTBOUND

sourceFileNamestring

Actual name of the document

Example:123456.pdf

planCodestring

Plan code associated with the document

Example:235

documentStatusinteger(int32)

Indicates the current status of the document. ‘1’ for ACTIVE, ‘0’ for INACTIVE.

Example:1

documentIdstring

Unique ID of the document

Example:67124697f3bef2497b6accfb

documentDatestring(date-time)

Date associated with the document

documentTypestring

Type of the document

Example:NB Application

documentCategorystring

Category of the document

Example:New Business

documentTypeDescriptionstring

Detailed description of the document type

Example:Deferred Annuity Application

zinniaLiveCaseIdstring

Zinnia live case ID associated with the document

Example:ZLC09876

appIdstring

Application ID related to the document

Example:XXXXEDJ041120240000000001

mailTrackingNumberstring

Tracking ID for the document

Example:4453166346

policyNumberstring

Policy number linked to the document

Example:23576001

createDatestring(date-time)

Creation date of the document (in UTC timezone)

Example:2024-03-18T14:30:00.000Z

correlationIdstring

Correlation ID for the document

Example:12345-corr-67890

periodYearinteger(int32)

Year related to the document period

Example:2024

periodQuarterstring

Quarter related to the document period

Example:Q2

fileTypestring

File type of the document

Example:pdf

displayNamestring

Display name for the document

Example:New Business Policy Document

brokerMasterNumberstring

Master number of the broker associated with the document

Example:BKR123456

repMasterNumberstring

Master number of the representative associated with the document

Example:REP987654

documentNumberstring

Document number associated with the document (if present) else document Id

Example:670e23dfab593b4387210b81 or 20241230-M-463066

formNumberstring

formNumber

Example:1234

importDatestring(date-time)

Document creation timestamp(in UTC timezone)

Example:2024-09-23T10:30:00.000Z

Example

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