Search
K
Documents

OdataError

object
codestringrequired
messageobjectrequired
Show Child Parameters
innererrorobjectrequired
Show Child Parameters
Example

InlineResponse4001

object
odataErrorobjectrequired
Show Child Parameters
Example

TaxFormsResponse

object
contractNumberstringrequired

Contract number for the document/tax-form

Example:1234567898

namestringrequired

Name of the tax-form

Example:1099-R

fCharstringrequired

Unique string character associated with the tax-form name

Example:R

formIdstringrequired

Form id for the tax-form

Example:123456

taxYearstringrequired

Tax year for the tax-form

Example:2023

Example

TaxFormsResponse200

object
countnumberrequired
itemsarray[object]required
Show Child Parameters
Example

Metadata

object
zinniaLiveCaseIdstring

Zinnia Live Case ID. Either of policy number, Application Id or ZL case Id is required.

Example:ZLC09876

appIdstring

Application ID. Either of policy number, Application Id or ZL case Id is required.

Example:EDJ041120240000000001

docClassificationstringrequired

Document classification to identify document type

Allowed values:OUTBOUNDINBOUND

Example:OUTBOUND

sourcestring

Source of the document

Example:Email

docCategorystringrequired

Document category

Allowed values:NEW_BUSINESSPOST_ISSUEDEATHCORRESPONDENCEAGENTSUITABILITY

Example:NEW_BUSINESS

fileTypestringrequired

File type

Example:PDF

documentTypestringrequired

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

documentDatestring(date-time)

Date of the document

documentTypeDescriptionstringrequired

Description of the document type. Refer the mapping sheet shared along with specification

Example:Address Change Letter

planCodestring

Plan code

Example:235

policyNumberstring

Policy number. Either of policy number, Application Id or ZL case Id is required.

Example:23576001

pageCountinteger(int64)

Total page count

Example:5

docAccessLevelstring

Specifies who can access the document based on their role.

Allowed values:CLIENT_COPYAGENT_COPY

Example:CLIENT_COPY

sourceFileNamestring

Source file name

Example:052725FTADHOCLETTERS_R_20485_1207637_711.pdf

Example