Send Opening Package

Commit and send an Opening Package (Initial Disclosures) to a recipient.

Note: The doc set order id and parties returned with the Generate Document Set API are required.

Usage Notes

  • If the response from the Get Opening Order Status for the given Opening Doc Set includes the attribute "difference": "removed" for any of the documents included in the Order Status, the documents denoted as "removed" MUST NOT be included in the Send Opening Package API request. Otherwise, an error will occur in document delivery.
  • When the All Borrowers and NBOs option is selected in the ‘Schedule Fulfillment For’ setting, the request payload for Send Opening Package must include the borrower contact details in both the fulfillments (array of objects) and package object.
  • When the Primary Borrower Only (per pair) option is selected in the ‘Schedule Fulfillment For’ setting, the request payload for Send Opening Package must include the primary borrower contact details in both the fulfillments (array of objects) and package object.
  • If the contact details are not included in both the fulfillments (array of objects) and package object, the recipient will not receive the physical print package. However, if the contact details are included only in the package object and not the fulfillments (array of objects), the recipient will still receive the digital package.
Path Params
string
required

Unique identifier of the document order returned during opening order document operation.

Query Params
string

This unique id will acquire lock on the loan.

Body Params

The following objects and attributes make up the Send Package request contract that is passed when sending Opening or Closing Packages or On-Demand Forms to a recipient. When passing the Send Package request contract, all attributes are optional unless otherwise specified.

documents
object

List of all the document ids that need to be part of the DeliverOpeningPackage. You can get the document ids from the response body of the Get OrderDocumentStatus. Any other documents provided will be excluded from the delivery.

fulfillments
array of objects

Party details. Party details. Fulfillment options are available when the Fulfilment service is enabled.

fulfillments
package
object

Package information and options.

Headers
string
required

Bearer token

Responses

400

Bad Request

404

Not Found

500

Internal Server Error

Language
URL
LoadingLoading…
Response
Choose an example:
application/json