Create Loan Audit for Opening Order

Creates the initial audit job for an opening order, which is typical for initial disclosures. This will run asynchronously until it has completed. A Loan Audit ID is returned in the response and a webhook notification will be generated when complete.

Optional - Mavent Audit is included, if Encompass admin has enabled the eDisclosure Packages setting "Include Compliance Report with Data audit".

Usage Notes

This API returns the following use case-specific error messages for the company-conditional package Control Option:

  • Use Case #1: No Packages Selected in Settings - If Admin settings are incomplete, meaning that no packages have been selected, the following error message will return: "There are no disclosure packages available to send to this borrower pair at this time."
  • Use Case #2: All Packages Were Previously Sent - If conditions were met for all packages and have already been sent, the following error message will return: “Borrower pair has already received all available disclosures.”
    NOTE: Although the packageTypes attribute is not applicable to company-conditional package types, you can include the package type in the request payload to override the conditional logic, if needed.
  • Use Case #3: No Package Type Conditions Have Been Met - If no conditions have been met for any packages, meaning no packages are in the payload, the following error message will return: "There are no disclosure packages available to send to the borrower at this time."

📘

If conditions are met for packages that have not yet been sent, those packages will be delivered without an error response.

Body Params

The following objects and attributes make up the auditOpeningInput request contract for opening disclosures. When passing the auditOpeningInput request contract, all attributes are optional unless otherwise specified.

entity
object
scope
object
string

Permitted Signature type (currently supported value: 'WetSignOnly') for opening documents in the send disclosures flow.

boolean

This is an optional indicator which controls whether a compliance audit get performed on the loan. This is applicable only in case of Opening flow.

If this attribute is passed in the request payload this will override LOS encompass settings provided under eDisclosures packages → Included Compliance report with audit.

packageTypes
array of strings

Required for User Selected package types. Values can be passed depending on Encompass Settings > Doc Set Up > eDisclosure packages and Control Option. Possible values:

  • AtApp – At Application
  • 3Day – Three-day
  • AtLock – RateLock
  • Approval – Approval
  • GFE – Include GFE
  • TIL – Include TIL
  • LE – Include LE
    Note: This attribute is used only for user-selected package types. Not needed for company-selected package types. If packageTypes is passed for the "Company selects a different package based on condition” control option, the conditional logic will be overwritten and only the package types specified in the request will be included.
packageTypes
Headers
string
required

Bearer token

Responses

401

Unauthorized

404

Not Found

500

Internal Server Error

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