Create Compliance Report

post

https://api.elliemae.com/ecs/v1/complianceReports

Run a compliance report for a specified loan.

Body Params

The payload used to indicate the parameters used in the Compliance Report.

entity

object

required

reportType

string

required

Indicates the type of Compliance Report requested.
Possible values are:

Review - This is a review to make sure no significant changes to the loan data have been made since the last disclosure. With this value, the last disclosed information will be compared to what is currently in the system. A FAIL on an Order typically indicates that something has changed since the last disclosure and has yet to be disclosed to the borrower or could have been changed inadvertently.
Preview - This report request is used when you have knowingly updated the system when creating a disclosure (i.e. updating figures for closing, revising figures due to a borrower request for loan amount change, etc.) and you are preparing disclosure documents. This selection tells Mavent that you want to “preview” the figures you have just entered as if you have already disclosed them so you can ensure your disclosures pass compliance and have not created any additional compliance issues.

reportMode

string

required

This indicates the mode for the requested Compliance Report. For tracking purposes, only. reportMode is Manual.

skipAudit

boolean

Indicates whether to skip over the audit (If the Audit type is a WARNING). Possible values are:

False - Before generating a report request, ECS will perform an audit. The resulting audit may return Warnings or Fatal Errors. If the resulting audit has a Fatal Error, the report cannot be ordered. Warnings can be skipped. Add description for Fatal Error (eg missing required field) and possible actions,
True - Before generating a report request, ECS will NOT perform an audit. ECS will order the report regardless of any fatal errors and warnings that may exist.

channelName

string

required

Describes the Channel for the requested Compliance Report. In most cases, channelName is retail.

NOTE: This attribute is not associated with the Channel field in the Encompass loan file.

reviewSource

string

required

Indicates the review source for the requested Compliance Report. reviewSource is retail.

Headers

Authorization

string

required

The authorization necessary for the parameters used in the Compliance Report.

Responses

200Compliance order completed successfully.