Returns dataset contents based on the provided transaction, step, field, and dependency inputs.
Unique identifier of the transaction (positive integer as a string).
>= 1 characters
Name of the wizard step containing the dependent control.
>= 1 characters
Identifier of the field (control) whose dataset is being requested.
>= 1 characters
Returns the dataset payload
Outcome of the dataset lookup. “Success” on success; otherwise the backend exception type name (e.g. “NullReferenceException”, “ItemNotFoundException`2”).
>= 1 characters
Human-readable message describing the outcome. On success a confirmation string; on failure the backend error message.
>= 1 characters
Dataset payload serialized as a JSON string. On success, a JSON array of {Name, Value} option objects. On failure, may be “[]” or omitted.
Identifier of the dataset instance returned by the upstream service. Present for success and most failures; absent for low-level exceptions.
Attachment management operations (get, save and delete transaction attachments)
Returns documents, required documents, additional document types and document rules for the specified transaction.
Unique identifier assigned when the Order Entry transaction is created. Resolves to the internal transaction; caller must be authorized for this transaction.
Example:1125715
Returns the attachment payload
Unique identifier for the Order Entry transaction.
>= 1 characters
Case identifier associated with the transaction.
Documents already uploaded, required documents, optional types, and document rules.
Example:{"additionalDocumentTypes":[{"attachmentType":["ID"],"documentType":["DRIVER LICENSE – PROOF OF AGE"],"formType":[]}],"documentRules":[{"conditions":"Owner age < 65","key":"PROOF_OF_AGE","message":"Proof of age documentation may be required.","value":"optional"}],"documents":[{"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},{"documentType":"DRIVER LICENSE – PROOF OF AGE","fileName":"NAICBuyerGuideFixedDeferredAnnuitiesMTNM1.pdf","uploadDate":"04/06/2026 11:26:07 PM","documentId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","documentSize":10000000,"attachmentType":null,"formType":null}],"requiredDocuments":[{"attachmentType":"APP","displayName":"Signed application","documentType":"APPLICATION","formType":"APP_FULL","message":"Upload the fully signed application prior to submission."}]}{"additionalDocumentTypes":[{"attachmentType":["ID"],"documentType":["DRIVER LICENSE – PROOF OF AGE"],"formType":[]}],"documentRules":[{"conditions":"Owner age < 65","key":"PROOF_OF_AGE","message":"Proof of age documentation may be required.","value":"optional"}],"documents":[{"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},{"documentType":"DRIVER LICENSE – PROOF OF AGE","fileName":"NAICBuyerGuideFixedDeferredAnnuitiesMTNM1.pdf","uploadDate":"04/06/2026 11:26:07 PM","documentId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","documentSize":10000000,"attachmentType":null,"formType":null}],"requiredDocuments":[{"attachmentType":"APP","displayName":"Signed application","documentType":"APPLICATION","formType":"APP_FULL","message":"Upload the fully signed application prior to submission."}]}
Comment management operations (save, list, and delete transaction comments)
Saves a comment for the specified transaction and returns the upstream envelope including validation messages.
The comment payload to save.
Indicator identifying whether the comment applies to the application or sub-application
Source system or user group that authored the comment
Free-form comment text
>= 1 characters
Status code of the transaction at the step the comment was added
Display name for the status at the step the comment was added
Title of the wizard step the comment was added on
Unique identifier of the transaction the comment belongs to (positive integer encoded as a string)
Match pattern:^[1-9][0-9]*$
>= 1 characters
Returns the save comment envelope
Case identifier associated with the transaction. Populated on successful saves.
Indicates whether the operation was successful
Human-readable message describing the result
Status code of the operation (e.g., “Success”, “ValidationError”, “Failure”)