Compliance Report Request Contract and Attributes
The following objects and attributes make up the Compliance Report Request contract. When passing the complianceReport request contract, all attributes are required unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| entity object | Required. References the entity ID and entity type. Both entity ID and entity type are returned by the Get Loan API. |
| entity.entityType string | Required. The type of entity expressed in URN format. For example: urn:elli:encompass:loan |
| entity.entityId string | Required. The entity identifier. For example, the loan ID: {loanId}. |
| 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. If your company uses the Correspondent Compliance Review Data (CCRD), then channelName is correspondent. 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. |
Compliance Report Response Contract and Attributes
The following objects and attributes make up the Compliance Report Response contract.
Learn more about compliance reviews
See the Encompass Compliance Service Online Help for detailed information about compliance reviews.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| entity object | References the Ice Mortgage Technology loan identifier. Includes the entity Type and entity ID. Both entity Type and entity ID are returned by the Get Loan API. |
| entity.entityType string | The type of entity expressed in URN format. For example: urn:elli:encompass:loan |
| entity.entityId string | The entity identifier. For example, the loan ID: {loanId}. |
| reportStatus string | The Encompass Compliance Service status. Indicates whether the loan passed or did not pass the loan check. There are 4 possible values: Pass - The loan passed the loan check. Alert - The loan has alerts. Warning - The loan has warnings. Did Not Pass - The loan failed the loan check. |
| ecsReportStatus string | The Encompass Compliance Service status. Indicates whether the loan passed or did not pass the loan check. Possible values are: Pass - The loan passed the loan check. Did Not Pass - The loan failed the loan check. |
| orderedDateTime string | Date the report was ordered. The format is, {year}:{month}:{day}. For example, 2022-06-30. |
| orderedBy string | The Encompass user who initiated the compliance review request. |
| isCanOrderReport boolean | ECS setting that indicates whether a specific user can manually order a report for a loan. When true, the user can order a report for a loan. TIP: This setting is configured in the Compliance Review Setup tool (Order Report checkbox under the Users tab). |
| isCanClearAlert boolean | ECS setting that indicates whether a specific user can clear the “Compliance Review - Did Not Pass” alert under the Alerts & Messages tab in Encompass. TIP: This setting is configured the Compliance Review Setup tool (Clear Alert checkbox under the Users tab). |
| isAuditHaveFatalError boolean | Indicates one or more fatal errors were found during the audit check. |
| serviceItems object | Object containing a general description of the review that was performed and the result of each review. |
| serviceItems.messageId string | Unique identifier of the service item’s message (referred to as rule header ID). |
| serviceItems.serviceGroup string | Type of review. The type of reviews performed depends on the Compliance Review Setup configured in Encompass. Some examples of reviews that may be included in a report are: TILA / TILA-RESPA TILA Right of Rescission HOEPA Higher Priced Mortgage GSE Consumer Credit Home Mortgage Disclosure Act (HMDA) Rate Spread FHA Citi Mortgage Rules VA LO Compensation NMLS Registration Ability to Repay / Qualified Mortgage (ATR/QM) Flood Zone Enterprise Licensing |
| serviceItems.subId string | The rule level categorization of service items in broad categories based on similar rule types. |
| serviceItems.status string | The Status of the Service Group. The possible results, listed in order of severity, are: ERROR - This status is delivered when the Encompass Compliance Service encounters a processing exception caused by a system failure or when key elements or data are missing from the loan. When a processing exception occurs, the tool is unable to render a compliance decision. FAIL - This status is delivered when the Encompass Compliance Service determines the loan contains a compliance exception, thus failing the compliance review. ALERT - This status is delivered when the Encompass Compliance Service examines the loan data and based on its findings, classifies the loan as a "special" loan type. Examples of "special" loans are sub-prime, non-prime, nontraditional, or rate spread home loans. This status simply notifies you that the loan is considered "special" but is not indicative of any compliance issue. WARNING - This status is delivered when the Encompass Compliance Service identifies potential issues within the loan that you should investigate to determine whether a compliance exception exists. For example, a second lien loan amount of $300,000 will generate a Warning status for the HMDA review. This status is also delivered when the Encompass Compliance Service identifies potential issues within the loan that you should investigate to determine whether a compliance exception exists. For example, certain states require that impound amounts paid by the borrower be placed in interest bearing accounts. The Encompass Compliance Service will return a Warning because it is unable to determine if such funds have been placed in an interest-bearing account. PASS - This status is delivered when the Encompass Compliance Service does not identify any exceptions with the loan data. INFO - This status is delivered when the Encompass Compliance Service identifies and element of a loan file that is deemed necessary to bring attention to but meant for informational purposes only. An INFO status will remain on the Mavent report and will not restrict a user from proceeding with processing their loan. |
| serviceItems.message string | A message explaining why the issue was returned. For example, "The System uses the Current Rate Set Date (if provided)." |
| serviceItems.fieldIds string | If the issue was caused by data entered into a specific field in Encompass, the Field ID provided listed here. This corresponds to the Field column in the Compliance Service Report Results window in the Encompass Smart Client. |
| auditItems object | Details about any audit items found and references the category, description and fields returned by the Get Loan API. |
| auditItems.category string | Object containing the initial data Audit ensures there is enough information to run the Compliance Report. |
| auditItems.description string | The overall description of the initial Audit which ensures there is enough information to run the Compliance Report. |
| auditItems.fieldId string | Encompass field ID(s) associated with the AuditItem. |
| baseReviewers object | Object containing data about the base review. |
| baseReviewers.name string | The description of the Reviewer used in the summary review table. |
| baseReviewers.applicable boolean | Indicates whether or not the Base Review was applicable to the given transaction. |
| baseReviewers.included boolean | Indicates whether or not a given Base Review was included in a given transaction. |
| baseReviewers.status string | The Mavent Status of the Base Reviewer, which includes: PASS FAIL WARNING INFO ALERT ERROR NOT PROCESSED NOT REQUESTED |
| feeItems object | Details about the fees processed during the loan check. |
| feeItems.hudid string | The HUD ID used on the RESPA HUD1 or HUD1A form for each fee. |
| feeItems.encompassFeeDesc string | The description used in the Encompass Fee Name column of the Itemization Fee Management setup. |
| feeItems.complianceFeeDesc string | The name of the Compliance Fees name mapped to the Mapped Compliance Fee column of the Itemization Fee Management setup. |
| feeItems.amount number($double) | The amount of the fee. |
| feeItems.paidBy string | Description of who is paying the fee. For example, originator. |
| feeItems.paidToCode string | The code indicating the entity who received payment for a fee. Possible values are B, L, S, I, A and O. |
| feeItems.encompassAprColumn boolean | Indicates whether Encompass included the fee for APR purposes. |
| feeItems.maventAprColumn boolean | Indicates whether Mavent included the fee for APR purposes. This value is not editable by the user and is based on APR fees as defined by the CFPB. |
| feeItems.highCostHoepaQmColumn boolean | Indicates whether the fee was included in the HOEPA QM test. |
| reportFileInfo object | Compliance report file details. |
| reportFileInfo.url string | The description of the Report File information. For example, <https://streaming.us-west-2.skydrive.rd.elliemae.io/v1/clients/301000/6509> |
| reportFileInfo.authorizationHeader string | The authorization header for the Report File Information object. For example, elli-signature 9A72825E19562D0A6E9D54A523 |
© ICE Mortgage Technology, Inc. All rights reserved.