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
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Source system or origin of the document
Example:Email
Unique ID in EDS db
Example:670e23dfab593b4387210b81
Form number associated with the document
Example:FORM123
Type of file, e.g., pdf, doc, etc.
Example:pdf
Classification of the document, e.g., OUTBOUND or INBOUND
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
Type of document indicating its purpose
Example:NB Application
Category of the document, such as New Business or Claim
Example:New Business
Description of the document type
Example:Deferred Annuity Application
Indicates the current status of the document. ‘1’ for ACTIVE, ‘0’ for INACTIVE.
Example:1
Version of the document
Example:1
Date of the document
Example:2024-03-18T14:30:00.000Z
Zinnia Live Case ID
Example:ZLC09876
Plan code
Example:565
Policy number associated with the document
Example:23109168
Broker master number associated with the document
Example:BKR123456
Representative master number associated with the document
Example:REP987654
External ID of the agent associated with the document
Example:AGT12345
External ID of the broker associated with the document
Example:BRK12345
Mail tracking number
Example:TRK123456
Delivery method
Example:Email
Email address
Example:XHbN8@example.com
Email address
Example:XHbN8@example.com
Email subject
Example:Deferred Annuity Application
Application ID
Example:APP123456
Mail ship date
Example:2024-03-18T14:30:00.000Z
Account number of the participant
Example:123456789
Name of the file in source system
Example:files/123456.pdf
Display name of the document
Example:Deferred Annuity Application
Distribution channel through which the document was delivered
Example:Online Portal
Year of the document period
Example:2024
Quarter of the document period in Q1-Q4 format
Example:Q2
Document number associated with the document (if present) else document Id
Example:670e23dfab593b4387210b81 or 20241230-M-463066
Previous versions of the document
Scenario
Allowed values:duplicatereplace
Example:duplicate
Linked document ID
Example:693e23dfab593b4387210k92
Document creation timestamp(in UTC timezone)
Example:2024-09-23T10:30:00.000Z
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
policy number of document/tax-form
Example:633033992
Name of the form
Example:1099-R
Unique id of Form
Example:105
Tax year of the form
Example:2022
Unique string character associated with the tax-form name
Example:R
Plan code associated with the document
Example:633033992
Unique Document Id (ObjectId)
Example:68a6adf406e31b19bfcea183
Created Date in UTC time zone
Example:2025-08-13T15:01:17.542Z
Updated Date in UTC time zone
Example:2025-08-13T15:01:17.542Z
Status intigating whether tax form is active or inactive
Example:active