Generate-Result method

Overview

This method can be used to request the results about a previously submitted Generate request. This method can be used to request the generated documents for the whole transaction, or for a specific delivery group based on request parameters.

  • Delivery Group: a GroupID can be passed in the request, which is used to sort a group of documents for delivery. When retrieving the documents, the GetGenerateResult method will return the Delivery Mode, Delivery Group (container with the GroupID, recipient information, such as mailing address and mailing method), and documents.
    Note: emailAddress will be returned in the response when the package is being delivered electronically. Mailing address information will be returned for packages being delivered via paper.

    For example:

    • Delivery container
    • Inside the Delivery, the following elements are present:
      • deliveryMode: ElectronicOnlyWithESign
      • deliveryGroups:
        • emailAddresses
        • discretePartyId
        • groupID
        • documents (docID and instanceDisplayName)
    "delivery": {
                "deliveryMode": "ElectronicOnly",
                "deliveryGroups": [
                    {
                        "emailAddresses": [
                            "dca1@EMAIL.COM"
                        ],
                        "discretePartyId": "B1_DC_ID",
                        "groupId": "ff4db6f7-cce4-405f-92c0-595005c59db9",
                        "documents": [
                            {
                                "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                                "instanceDisplayName": "Notice of Homeownership Counseling - B1_FName B1_MName B1_LName"
                            },
                            {
                                "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                                "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                            }
                        ]
                    },
                    {
                        "emailAddresses": [
                            "DCA2@email.com"
                        ],
                        "discretePartyId": "646",
                        "groupId": "63969ec2-40e7-48f6-9875-640c00b3fcfd",
                        "documents": [
                            {
                                "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                                "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                            },
                            {
                                "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                                "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                            }
                        ]
                    }
                ]
            }

Related topics