Authorizationstringrequired
This will be passed as Bearer plus “token” as generated by above token API.
Example:Bearer eykjsfjfjasdasdad
Submit Annuity Documents to Zinnia
post
Headers
Body
application/json
Body
application/json
Details required to submit the eApp to Zinnia for Annuity
DocumentInformation
appIdstringrequired
Unique Identifier against an e-App application. First 4 letters represent the receiving company, next 3 letters represent the firm, next 8 positions represent the date eApp is submitted, next 10 positions represents the sequential number of the eApps from the eApp instance. For Orion - Accept integers upto 15 digits
Example:XXXXEDJ041120240000000001
versionstringrequired
Version for that case - 3 digits, incremental if same case if submitted more than once in case of errors. For Orion - Accept integers upto 15 digits
Example:000
effectiveDatestring(date)required
e-App submitted date to Zinnia (with pattern “yyyy-mm-dd”).
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2023-12-19
totalDocumentCountnumberrequired
Example:1
documentDetailsarray[object]required
Show Child Parameters
Response
application/json
Response
application/json
Accepted
SuccessResponse
statusCodeinteger(int32)
Example:201
timestampstring(date-time)
messagestring
Example:Request Submitted Successfully
post/eApp/v2/applications/documents
Authentication
Body
{
"appId": "XXXXEDJ041120240000000001",
"version": "000",
"effectiveDate": "2023-12-19",
"totalDocumentCount": 1,
"documentDetails": [
{
"documentId": "0ca10708-4b53-464c-b745-355c8f6f0edb",
"binaryData": "SGVsbG8gV29ybGQ=",
"formId": "FR2279",
"formName": "Fixed Annuity Order Entry Cover Sheet",
"documentCategory": "NB Supporting Document",
"documentFileType": "pdf"
}
]
}
application/json
SuccessResponse
objectstatusCodeinteger(int32)
Example:201
timestampstring(date-time)
messagestring
Example:Request Submitted Successfully
Example
ValidationResponse
objectstatusCodeinteger(int32)
Example:400
timestampstring(date-time)
errorIdstring
Example:a4a57ed0-2c1b-4922-9959-3b85dd8a96d3
messagestring
Example:JSON Valdiation fails with error
errorarray[string]
Example:Mandatory attribute label missing
Example
ResourceNotFoundResponse
objectstatusCodeinteger(int32)
Example:404
timestampstring(date-time)
errorIdstring
Example:a4a57ed0-2c1b-4922-9959-3b85dd8a96d3
messagestring
Example:Resource not found
errorarray[string]
Example:Resource not found for provided input
Example
AccessDeniedResponse
objectstatusCodeinteger(int32)
Example:403
timestampinteger(int64)
Example:1681395423438
errorIdstring
Example:0286d47a-7ad9-499c-8ca0-8f6634d236a3
messagestring
Example:User is not authorized for the carrier : ABC
Example