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
Headers
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
Annuity Health Check
EAPP API Health Check and Annuity (Annuity app validation, app processing, payment processing, TOA, eApp, and suitability) services Health check
Application Validation Health Check
Returns the health status of the application validation service
get
Response
application/json
Response
application/json
Application is healthy
statusstring
Allowed values:UPDOWN
Example:UP
get/appvalidation/actuator/health
Authentication
application/json
Application Processing Health Check
Returns the health status of the application processing service
get
Response
application/json
Response
application/json
Application is healthy
statusstring
Allowed values:UPDOWN
Example:UP
get/appprocessing/actuator/health
Authentication
application/json
Payment Processing Health Check
Returns the health status of the payment processing service
get
Response
application/json
Response
application/json
Application is healthy
statusstring
Allowed values:UPDOWN
Example:UP
get/paymentprocessing/actuator/health
Authentication
application/json