Higher Priced Mortgage Loans (HPML) - Response
Please see the Legend to understand the conventions used to document each element and attribute. Note that for responses, the XML elements are documented in the order that they appear in the response.
| Element | Attributes |
|---|---|
<outHPML> | |
<Description> | |
<XMLDetail>[] | |
<IsHpml> | 🔸Apor, 🔸Spread, 🔸Difference, 🔸Date |
🟥 <outHPML>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the HPML query input message, and is required. This element simply acts as a container for all of the result child elements.
Attributes: None
🟥 <Description>
| Element Type | Data Type | Values |
|---|---|---|
| Data | Text | - |
If the calculation was completed successfully, then this element will contain the value 'Valid Calculation'. Otherwise, this element will contain a description of the problem encountered during the attempted computation.
Attributes: None
🟦 <XMLDetail>[]
| Element Type | Data Type | Default |
|---|---|---|
| Data | Text | n/a |
The XMLDetail elements are messages passed back to the calling application which
detail the status of the XML request. If the SCEX issues any warnings regarding
unrecognized elements or attributes, then each warning message will be displayed
in an <XMLDetail> element.
In our sample output above, no warnings are returned by the SCEX, and hence
there are no <XMLDetail> elements returned.
Attributes: None
🟥 <IsHpml>
| Element Type | Data Type | Values |
|---|---|---|
| Data | Boolean | true, false |
The value of this element will either be true or false, and will indicate whether or not the submitted loan is a HPML. The following attributes of this element provide a bit more detailed information, which may be of interest to the calling application:
Attributes:
🔸Apor,🔸Spread,🔸Difference,🔸Date
🔸 Apor
| Data Type | Values |
|---|---|
| Decimal | No Restriction |
The value of this attribute contains the Average Prime Offer Rate for the submitted loan. This value is retrieved from the appropriate APOR file (fixed or adjustable).
🔸 Spread
| Data Type | Values |
|---|---|
| Decimal | No Restriction |
The spread value depends upon the type of lien. First-lien loans have a spread of 1.5, and subordinate-lien loans have a spread of 3.5.
🔸 Difference
| Data Type | Values |
|---|---|
| Decimal | No Restriction |
The value of this attribute returns the difference between the submitted Regulation Z APR, and the APOR plus the spread. If the difference is greater than or equal to zero (which means that the Reg. Z APR is greater than or equal to the APOR plus spread), then the loan is a HPML.
🔸 Date
| Data Type | Values |
|---|---|
| Date | >= 1900-01-01 |
The Date attribute contains the date on which the APOR data was effective. As an example, if the lock in date was 2009-12-22, then the date returned should be 2009-12-21 (if the APOR rates files are up to date).