Search
K
Documents

Retrieves tax forms

Fetches tax forms based on client and year filters

get

Query Parameters

policyNumberstring

Policy/Contract number related to the tax form. Dependency: Must be used together with ‘planCode’. Either (policyNumber + planCode) OR (fromDate + toDate) OR combination of both(policyNumber + fromDate + toDate) must be provided.

Example:7720001823

planCodestring

Plan Code. Dependency: Must be used together with ‘policyNumber’. Either (policyNumber + planCode) OR (fromDate + toDate) must be provided.

Example:132007A04

taxYearinteger(int32)

Example:2022

numYearsinteger(int32)

Default:1

>= 1<= 5

Example:1

fromDatestring(date-time)

Start date for filtering tax forms. Format: yyyy-MM-dd’T’HH:mm:ss.SSS’Z’, Timezone: UTC. Dependency: Must be used together with ‘toDate’. Either (fromDate + toDate) OR (policyNumber + planCode) OR combination of both(policyNumber + fromDate + toDate) must be provided.

Example:2025-08-13T15:01:17.542Z

toDatestring(date-time)

End date for filtering tax forms. Format: yyyy-MM-dd’T’HH:mm:ss.SSS’Z’, Timezone: UTC. Dependency: Must be used together with ‘fromDate’. Either (fromDate + toDate) OR (policyNumber + planCode) OR combination of both(policyNumber + fromDate + toDate) must be provided.

Example:2025-08-13T15:01:17.542Z

limitinteger(int32)

Default:10

Example:10

offsetinteger(int32)

Default:0

Example:0

Headers

Authorizationstringrequired

Authorization token

Example:Bearer <token>

x-correlation-idstring

UUID for the request

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

Response

application/json

OK

TaxformResponseList

countinteger(int32)

Number of tax forms found

Example:10

itemsarray[object]
Show Child Parameters
correlationIdstring

Unique ID for correlating requests

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

get/document/v3/tax-forms
 
application/json

Downloads a tax form

Retrieves a tax form by its unique ID

get

Path Parameters

idstringrequired

Form identifier for the taxform, either formId or documentId is mandatory

Headers

Authorizationstringrequired

Authorization token

Example:Bearer <token>

x-correlation-idstring

UUID for the request

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

Response

application/json

OK

TaxformDownloadResponse

fileExtensionstring

File extension of the document

Example:pdf

binaryDatastring

Binary data of the document

Example:wdvb2ekllkk189w0enjansle..

correlationIdstring

Unique ID for correlating requests

Example:1760f822-dcbf-49fc-a623-a1998383f4b9

get/document/v3/tax-forms/{id}/download
 
application/json

MetadataByIdResponse

object
metadataobject
Show Child Parameters
correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

Example

MetadataResponse

object
sourcestring

Source system or origin of the document

Example:Email

documentIdstring

Unique ID in EDS db

Example:670e23dfab593b4387210b81

formNumberstring

Form number associated with the document

Example:FORM123

fileTypestring

Type of file, e.g., pdf, doc, etc.

Example:pdf

documentClassificationstring

Classification of the document, e.g., OUTBOUND or INBOUND

Allowed values:OUTBOUNDINBOUND

Example:OUTBOUND

documentTypestring

Type of document indicating its purpose

Example:NB Application

documentCategorystring

Category of the document, such as New Business or Claim

Example:New Business

documentTypeDescriptionstring

Description of the document type

Example:Deferred Annuity Application

documentStatusinteger(int32)

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

Example:1

versionstring

Version of the document

Example:1

documentDatestring(date-time)

Date of the document

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

zinniaLiveCaseIdstring

Zinnia Live Case ID

Example:ZLC09876

planCodestring

Plan code

Example:565

policyNumberstring

Policy number associated with the document

Example:23109168

brokerMasterNumberstring

Broker master number associated with the document

Example:BKR123456

repMasterNumberstring

Representative master number associated with the document

Example:REP987654

agentExternalIDstring

External ID of the agent associated with the document

Example:AGT12345

brokerExternalIDstring

External ID of the broker associated with the document

Example:BRK12345

mailTrackingNumberstring

Mail tracking number

Example:TRK123456

deliveryMethodstring

Delivery method

Example:Email

emailFromstring

Email address

Example:XHbN8@example.com

emailTostring

Email address

Example:XHbN8@example.com

emailSubjectstring

Email subject

Example:Deferred Annuity Application

appIdstring

Application ID

Example:APP123456

mailShipDatestring(date-time)

Mail ship date

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

participantAccountNumberstring

Account number of the participant

Example:123456789

sourceFileNamestring

Name of the file in source system

Example:files/123456.pdf

displayNamestring

Display name of the document

Example:Deferred Annuity Application

distributionChannelstring

Distribution channel through which the document was delivered

Example:Online Portal

periodYearinteger(int32)

Year of the document period

Example:2024

periodQuarterstring

Quarter of the document period in Q1-Q4 format

Example:Q2

documentNumberstring

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

Example:670e23dfab593b4387210b81 or 20241230-M-463066

documentVersionsarray[object]

Previous versions of the document

Show Child Parameters
scenariostring

Scenario

Allowed values:duplicatereplace

Example:duplicate

linkedDocumentIdstring

Linked document ID

Example:693e23dfab593b4387210k92

importDatestring(date-time)

Document creation timestamp(in UTC timezone)

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

Example

DocumentDownloadResponse

object
fileExtensionstring

File extension of the document

Example:pdf

fileNamestring

Name of the document

Example:NB Application

binaryDatastring

Binary data of the document

Example:wdvb2ekllkk189w0enjansle..

correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

Example