This is an endpoint to download a tax-form from SOVOS
Client code for the carrier/client
Example:EVGL
Contract number for the document/tax-form
Example:1234567898
Unique string character associated with the tax-form name
Example:R
Tax-year for the form (defaults to current year-1)
Example:2023
Form id for the tax-form
Example:123456
Authorization token
Example:Bearer <token>
OK
Fetches metadata details, including version history if requested
Indicates if all versions are required in the response
Default:false
Example:true
Type of document indicating its purpose
Example:NB Application
Classification of the document, e.g., OUTBOUND OR INBOUND
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
Client code associated with the document
Example:EVGL
Unique ID in EDS db
Example:670e23dfab593b4387210b81
Authorization token
Example:Bearer <token>
Unique ID for correlating requests
Example:1760f822-dcbf-49fc-a623-a1998383f4b9
document metadata retrieved successfully
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Downloads a document based on its unique identifier
Classification of the document, e.g., OUTBOUND or INBOUND
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
Client code associated with the document
Example:EVGL
Policy number associated with the document
Example:23109168
Plan code
Example:565
Unique ID in EDS DB
Example:670e23dfab593b4387210b81
Authorization token
Example:Bearer <token>
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
document downloaded successfully
File extension of the document
Example:pdf
Name of the document
Example:NB Application
Binary data of the document
Example:wdvb2ekllkk189w0enjansle..
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
finds documents based on filters like document classification, document type, policy number etc
Default:10
<= 1000
Example:25
Default:0
Example:1
Authorization token
Example:Bearer <token>
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
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
documents retrieved successfully
Number of total documents found matching the search criteria
Example:100
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000