| Adding Support for recording HECM Counseling Certificates April 4 implementation |
Added FHAVAHECMCounselCertificate element
|
| Adding Support for Debt to Income Date, February 13, 2009 implementation |
Added _DebtToIncomeRatioDate attribute to FHAVAHopeForHomeowners element
This represents the date for which the DTI ratio declared in __DebtToIncomeRatio was valid. When
the XML attribute is not sent, this value will default to March 1ts 2008. This default will be removed on April 4, 2009.
|
| Adding Support for revised HECM processing, December 27, 2008 implementation |
Added new values to LoanPurposeType
The current values, Purchase and Refinance, will continue to be supported until April 4, 2009. Sending
Purchase or Refinance will continue to result in a return value of P or R until that time.
As of the deployment date; if the new values are used the return values will be identical to the sent values.
Note: When existing cases are queried the values representing Purchase and Refinance will continue to be
displayed as P and R on the output until April 4, 2009.
As always: No translation of the input is done when there is an error. The values displayed will be the exact values that
were sent.
You will not be able to process HECM Puchase
until you implement the new values for LoanPurposeType.
|
| Revising Support for HOPE for Homeowners, December 1, 2008 implementation |
Added Attributes to FHAVAHopeForHomeowners element
first_pay_dt
old_cltv
Removed Attributes from FHAVAHopeForHomeowners element
_CurrentMortgageProvider
_CurrentMortgageProduct
_TrialMod
_TrialMonths
Added element FHAVAHopeForHomeOwnersHistory
Added Attributes to FHAVAHopeForHomeOwnersHistory element
_Index
_CurrentMortgageProvider
_CurrentMortgageProduct
Up to 8 itterations of this element may be present, indexed sequentialy, as needed to
pass sufficient pairs of _CurrentMortgageProvider and _CurrentMortgageProduct attribute values.
|
| Adding Support for HOPE for Homeowners, October 1, 2008 implementation |
| Added element CaseReceivedDate |
Added element FHAVAHopeForHomeOwners with the following attributes:
_Indicator='hope_loan'
_DebtToIncomeRatio='dti_ratio'
_PayMonths='pay_months'
_CurrentMortgageProvider='omtg_pvdr'
_CurrentMortgageProduct='omtg_pdct'
_TrialMod='trial_mod'
_TrialMonths='trial_months'
|
| Adding new value to FHAVA HousingProgram, "HOPELoans" |
| Adding Support for Appraiser Type, August 25, 2008 implementation |
Added new attribute, Type, to FHAVAAppraiserLicenseIdentifier element
Added new element, LicenseType, to PARTY element
Type of license issued to appraiser. This field is optional unless the appraiser cannot be uniquely identified by
state and license combination. If Type is omitted and the state and license combination is unable to uniquely
identify the appraiser, this transaction will return an error message.
Valid values for the license type fields are Licensed, CertifiedGeneral, CertifiedResidential
|
| Risk Based Pricing, July 12, 2008 implementation |
| Added new element, LoanAmortizationTermMonths |
| Loan Transmittal, June 9, 2008 implementation. Changes will become mandatory on October 1 2008 |
| Added new value, NewConstruction, to BuildingStatusType |
Added new Attribute, RefinanceCashOut, to FHAVA
This element will become a required entry for appropriate cases 90 days after implementation. |
Changes to FHAVA element, addition of 4 attributes related to correct ADP Code choice. Implementation date February 9, 2008
Amortization,
HousingProgram,
SpecialProgram,
BuyDown
|
| Changes to FHAVAPriorFinancingIndicator, September 29. 2007 implementation |
| New value, FHASecure, to support presidential inititive. |
Changes to FHAVAProcessingCode, August 10. 2007 implementation
New Real Estate Owned values |
The current values for the FHAVAProcessingCode element are:
N/A, HECM, CoinsuranceConversion, MilitarySales, RealEstateOwned, and CoinsuranceEndorsements
RealEstateOwned will be retained until November 2nd. After November 2nd RealEstateOwned will no longer be accepted.
RealEstateOwnedWithAppraisal and RealEstateOwnedWithoutAppraisal are being added and should be used as soon as possible after the implementation date.
Prior to November 2nd the value RealEstateOwned will be converted to RealEstateOwnedWithAppraisal if Construction Code is SubstantiallyRehabilitated and to RealEstateOwnedWithoutAppraisal for all other Construction Code values.
|
| Borrower Verification June 18, 2005 implementation |
|---|
All borrowers with SSNs will be validated.
BorrowerBirthDate becomes a mandatory field for borrowers having SSNs.
A new control element (BorrowerValidationIndicator) is provided to override borrower validation when needed.
|
| Added new element BorrowerValidationIndicator. |
| HECM Counseling April 2 implementation |
| Added new Attribute Value, CounselingAgency, to PartyType to report HECM Counseling Agency party detail information. |
| Added new element, FHAVAHECMCounselID. |
| Added new element, FHAVAHECMCounselDate. |
| Added new element, BorrowerBirthDate. (May appear up to 5 times) |
| General Maintenance February 18 implementation |
| Added correct output tag, LoanScheduledClosingDate, to represent Estimated Closing Date. |
| Inspector Roster Changes October 12 Implementation |
| Added new value to InspectionType (Roster) |
| HMDA Changes January 5 Implementation |
| Increased allowable number of borrowers to 5 |
| Dropped support for deprecated attribute, REOStatusType for property disposition (use PriorPropertyDisposition attribute) |
| Dropped support for deprecated tag, FullUnparsedName (use UnparsedName) |
Standardized refinance contact name and number
- Added FHAVASRFIContactName (input/output)
- Dropped ContactName (old input)
- Dropped FHAVAContactName (old output)
- Added FHAVASRFIContactPhone (input/output)
- Dropped CONTACTDETAIL (old input)
- Dropped FHAVAContactPhone (old output)
|
| Dropped support for living_units (use FinancedNumberOfUnits) |
| Added Address1 to Originator (Party) section. |
| Name |
Type |
Details |
|
| browser |
String |
String
assigned by FHA to the Lender/LOS. Required |
| status_flag |
String |
In
input mode, specifies mode of operation. Valid values are Add,
Query, or Update. In output mode, specifies result of operation.
Valid values are SuccessUpdatesAllowed, Warning, or Error |
| sCode |
Integer |
sCode
attributes are used to index multiple elements |
| msg_n |
Alphanumeric |
Up
to 78 characters detailing various status, error, or warning
messages. Up to 25 messages may be displayed for each transaction.
The message corresponding to sCode = '1' describes the overall
status of the transaction. |
| notesn |
Alphanumeric |
Up
to 75 characters each of case notes. Used to record information
about the case. Not stored with the case; only used during the
process of issuing the case number. |
| addr_stat |
String |
Override or Validate; specifies if address is to be validated as accurate or entered without validation. Required for all modes. (Defaults to Validate if not specified.)
|
| borr_stat |
String |
Override or Validate; specifies if borrower information is to be validated as accurate or entered without validation. Required for all modes. (Defaults to Validate if not specified.)
|
| prind |
String |
Values:
Purchase (Returned as P XML output)
Refinance (Returned as an R in XML output)
ForwardPurchase (new value for "purchase)
ForwardRefinance (new value for "refinance")
HECMTraditional (use when "purchase" would have been entered for HECM cases)
HECMPurchase (See Mortgagee Letter 08-33)
HECMRefinance (use when "purchase" would have been entered for HECM cases)
Required for Add and Update modes
|
| casetype |
String |
RegularHUD,
IrregularHUD, HUDVA/CRV, DEVA/CRV, or RegularDE. Required for
Add and Update modes |
| caseno |
Integer |
FHA
Case number. Required for Add and Update modes. |
| caseref |
Alphanumeric |
Up
to ten characters. Intended for lender case identification. |
| rec_date |
Date |
Date case number was requested from the FHA |
| clsg_dt |
Date |
Projected
Closing date of new case. Enter for FHA Refinances only |
| adpcode |
Integer |
3
numeric characters representing the specific code for the case
type and SOA.
Automated data processing code related to the section of the
National Housing Act under which mortgage insurance is being
requested. Sources: Form HUD-92900-A, line 4 and form HUD-92900-PUR
or form HUD-92900-WS, Section of the Housing Act. |
| priorfha |
String |
Yes, Y, No, N, FHASecure (Output is Y, N or FHASecure) Indicates if property was previously
financed by the FHA. Enter for FHA Refinances only |
| cash_out |
Bolean |
(Yes, No) Indicates if refinance will have a cash out component Enter for FHA Refinances only |
| srrefi |
String |
Yes,
No. Yes if this is a streamlined refinance requiring a new appraisal.
No if this is a streamlined refinance not requiring a new appraisal.
Enter for FHA Refinances only |
| prevcase |
Integer |
10
numeric characters. Indicates FHA case number of previous financing.
Enter for FHA Refinances only |
| adp_chara |
String |
Fixed: Amount of the payment and the interest rate remain fixed for the life of the loan.
AdjustableRateMortgage: Interest rate changes over the life of the loan relative to changes in the index rate. Also called Adjustable Mortgage Loan (AML) or Variable Rate Mortgage (VRM).
GraduatedPaymentMortgage: Payments are low for the first few years, gradually increase for a few years, and then remain fixed.
GrowingEquityMortgage: Scheduled increases in payments, with the additional amount being used to reduce the principal.
|
| adp_charh |
String |
Type of Federal Housing Administration (FHA) Single Family Housing program, including:
FHAStandardMortgageProgram203b: Basic FHA mortgage insurance for one- to four-family housing.
Condominium234c: FHA mortgage insurance for a unit in a condominium building (which must contain at least four dwelling units).
Improvements203k: FHA mortgage insurance for a loan that covers both the acquisition and rehabilitation of a home.
ImprovementsCondominium203k: FHA mortgage insurance for a loan that covers both the acquisition and rehabilitation of a home.
HomeEquityMortgage255: FHA insurance on a reverse mortgage for a home (Home Equity Conversion Mortgage or HECM).
HomeEquityMortgageCondominium255: FHA insurance on a reverse mortgage for a home (Home Equity Conversion Mortgage or HECM).
HOPELoans: HOPE for Homeowners (257): FHA mortgage insurance for a distressed loan being refinanced under the HOPE for Homeowners program.
Urban Renewal220: FHA mortgage insurance for new or rehabilitated housing located in a designated urban renewal area or area with concentrated programs of code enforcement and neighborhood development.
Other: Less common FHA Single Family Housing program (e.g., 235(r) Homeownership Assistance/Refinance or 240 Fee Title Purchases).
|
| adp_chars |
String |
Type of Federal Housing Administration (FHA) Single Family Housing special program, including:
NoSpecialProgram: A special housing program is not applicable.
IndianLands: FHA mortgage insurance for property located on Native American trust land or otherwise restricted land (property eligible for insurance pursuant to Section 248 of the National Housing Act).
HawaiianHomelands: FHA mortgage insurance for property located within Hawaiian homelands (property eligible for insurance pursuant to Section 247 of the National Housing Act).
MilitaryImpactArea: FHA mortgage insurance for property located in a military impacted area designated by the Secretary of Defense (property eligible for insurance pursuant to Section 238(c) of the National Housing Act).
223eLocationWaiver: FHA mortgage insurance for property in an older, declining urban area where there is a need for affordable housing (property eligible for insurance pursuant to Section 223(e) of the National Housing Act).
|
| adp_charb |
String |
Yes, No
Indicator specifying whether there is an interest buydown sales incentive to reduce the amount of the borrower's payments during the early years of the loan.
|
| hope_loan |
Boolean |
Yes, No: Indicator specifying whether the new case qualifies under the HOPE for Homeowners program. |
| dti_ratio |
Numeric |
99.99: Percentage of the borrower's monthly gross income (as of March 1, 2008) that is used to pay debts. |
| dti_dt |
Date |
99.99: Date at which the borrowers ercentage of the monthly gross income (as of March 1, 2008) used to pay debts was calculated. |
| pay_months |
Numeric |
999: Number of monthly payments the borrower made on the old loan. |
| omtg_pvdr |
String |
FHA, VA, RuralDevelopment, Private, Prime, SubPrime, AltA, Other: Type of mortgage provider for the old loan. |
| omtg_pdct |
String |
Fixed, InterestOnly, OptionARM, 2/28ARM, 3/27ARM, Other: Type of loan product for the old loan. |
| first_pay_dt |
Date |
YYYYMMDD, Date of first payment for old loan |
| old_cltv |
Numeric |
Combined loan-to-value (CLTV) of all liens |
| trial_mod |
Boolean |
Yes, No: Indicator specifying whether there was a trial modification of the new loan. |
| trial_months |
Numeric |
999: Number of months there was a trial modification of the new loan. |
| aprsr_choice |
String |
Manual,
LenderSelect, NotApplicable Indicates method of appraiser selection. |
| financing |
String |
N/A,
Private, GNMA, FNMA Only collected for Case type 2 with processing
type RealEstateOwned and CoinsuranceEndorsements |
| focode |
String |
HUD
Field Office designator. May be entered as text or numeric from
this table.
Required for add and Update modes. Returned as numeric code
in XML output. |
| aprsr_dt |
Date |
Date
appraiser assigned to case. |
| aprsr_id |
Alphanumeric |
Up to 22 characters. State license of appraiser |
| insp_id |
Alphanumeric |
Up to 4 characters. Assigned ID for the compliance inspector. |
| insp_name |
Alphanumeric |
Up to 22 characters Name of compliance inspector |
| aprsr_name |
Alphanumeric |
Up to 22 characters Name of appraiser |
| appr_type |
String |
The type of appraiser. Valid values are Licensed, CertifiedGeneral, CertifiedResidential |
| insp_type |
String |
Mortgagee, LenderSelect or Roster. Indicates selection type for compliance inspector. |
| orig |
Numeric |
10 digits. Designates originator's FHA ID. (Note: leading zeros must be entered when they exist in these ids) Required for Add and Update modes |
| orig_name |
Alphanumeric |
Up to 30 characters Name of originator |
| orig_addrs |
Alphanumeric |
Unparsed address combining city name, state and ZIP code |
| orig_city |
Alphanumeric |
Up to 17 characters City of originator |
| orig_state |
Alphanumeric |
2 characters Postal code for originator's state |
| orig_zip |
Integer |
9 digits. ZIP code of originator. |
| pgmid |
Integer |
FHA's
two-character identifier for the mortgage insurance program
under which the application is being made. |
| procsng |
String |
N/A,
HECM, CoinsuranceConversion, MilitarySales, RealEstateOwned, RealEstateOwnedWithAppraisal, RealEstateOwnedWithoutAppraisal and
CoinsuranceEndorsements. Required for Add and Update modes. |
| consultant_id |
Alphanumeric |
5
characters ID of 203k consultant |
| consult_name |
Alphanumeric |
Up
to 22 characters. Name of 203k consultant |
| sponsor |
Numeric |
10
characters Sponsor's FHA ID (note: leading zeros must be sent
where they exist in these IDs) |
| spnsr_name |
Alphanumeric |
Up
to 30 characters Name of sponsor |
| spnsr_addrs |
Alphanumeric |
Unparsed
address combining city name, state and ZIP code |
| spnsr_city |
Alphanumeric |
Up
to 17 characters. City name for sponsor |
| spnsr_state |
Alphanumeric |
2
characters. Sponsor's state postal code. |
| spnsr_zip |
Integer |
9
digits. Sponsor's ZIP code |
| va_exp_dt |
Date |
Date
VA authorization expires. |
| va_no |
Alphanumeric |
9
characters. VA CRV Certificate Number |
| counsel_tin |
Integer |
9 characters. TIN of HECM Counseling agency |
| hecm_cert |
Alphanumeric |
9 characters. Certificate number issued HECM Counseling agency when counseling has been completed. |
| counsel_date |
Date |
Date HECM counseling performed |
| counsel_name |
String |
Name of HECM Counseling Agency |
| nt_auth |
Alphanumeric |
13
characters. Refinance authorization number. Generated for successful
refinance requests. Only generated in Add mode. |
| nt_o_name |
Alphanumeric |
22
characters. Borrower name for case being refinanced |
| nt_o_addrs |
Alphanumeric |
52
characters. Address recorded in previous case |
| nt_exp_dt |
Date |
Date
that refinance authorization expires. |
| nt_unmip1 |
Numeric |
Unearned
MIP 1. Format 99999.99 |
| nt_unmip2 |
Numeric |
Unearned
MIP 2. Format 99999.99 |
| nt_mip1 |
Numeric |
Earned
MIP 1. Format 99999.99 |
| nt_mip2 |
Numeric |
Earned
MIP 2. Format 99999.99 |
| nt_factor1 |
Numeric |
MIP
Factor 1. Format .99999 |
| nt_factor2 |
Numeric |
MIP
Factor 2. Format .99999 |
| nt_o_mtg |
Numeric |
Mortgage
Amount for case being refinanced - 9999999 |
| nt_o_mip |
Numeric |
Premium
Amount for case being refinanced - 99999.99 |
| nt_o_term |
Integer |
Loan
term for case being refinanced - 3 digits |
| nt_o_pval |
Numeric |
Old
Property Value – 9999999 |
| nt_clsg1 |
Date |
Closing
date one |
| nt_clsg2 |
Date |
Closing
date two |
| nt_term1 |
Integer |
3
digits. Loan period one |
| nt_term2 |
Integer |
3
digits. Loan period two |
| ct_name |
Alphanumeric |
Up
to 22 characters. Contact name |
| ct_phone |
Integer |
10
digits Area coded and local number. Returned formatted as (999)9999999 |
| priorpd |
String |
Prior
property disposition. (Was this case previously sold as Real
Estate Owned (previously sold by HUD)?) 'Y' or 'N' |
| city |
Alphanumeric |
Up
to 17 characters. City name where property is located. Required
for Update mode. |
| state |
Alphanumeric |
2
characters. State where property is located. Required for Add
mode if PostalCode is not sent. Required for Update mode. |
| county |
Integer |
3
digits (will become 5 digits in future) FIPS county code from
the Census Bureau |
| zip_cd |
Integer |
5/9
digits (+4 portion of ZIP code is accepted but not processed)
ZIP code for property. Required for Add mode if State and HouseNumber
are not sent. Required for Update mode. |
| suffix |
Alphanumeric |
Up
to 6 characters. Apartment and/or house extension designation. |
| pre |
Alphanumeric |
Up
to 2 characters. Pre-directional modifier for street name, e.g
N Street. |
| hse_no |
Alphanumeric |
Up
to 7 characters. House numbers(s) Required for Add and Update
modes unless block/plat are sent. |
| street |
Alphanumeric |
Up
to 20 characters. Street name. |
| post |
Alphanumeric |
Up
to 2 characters. Post-directional modifier for street name,
e.g Street N. |
| type |
String |
Street
type, e.g., St, Ave, Cir, etc. |
| moyr_comp |
Date |
Month and year property was completed. Day portion of address is required for formatting but is not processed or stored. |
| age_comp |
Numeric |
Age, in whole years, of property (NNN) |
| liv_units |
Integer |
Up
to 2 digits. Number of units financed. |
| const_code |
String |
Construction
code. Proposed, SubstantiallyRehabilitated, UnderConstruction, NewConstruction, Existing |
| blk_plat |
Alphanumeric |
5
Characters (2 for block, 3 for plat) Data elements are concatenated
into single blk_plat data item. Builder's block/plat number.
When blk/plat can not be successfully parsed into 2/3 character
strings all data is returned in the SubjectPropertyShortLegalDescriptionBlk
element. |
| lot |
Alphanumeric |
Up
to 4 characters. Builder's lot number |
| Borrower
Data |
Up
to five borrowers may be present. The borrowers are identified
by the BORROWERID attribute of the element BORROWER |
| borrn_birth_dt |
Date |
Birth date of borrower
|
| bn_name |
Alphanumeric |
Borrower names can entered as <UnparsedName> in the format, LAST, FIRST MI or in the parsed format of <FirstName> <MiddleName> <LastName> Names of greater than 22 characters will be truncated.
|
| bn_ssn |
Numeric |
Data
may be the SSN or TIN. SSNs are represented as <SSN> while
TINs are represented as <UnitedStatesTaxpayerIdentificationNumber> |
| CAIVRS
Data |
Each
of the possible five borrowers can have up to three possible
CAIVRS reports. |
| can_auth |
Alphanumeric |
Up
to 10 characters. CAIVRS authorization number. |
| can_name_n |
Alphanumeric |
Up
to 25 characters. Name of agency reporting a default. |
| can_case_n |
Alphanumeric |
10
characters. Case number of defaulted loan. |
| can_type_n |
Alphanumeric |
Up
to 12 characters. Type of credit problem. |
| can_phone_n |
Integer |
Phone
number of agency contact |
| spc_id |
Alphanumeric |
Up
to 9 characters. ID of Subdivision/PUD/ Condominium Project |
| spc_name |
Alphanumeric |
Up
to 30 characters. Name of Subdivision/PUD/ Condominium Project |
| spc_ind |
String |
Specifies
class of project; Condominium, PUD, Subdivision |
| spc_phase |
Alphanumeric |
Up
to 3 characters. Project phase |
| spot_lot |
String |
Yes
or No. (Y or N in XML output) Is this property a "spot lot"
within a subdivision, but not part of the subdivision? |
| loan_term |
Interger |
Term of loan in whole months. |
![[Logo: Homes and Communities: U.S. Department of Housing and Urban Development]](/images/common/hgv-bnr-logo2.gif){kind=logo}
![[Vea la versión en español de esta página]](/images/common/hgv-bnr-espanol2.gif)
![[Contact Us]](/images/common/hgv-bnr-contactus.gif)
![[Display the text version of this page]](/images/common/hgv-bnr-text.gif)
![[Search/Index]](/images/common/hgv-bnr-search.gif)
![[The U.S. government's official web portal]](/images/common/hgv-tpc-usagov.gif){kind=small}
![[logo: Fair Housing and Equal Opportunity]](/images/common/hgv-icn-fheo.gif){kind=small}
![[Logo: HUD seal]](/images/common/hgv-icn-seal.gif)