| Name |
Type |
Details |
| browser |
String |
Specific text string assigned by the FHA to identify the organization processing the request. |
| status_flag |
| Input
Values |
| Update |
Modify
data in an existing case. |
| Query |
Retrieve
data in an existing case. |
| Output
Values |
| SuccessUpdatesAllowed |
This
indicates that the insurance application was processed,
that is, the query or logging of the appraisal has been
successful. |
| Unavailable |
System
is down |
| Warning |
This
indicates that an error has occurred during the insurance
application process that did not prevent processing the
case. Please see the ProcessStatusMessage for details. |
| Error |
This indicates that an error has occurred during the insurance application process and that the case has not been processed
successfully. Either there were missing data or the data were in error. Please see the ProcessStatusMessage for details. |
|
| msg_n |
Alphanumeric |
80
character fields reporting status, errors and warnings regarding
the outcome of a request. The first message (sCode = '1') is
always the overall status of the request. |
| addr_stat |
String |
Validate,
Override. Specifies whether address validation should be processed. |
| borr_stat |
String |
Override or Validate; specifies if borrower information is to be validated as accurate or entered without validation. Required for update mode. (Defaults to Validate if not specified.)
|
| flags |
| Borrower/Address
Change returns several ProcessStatusFlag values. These
values are not required for all implementations but may
be helpful to those migrating from FHA Direct to B2B. |
| Name |
Values |
| MODE_FLAG |
Echos
value of input mode C for Query, E for Update |
| ADP_CD_FLAG |
Field
to show if FHAVAADPCode field is in error. If "P" field
is displayed but no changes are permitted; "Y" then field
is in error; "N" says field is valid. |
| PROG_ID_FLAG |
Field
to show if FHAVAProgramCodeIdentifier field is in error.
If "P" field is displayed but no changes are permitted;
"Y" then field is in error; "N" says field is valid. |
| LOAN_PURP_FLAG |
Field
to show if LoanPurposeType field is in error. If "H" field
is Hidden and not collected; "P" field is Displayed but
no changes are permitted; "Y" then the field is in error;
"N" says field is valid. |
| BORR_TP_FLAG |
Field
to show if FHAVABorrowerType field is in error. If "H"
field is Hidden and not collected; "P" field is Displayed
but no changes are permitted; "Y" then the field is in
error; "N" says field is valid. |
| LIV_UNITS_FLAG |
Field
to show if FinancedNumberOfUnits field is in error. If
"P" field is displayed but no changes are permitted; "Y"
then field is in error; "N" says field is valid. |
| FTHB_FLAG |
Field
to show if BorrowerFirstTimeHomebuyerIndicator field is
in error. If "H" then field is hidden from user view;
"P" says field is displayed and protected from user update;
"Y" says field is in error; "N" says field is valid |
| SSN_EXEMPT_FLAG |
Field
to show if FHAVASSNTINExemptionIndicator field is in error.
If "H" then field is hidden from user view; "P" says field
is displayed and protected from user update; "Y" says
field is in error; "N" says field is valid. |
| COUNSEL_FLAG |
Field
to show if CounselingConfirmationType field is in error.
If "H" then field is hidden from user view; "P" says field
is displayed and protected from user update; "Y" says
field is in error; "N" says field is valid. |
| LOT_FLAG |
Field
to show if SubjectPropertyShortLegalDescriptionLot field
is in error. If "H" then field is hidden from user view;
"P" says field is displayed and protected from user update;
"Y" then the field is in error; "N" says field is valid. |
| BLK_PLAT_FLAG |
Field
to show if the concatenation of SubjectPropertyShortLegalDescriptionBlk
and SubjectPropertyShortLegalDescriptionPlt is in error.
If "H" then field is hidden from user view; "P" says field
is displayed and protected from user update; "Y" then
the field is in error; "N" says field is valid. |
| ZIP_FLAG |
Field
to show is PostalCode field is in error. If "P" then the
field is displayed and protected from user update; "Y"
says the field is in error; "N" says field is valid. |
| SPC_IND_FLAG |
Field
to show if FHAVAApprovedCondominiumClassIndicator field
is in error. If "P" then the field is displayed and protected
from user change; if "Y" then the field is in error; "N"
says field is valid. |
| SUBDIV_ID_FLAG |
Field
to show if PROJECTID field is in error. If "P" then the
field is displayed and protected from user change; if
"Y" then the field is in error; "N" says field is valid. |
| PHASE_FLAG |
Field
to show if FHAVAApprovedCondominiumCooperativePhase field
is in error. If "P" then the field is displayed and protected
from user change; if "Y" then the field is in error; "N"
says field is valid. |
| RSI_IND |
Race/Sex
Fields Flag. (RaceNationalOriginType and GenderType) If
"Y", then show Race and Sex fields; otherwise, hide these
fields and do not allow user input. |
| TYPE_OF_CASE |
Type
of Case Flag. If "H", then HECM Case; If "M" then MCC
Case. This field used to hide certain fields from user
view |
|
| loan_purp |
String |
ExistingOccupied,
RefinanceImprovements, Refinance, NewCondominium, ExistingCondominium,
ExistingNeverOccupied, ConstructNewHome, FinanceCoop
Specifics
on what the mortgage loan is for. Existing Occupied: Existing
house previously occupied.
Finance Improvements: Improvements to existing house are being
financed.
Refinance: Prior loan by the same borrower for same property.
New Condominium: Purchase of a condominium unit not previously
occupied.
Existing Condominium: Purchase of a condominium unit previously
occupied.
Existing Never Occupied: Purchase of a house that was never
occupied.
Construct New Home: New housing being built with the proceeds
to be paid out during construction.
Finance co-op: Financing of the purchase of a cooperative
unit (HUD only).
|
| case_no |
Integer |
Unique
10-character identifier assigned to the mortgage loan by the
Federal Housing Administration (FHA). |
| counsel |
String |
NotApplicable,
NoBorrowerCounseling, LenderTrainedCounseling, ThirdPartyCounseling
Indicator
establishing the counseling provided to a first time home
buyer. N/A: Borrower is not a first time home buyer.
Not Counseled: Counseling has not been provided or completed.
Lender: Counseling was provided by the lender.
Third Party: Counseling was provided by an institution or
organization other than the lender.
|
| counsel_tin |
Integer |
TIN of counseling agency |
| adp_cd |
String |
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. |
| 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.
EitherGPMorGEM
|
| 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).
HomeEquityMortgage255Saver
HomeEquityMortgageCondominium255Saver
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.
|
| prin_wd |
String |
Yes, No
Indicator specifying whether there is a principal write down.
|
| ssn_exempt |
String |
Yes,
No. Indicator establishing whether the borrower or coborrower
is not required to obtain a Social Security Number, such as
employees of the World Bank or foreign employees of embassies.
(Not applicable for a government agency or nonprofit organization.) |
| bn_birth_dt |
Date |
Borrower's
birth date yyyymmdd |
| bn_age |
Integer |
(1
- 99) Borrower's age |
| case_tp |
String |
RegularHUD,
IrregularHUD, HUDVA/CRV, DEVA/CRV, RegularDE
FHA
classification of the case, including: Regular HUD: Case is
processed by HUD and, except for a streamline refinance, requires
an appraisal and issuance of a Conditional Commitment or Rejection
Notice.
Irregular HUD: Primarily, a case processed in part by lender
or HUD's Real Estate Owned (REO) Branch. The property has
already been appraised (except for a 203k or REO case). A
Home Equity Conversion Mortgage (HECM) classified as an Irregular
HUD case type is processed entirely by HUD. Used for REO,
military, and HECM properties.
HUD VA/CRV: Case has a Certificate of Reasonable Value and
an appraisal by an FHA-approved appraiser. It has been underwritten
by the Department of Veterans Affairs.
DE VA/CRV: Direct endorsement case processed by the lender
and having a Certificate of Reasonable Value. The Department
of Veterans Affairs has done the appraisal review and mortgage
credit analysis is to be done by lender.
Regular DE: Direct endorsement case primarily processed by
the lender. Lender performs all or part of the property appraisal,
if required, and the borrower evaluation.
|
| borr_type |
String |
Occupant,
Landlord, EscrowCommitment, Corporation/Partnership(Refi), GovernmentAgency/Non-Profit
Classification
of the borrower in relation to the property. Occupant: Resides
on the property.
Landlord: Rents or leases the property.
Escrow Commitment: Builder, rehabilitator, or investor that
is purchasing or refinancing the property as an investment
but intends to sell the rehabilitated property to a borrower
acceptable to HUD (who will occupy the property as a principal
residence).
Corporation/Partnership (Refi): Business entity under which
a mortgage was originally insured and is now being processed
as a refinance.
Government Agency/Non-Profit: State or local government agency
involved in the provision of housing. Nonprofit organization
that will sell or lease the property to a low- or moderate-income
individual.
NOTE: The BorrowerType attribute of the BORROWER element supersedes
the FHAVABorrowerType element value when both are sent in
the same document.
|
| proc_type |
String |
N/A,
HECM, CoinsuranceConversion, MilitarySales, RealEstateOwned,
CoinsuranceEndorsements
Additional classification of an Irregular HUD or Regular DE
case, including: HECM: Home Equity Conversion Mortgage; reverse
mortgage enabling elderly home owners to convert equity in
their homes to monthly income or lines of credit.
Coinsurance Conversion: Case is changing from the Coinsurance
program to regular processing. (This classification is obsolete
and is only used for an existing case.)
Military Sales: Property technically belongs to the Department
of Defense and is being sold with FHA-insured financing.
Real Estate Owned (REO): HUD-owned property as a result of
paying a claim to a lending institution and the lender transferring
ownership of the property to HUD. Typically, an REO property
was formerly owned by the lender because the borrower defaulted
on the mortgage. Either HUD or a direct endorsement underwriter
performs the mortgage credit analysis. Also referred to as
Property Disposition (PD).
Coinsurance Endorsements: HUD and the originator or investment
lender share the loan risk. (This classification is obsolete
and is only used for an existing case.)
|
| prog_id |
Integer |
2
digits. FHA's two-character identifier for the mortgage insurance
program under which the application is being made. |
| appl_method |
String |
FaceToFaceInterview,
Mail, Telephone, Internet. Method by which information was collected. |
| constn_cd |
String |
Proposed,
SubstantiallyRehabilitated, UnderConstruction, Existing
Building
status, including:
Proposed Construction: Site, plans, and materials for the
property were approved by the FHA, Department of Veterans
Affairs, or eligible lender underwriter before construction
began, or the site is covered by an "early start" letter.
Substantial Rehabilitation: Property is being repaired and
insured under Section 203k.
Under Construction: Construction has begun but site, plans,
and materials for the property were not previously approved
by the FHA.
Existing Construction: Construction is 100% complete and building
can be occupied.
|
| borr |
Up
to 5 borrower records, indexed by BORROWERID, may be entered. |
| bn_name |
Alphanumeric |
Up
to 22 characters. (Last, First MI) Last name, first name, and
middle initial of the mortgagor. Source: URLA, section III.
Borrower Information, Borrower's Name. 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 |
Integer |
Social
Security Number (SSN) or Taxpayer Identification Number (TIN)
of the mortgagor/comortgagor. Source: URLA, section III. Borrower
Information, Social Security Number. |
| gmtag |
The
GOVERNMENTMONITORINGID attribute is matched to the BORROWERID
attribute value. |
| race_id |
Up
to five borrower race elements may be entered, each indexed
by the RaceNationalOriginID attribute. |
| marital_stat |
String |
Married,
Unmarried. marital status of primary borrower. |
| dependents |
Integer |
Number
of children and other dependents of primary borrower. |
| bn_ethnicity |
String |
Hispanic,
NonHispanic. HMDA designation. (Omit attribute or send a space
character when not applicable for borrower type.) |
| bn_sex |
String |
Male,
Female |
| bn_furn |
String |
Yes,
No. Indicates if borrower has furnished race, sex, ethnicity |
| bn_racen |
String |
White,
Black, AmericanIndianOrAlaskanNative, NativeHawaiianPacificIslander,
Asian |
| fthb |
String |
Yes,
No. Indicator establishing whether the borrower is purchasing
a home for the first time, has not owned a home in the last
three years, or meets certain other conditions to qualify as
a first time home buyer. |
| proptag |
The
PROPERTY element stores all of the address information for the
property. The PROPERTYID attribute is optional but must be set
to "1" if included. |
| city |
Alphanumeric |
City
in which the property is located. |
| state |
String |
The
state (2 character designation) in which the property is located. |
| zip |
Alphanumeric |
U.S.
Postal Service Zonal Improvement Plan (ZIP) code for the geographic
location of the property. (+4 is accepted but not stored at
this time. |
| county |
Integer |
FIPS
county code. |
| hse_no |
Alphanumeric |
Street
address of property. |
| unit |
Alphanumeric |
Up
to 4 characters. Designation for a specific dwelling located
at the property, such as a condominium apartment number. |
| pre |
String |
Up
to two characters. Street direction preceding the street name.
Example: NW Greenlake Drive. |
| street |
Alphanumeric |
Name
or number of the street on which the property is located. Examples:
Elm or 42. |
| type |
String |
Street
classification such as Blvd, Dr, or Pkwy, etc. |
| post |
String |
Up
to two characters. Street direction following the street name.
Example: Greenlake Drive NW. |
| liv_units |
Integer |
1
to 99. Number of separate dwellings. For example, a two-family
house has 2 living units. |
| lot |
Alphanumeric |
Builder's
lot number. |
| 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. |
| subdiv_ind |
String |
PUD,
Subdivision, Condominium
Planned
unit development (PUD), condominium, or subdivision indicator.
N/A: Not a planned unit development, condominium, or subdivision.
PUD: Planned unit development having a combination of diverse
land uses in one contained development or subdivision; development
requiring home owner's association dues.
Condominium: Property is legally defined as a condominium;
ownership of a unit in multifamily building based on a legal
description of the airspace the unit occupies, plus an undivided
interest in the ownership of the common elements that are
owned jointly with other condominium unit owners.
Subdivision: Tract of land divided into blocks, building lots,
and streets according to a recorded subdivision plat that
complies with local ordinances and regulations. Note: No longer
required to be approved by the FHA.
|
| spc_id |
Alphanumeric |
FHA's
identifier for the planned unit development (PUD) or condominium
project. |
| phase |
Alphanumeric |
Identifier
for the specific phase of the planned unit development (PUD)
or condominium project. |
| spot_lot |
String |
Yes, No, SiteCondoIndicator
for a lot being developed in a previously completed subdivision. |
| subdiv_name |
Alphanumeric |
Name
of the PUD or condominium. Note: This field only appears if
the case has been processed as a PUD or condominium. |
![[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)