API is healthy
Health
Health check operations
Returns a simple health status indicating the API process is running.
Returns a simple health status. No authentication required.
get
Response
200
Response
200
get/market-connect/order-entry/v1/health
Authentication
200
AdditionalDocumentType
object * Additional properties are NOT allowed.
attachmentTypearray[string]
List of attachment type codes
documentTypearray[string]
List of document type codes
formTypearray[string]
List of form type codes
Example
AttachmentData
object * Additional properties are NOT allowed.
additionalDocumentTypesarray[object]
Document types the user may optionally upload.
* Additional properties are NOT allowed.
Show Child Parameters
documentRulesarray[object]
Conditional rules for required or optional documents.
* Additional properties are NOT allowed.
Show Child Parameters
documentsarray[object]
Files already stored for the transaction, including EDS documentId and documentSize in bytes.
Example:{"documentType":"ESIGNATURE","fileName":"NAICBuyerGuideFixedDeferredAnnuitiesMTNM.pdf","uploadDate":"04/06/2026 11:22:05 PM","documentId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","documentSize":9000000,"attachmentType":null,"formType":null}
* Additional properties are NOT allowed.
Show Child Parameters
requiredDocumentsarray[object]
Documents still required before submission.
* Additional properties are NOT allowed.
Show Child Parameters
Example
AttachmentDocument
object * Additional properties are NOT allowed.
attachmentTypestring
Attachment type code when applicable; otherwise null.
documentTypestring
Document type label or code.
fileNamestring
Original file name as uploaded.
formTypestring
Form type code when applicable; otherwise null.
uploadDatestring
Upload timestamp as returned by the attachment service.
documentIdstring
Electronic document service (EDS) identifier for the uploaded file.
documentSizeinteger(int64)
Size of the uploaded file in bytes.
Example