TaxFormsResponse
objectContract number for the document/tax-form
Example:1234567898
Name of the tax-form
Example:1099-R
Unique string character associated with the tax-form name
Example:R
Form id for the tax-form
Example:123456
Tax year for the tax-form
Example:2023
TaxFormsResponse200
objectShow Child Parameters
Metadata
objectZinnia Live Case ID. Either of policy number, Application Id or ZL case Id is required.
Example:ZLC09876
Application ID. Either of policy number, Application Id or ZL case Id is required.
Example:EDJ041120240000000001
Document classification to identify document type
Allowed values:OUTBOUNDINBOUND
Example:OUTBOUND
Source of the document
Example:Email
Document category
Allowed values:NEW_BUSINESSPOST_ISSUEDEATHCORRESPONDENCEAGENTSUITABILITY
Example:NEW_BUSINESS
File type
Example:PDF
Allowed values:NB_STATE_REPLACEMENTNB_CONVERSIONNB_APPLICATIONCOST_DISCLOSURENON_CONTRACTUALAGENT_REPORTACCELERATED_BENEFIT_RIDERSURRENDER_COMPARISIONCONSENT_PAPERLESSTERMS_OF_USETERMS_CONDITIONSCHARITY_ELECTION_FORMSAUTHORIZATION_FORMSHIPPAHIV_CONSENT_FORM_ALL_STATEAMENDMENTDISCLOSURESNB_STATE_REPLACEMENT_NOTICETRUSTEE_STATEMENTNOTICE_AND_CONSENTPRIVACY_POLICYGLBA_PRIVACY_NOTICEFCRAMIB_PRE_NOTICEID_VERIFICATION_NOTICEHIPAABUYER_GUIDEILLUSTRATIONSUITABILITYAPPLICATIONSIGNED_APPLICATIONREPLACEMENTS_ACKNOWLEDGEMENT1035_EXCHANGE_SURRENDEREVIDENCE_DOCUMENTELECTRONIC_FUNDS_TRANSFERSUPPLEMENTAL_APPLICATIONCONFORMING_ILLUSTRATIONSIGNED_ILLUSTRATIONOVERFLOW_ADDITIONAL_INFORMATIONREINSTATEMENT_APPLICATION
Date of the document
Description of the document type. Refer the mapping sheet shared along with specification
Example:Address Change Letter
Plan code
Example:235
Policy number. Either of policy number, Application Id or ZL case Id is required.
Example:23576001
Total page count
Example:5
Specifies who can access the document based on their role.
Allowed values:CLIENT_COPYAGENT_COPY
Example:CLIENT_COPY
Source file name
Example:052725FTADHOCLETTERS_R_20485_1207637_711.pdf
DocumentUploadResponse
objectUnique ID
Example:670e23dfab593b4387210b81
Unique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Response message
Example:Document uploaded successfully
Status code of the response
Example:200
DocumentUploadBadRequest
objectUnique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Error message
Example:Invalid request payload
Status code of the response
Example:400