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_STATEMENTTERMS_OF_USENOTICE_AND_CONSENTPRIVACY_POLICYGLBA_PRIVACY_NOTICEFCRAMIB_PRE_NOTICEID_VERIFICATION_NOTICEHIPAAACCELERATED_BENEFIT_RIDERBUYER_GUIDEILLUSTRATIONSUITABILITYAPPLICATIONSIGNED_APPLICATIONREPLACEMENTS_ACKNOWLEDGEMENT1035_EXCHANGE_SURRENDEREVIDENCE_DOCUMENTAMENDMENTELECTRONIC_FUNDS_TRANSFERSUPPLEMENTAL_APPLICATIONCONFORMING_ILLUSTRATIONSIGNED_ILLUSTRATIONOVERFLOW_ADDITIONAL_INFORMATION
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
DocumentUploadForbidden
objectUnique ID for correlating requests
Example:123e4567-e89b-12d3-a456-426614174000
Error message
Example:Forbidden
Status code of the response
Example:403
ServiceRequestFormMetaData
objectPublicly accessible URL
Example:https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
Id to the specific form instance
Example:1234567
Name or title of the form
Example:Annuity Surrender Form
The code of the parent carrier
Example:EVGL
The type of file
Example:PDF
Type of the form
Example:Redemption
Further classification of the form type
Example:Full Surrender
Category that describes the purpose of the form
Example:Financial
Barcode data used for identifying or scanning the form
Example:13qwf312wfw312fqe2jtyktym
State where the form is applicable or valid
Example:NY