--- title: "SearchRequest" url: "https://developers.zinnia.com/apis/documents-0-3-0/versions/43d1ee7b-44e7-4303-b0cd-ca813c63b625/schemas/SearchRequest" --- > Full API specification: https://developers.zinnia.com/apis/documents-0-3-0/versions/43d1ee7b-44e7-4303-b0cd-ca813c63b625.md # SearchRequest ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Enterprise Documents API version: 3.0.0 servers: - url: https://dev.api.zinnia.io description: Dev Environment - url: https://qa.api.zinnia.io description: QA Environment - url: https://uat.api.zinnia.io description: UAT Environment - url: https://api.zinnia.io description: PROD Environment components: schemas: SearchRequest: anyOf: - type: object description: Date Range scenario - Document date range search properties: documentStartDate: type: string description: Start date of the document period for filtering results format: date example: 2024-10-01 documentEndDate: type: string description: End date of the document period for filtering results format: date example: 2024-10-31 parentCarrierCode: type: string description: Client code associated with the document search example: EVGL documentClassification: type: string description: Classification of the document indicating type, e.g., outbound or inbound example: OUTBOUND enum: - OUTBOUND - INBOUND documentType: type: string description: Type of document, defining its primary purpose example: NB Application documentCategory: type: string description: Category of the document, such as New Business or Claim example: NEW_BUSINESS enum: - NEW_BUSINESS - POST_ISSUE - DEATH - CORRESPONDENCE - AGENT - SUITABILITY policyNumber: type: string description: Policy number associated with the document, used for identification example: "23109168" planCode: type: string description: Plan code associated with the document, used for identification example: plan67890f documentStatus: type: array description: List of statuses the document may have, supporting filtering by multiple statuses example: - ACTIVE - INACTIVE items: type: string description: List of statuses the document may have, supporting filtering by multiple statuses enum: - ACTIVE - INACTIVE appId: type: string description: Application ID tied to the document for tracking and retrieval example: EDJ041120240000000001 zinniaLiveCaseId: type: string description: Unique case ID in the Zinnia system associated with the document example: ZLC09876 orderBy: type: string description: The field used to order search results; default is document Date example: documentDate orderByDirection: type: string description: Direction of the sort order for search results, either ascending or descending example: DESC enum: - ASC - DESC recipient: type: string description: Recipient of the document example: AGENT enum: - AGENT - CLIENT appVersion: type: integer description: App Version format: int32 example: 1 masterAgentNumber: type: string description: Master Agent Number example: MA98416687 required: - documentStartDate - documentEndDate - type: object description: Date Range scenario - Import date range search properties: parentCarrierCode: type: string description: Client code associated with the document search example: EVGL documentClassification: type: string description: Classification of the document indicating type, e.g., outbound or inbound example: OUTBOUND enum: - OUTBOUND - INBOUND documentType: type: string description: Type of document, defining its primary purpose example: NB Application documentCategory: type: string description: Category of the document, such as New Business or Claim example: NEW_BUSINESS enum: - NEW_BUSINESS - POST_ISSUE - DEATH - CORRESPONDENCE - AGENT - SUITABILITY policyNumber: type: string description: Policy number associated with the document, used for identification example: "23109168" planCode: type: string description: Plan code associated with the document, used for identification example: plan67890f importStartDate: type: string description: Import Start date of the document period for filtering results (in UTC timezone) format: date-time example: 2024-10-01T10:20:00.000Z importEndDate: type: string description: Import End date of the document period for filtering results (in UTC timezone) format: date-time example: 2025-10-01T10:20:00.000Z documentStatus: type: array description: List of statuses the document may have, supporting filtering by multiple statuses example: - ACTIVE - INACTIVE items: type: string description: List of statuses the document may have, supporting filtering by multiple statuses enum: - ACTIVE - INACTIVE appId: type: string description: Application ID tied to the document for tracking and retrieval example: EDJ041120240000000001 zinniaLiveCaseId: type: string description: Unique case ID in the Zinnia system associated with the document example: ZLC09876 orderBy: type: string description: The field used to order search results; default is document Date example: documentDate orderByDirection: type: string description: Direction of the sort order for search results, either ascending or descending example: DESC enum: - ASC - DESC recipient: type: string description: Recipient of the document example: AGENT enum: - AGENT - CLIENT appVersion: type: integer description: App Version format: int32 example: 1 masterAgentNumber: type: string description: Master Agent Number example: MA98416687 required: - importStartDate - importEndDate - type: object description: Policy Number scenario - Search based on policy number and plan code properties: parentCarrierCode: type: string description: Client code associated with the document search example: EVGL documentClassification: type: string description: Classification of the document indicating type, e.g., outbound or inbound example: OUTBOUND enum: - OUTBOUND - INBOUND documentType: type: string description: Type of document, defining its primary purpose example: NB Application documentCategory: type: string description: Category of the document, such as New Business or Claim example: NEW_BUSINESS enum: - NEW_BUSINESS - POST_ISSUE - DEATH - CORRESPONDENCE - AGENT - SUITABILITY policyNumber: type: string description: Policy number associated with the document, used for identification example: "23109168" planCode: type: string description: Plan code associated with the document, used for identification example: plan67890f documentStatus: type: array description: List of statuses the document may have, supporting filtering by multiple statuses example: - ACTIVE - INACTIVE items: type: string description: List of statuses the document may have, supporting filtering by multiple statuses enum: - ACTIVE - INACTIVE appId: type: string description: Application ID tied to the document for tracking and retrieval example: EDJ041120240000000001 zinniaLiveCaseId: type: string description: Unique case ID in the Zinnia system associated with the document example: ZLC09876 orderBy: type: string description: The field used to order search results; default is document Date example: documentDate orderByDirection: type: string description: Direction of the sort order for search results, either ascending or descending example: DESC enum: - ASC - DESC recipient: type: string description: Recipient of the document example: AGENT enum: - AGENT - CLIENT appVersion: type: integer description: App Version format: int32 example: 1 masterAgentNumber: type: string description: Master Agent Number example: MA98416687 required: - policyNumber - type: object description: Agent Documents scenario - Search based on master agent number properties: parentCarrierCode: type: string description: Client code associated with the document search example: EVGL documentClassification: type: string description: Classification of the document indicating type, e.g., outbound or inbound example: OUTBOUND enum: - OUTBOUND - INBOUND documentType: type: string description: Type of document, defining its primary purpose example: NB Application documentCategory: type: string description: Category of the document, such as New Business or Claim example: NEW_BUSINESS enum: - NEW_BUSINESS - POST_ISSUE - DEATH - CORRESPONDENCE - AGENT - SUITABILITY policyNumber: type: string description: Policy number associated with the document, used for identification example: "23109168" planCode: type: string description: Plan code associated with the document, used for identification example: plan67890f documentStatus: type: array description: List of statuses the document may have, supporting filtering by multiple statuses example: - ACTIVE - INACTIVE items: type: string description: List of statuses the document may have, supporting filtering by multiple statuses enum: - ACTIVE - INACTIVE appId: type: string description: Application ID tied to the document for tracking and retrieval example: EDJ041120240000000001 zinniaLiveCaseId: type: string description: Unique case ID in the Zinnia system associated with the document example: ZLC09876 orderBy: type: string description: The field used to order search results; default is document Date example: documentDate orderByDirection: type: string description: Direction of the sort order for search results, either ascending or descending example: DESC enum: - ASC - DESC recipient: type: string description: Recipient of the document example: AGENT enum: - AGENT - CLIENT appVersion: type: integer description: App Version format: int32 example: 1 masterAgentNumber: type: string description: Master Agent Number example: MA98416687 required: - masterAgentNumber - type: object description: Application ID scenario - Search based on application ID properties: parentCarrierCode: type: string description: Client code associated with the document search example: EVGL documentClassification: type: string description: Classification of the document indicating type, e.g., outbound or inbound example: OUTBOUND enum: - OUTBOUND - INBOUND documentType: type: string description: Type of document, defining its primary purpose example: NB Application documentCategory: type: string description: Category of the document, such as New Business or Claim example: NEW_BUSINESS enum: - NEW_BUSINESS - POST_ISSUE - DEATH - CORRESPONDENCE - AGENT - SUITABILITY policyNumber: type: string description: Policy number associated with the document, used for identification example: "23109168" planCode: type: string description: Plan code associated with the document, used for identification example: plan67890f documentStatus: type: array description: List of statuses the document may have, supporting filtering by multiple statuses example: - ACTIVE - INACTIVE items: type: string description: List of statuses the document may have, supporting filtering by multiple statuses enum: - ACTIVE - INACTIVE appId: type: string description: Application ID tied to the document for tracking and retrieval example: EDJ041120240000000001 zinniaLiveCaseId: type: string description: Unique case ID in the Zinnia system associated with the document example: ZLC09876 orderBy: type: string description: The field used to order search results; default is document Date example: documentDate orderByDirection: type: string description: Direction of the sort order for search results, either ascending or descending example: DESC enum: - ASC - DESC recipient: type: string description: Recipient of the document example: AGENT enum: - AGENT - CLIENT appVersion: type: integer description: App Version format: int32 example: 1 masterAgentNumber: type: string description: Master Agent Number example: MA98416687 required: - appId - type: object description: Zinnia Live Case ID scenario - Search based on Zinnia Live Case ID properties: parentCarrierCode: type: string description: Client code associated with the document search example: EVGL documentClassification: type: string description: Classification of the document indicating type, e.g., outbound or inbound example: OUTBOUND enum: - OUTBOUND - INBOUND documentType: type: string description: Type of document, defining its primary purpose example: NB Application documentCategory: type: string description: Category of the document, such as New Business or Claim example: NEW_BUSINESS enum: - NEW_BUSINESS - POST_ISSUE - DEATH - CORRESPONDENCE - AGENT - SUITABILITY policyNumber: type: string description: Policy number associated with the document, used for identification example: "23109168" planCode: type: string description: Plan code associated with the document, used for identification example: plan67890f documentStatus: type: array description: List of statuses the document may have, supporting filtering by multiple statuses example: - ACTIVE - INACTIVE items: type: string description: List of statuses the document may have, supporting filtering by multiple statuses enum: - ACTIVE - INACTIVE appId: type: string description: Application ID tied to the document for tracking and retrieval example: EDJ041120240000000001 zinniaLiveCaseId: type: string description: Unique case ID in the Zinnia system associated with the document example: ZLC09876 orderBy: type: string description: The field used to order search results; default is document Date example: documentDate orderByDirection: type: string description: Direction of the sort order for search results, either ascending or descending example: DESC enum: - ASC - DESC recipient: type: string description: Recipient of the document example: AGENT enum: - AGENT - CLIENT appVersion: type: integer description: App Version format: int32 example: 1 masterAgentNumber: type: string description: Master Agent Number example: MA98416687 required: - zinniaLiveCaseId ```