Document
objectAllowed values:EmailFaxMail
MetadataSearchResponse
objectDocument classification to identify document type
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
Actual name of the document
Example:123456.pdf
Plan code associated with the document
Example:235
Indicates the current status of the document. ‘1’ for ACTIVE, ‘0’ for INACTIVE.
Example:1
Unique ID of the document
Example:67124697f3bef2497b6accfb
Date associated with the document
Type of the document
Example:NB Application
Category of the document
Example:New Business
Detailed description of the document type
Example:Deferred Annuity Application
Zinnia live case ID associated with the document
Example:ZLC09876
Application ID related to the document
Example:XXXXEDJ041120240000000001
Tracking ID for the document
Example:4453166346
Policy number linked to the document
Example:23576001
Creation date of the document (in UTC timezone)
Example:2024-03-18T14:30:00.000Z
Correlation ID for the document
Example:12345-corr-67890
Year related to the document period
Example:2024
Quarter related to the document period
Example:Q2
File type of the document
Example:pdf
Display name for the document
Example:New Business Policy Document
Master number of the broker associated with the document
Example:BKR123456
Master number of the representative associated with the document
Example:REP987654
Document number associated with the document (if present) else document Id
Example:670e23dfab593b4387210b81 or 20241230-M-463066
formNumber
Example:1234
Document creation timestamp(in UTC timezone)
Example:2024-09-23T10:30:00.000Z
SearchRequest
Any OfStart date of the document period for filtering results
Example:2024-10-01
End date of the document period for filtering results
Example:2024-10-31
Client code associated with the document search
Example:EVGL
Classification of the document indicating type, e.g., outbound or inbound
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
Type of document, defining its primary purpose
Example:NB Application
Category of the document, such as New Business or Claim
Allowed values:NEW_BUSINESSPOST_ISSUEDEATHCORRESPONDENCEAGENTSUITABILITY
Example:NEW_BUSINESS
Policy number associated with the document, used for identification
Example:23109168
Plan code associated with the document, used for identification
Example:plan67890f
List of statuses the document may have, supporting filtering by multiple statuses
Allowed values:ACTIVEINACTIVE
Example:ACTIVE, INACTIVE
Application ID tied to the document for tracking and retrieval
Example:EDJ041120240000000001
Unique case ID in the Zinnia system associated with the document
Example:ZLC09876
The field used to order search results; default is document Date
Example:documentDate
Direction of the sort order for search results, either ascending or descending
Allowed values:ASCDESC
Example:DESC
Recipient of the document
Allowed values:AGENTCLIENT
Example:AGENT
App Version
Example:1
Master Agent Number
Example:MA98416687
SearchDocumentResponse
objectNumber of total documents found matching the search criteria
Example:100
Show Child Parameters
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000