[Logo: Homes and Communities: U.S. Department of Housing and Urban Development]
[Vea la versión en español de esta página] [Contact Us] [Display the text version of this page] [Search/Index]
 

Housing
About Housing
Contact us
Keywords
- Single Family
- - Audience groups
- - Buying a home
- - Events & training
- - FHA insured loans
- - Common questions
- - Housing counseling
- - HUD homes/ REO
- - Owning a home
- - Reference guide
ORAMH
Hospitals
Multifamily
OAHP
Reading room
Online forums
Work online

HUD news

Homes

Resources

Communities

Working with HUD

Tools
Webcasts
Mailing lists
RSS Feeds
Help

[The U.S. government's official web portal]  

Holds Tracking
- -
 Information by State
 Print version
 

In the following circumstances, a Case Number Assignment request may be placed on hold for further processing by HUD's Homeownership Center (HOC):

  • Duplicate property address
  • HOC review of the lender
  • For a refinance case, access to refinance authorization information may be unavailable
When submitting a request for Case Number Assignment you may be notified that the case is being held by the HOC. If this occurs, wait approximately 24 hours for processing by the HOC. Then, use Holds Tracking to determine the status of the case. The case can have a holding status of Processing or Completed.
  • Processing: The HOC is still reviewing the case.
  • Completed: HOC review is completed. The case has either been approved or rejected. If the case is approved, a case number is assigned. If the case is rejected, errors may be corrected and a new request for a Case Number Assignment submitted.
Cases with a holding status of Completed are removed from the Holds Tracking List as follows.
  • Three working days after retrieving details on a held case.
  • Within five working days if details on a held case are not retrieved.

History of Changes

Borrower Validation June 18, 2005 implementation
Added input (filter) value, "FailedBorrowerValidation" to element <ProcessStatusCode>
Added output values 32 (Pending Borrower Validation), 33 (Passed SSA Validation), and 72 (Failed SSA Validation) to FHAVAStatusCode attribute of element <FHAVACaseMessage>
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)
January 5 (HMDA Changes) 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)
Standarized refi contact name and number
  1. Added FHAVASRFIContactName (output)
  2. Dropped ContactName
  3. Added FHAVASRFIContactPhone (output)
  4. Dropped CONTACTDETAIL
Dropped support for PriorLoanClosedBefore19990701
Dropped support for living_units (use FinancedNumberOfUnits)
Corrected Misspelled Attribute
  1. Dropped attribute ADPCode
  2. Added attribute FHAVAADPCode
Moved InspectionType to proper tree location under VALUATIONS (was in FHAVA)
To test your application against pilot data, post your XML input file to:
https://hwvauwd491.hud.gov/b2b/chums/f17rqcxml.cfm

To run your application against live data, post your XML input file to:
https://entp.hud.gov/b2b/chums/f17rqcxml.cfm

For more information please contact sfadmin@hud.gov. Please specify that this is a "B2B" question.

XML File Layout

Key:

Only used on input Element/attribute is not produced by program output unless it is being returned due to an error condition.
Only used on output Element/attribute is returned by program but is not required or interpreted when the program is called.
Used on input and output May not always have exactly the same meaning on input an output though. Please consult the reference table from the linked data items for details.
Deprecated Obsolete; all deprecated elements are supported but please use indicated element.
n Indicates a numeral, e.g., msg_n may be msg_1, msg_2, msg_3, etc.
Data Types
Integer Indicates a numeral
Alphanumeric Mixed Text (alphabetic, numeric and punctuation) Note: Some fields restrict some punctuation.
Numeric Formatted number, e.g. 999.99
String Specific keywords as indicated
Date A valid date, represented as YYYYMMDD

Linked data names in the XML layout are the FHA Direct/CHUMS data names. Clicking on these links will provide detailed information of the data items. (Links are shown as brown text to avoid obscuring underscores in data names.)

 

This is an input file to search Holds Tracking.

<?xml version='1.0' ?>
<MORTGAGEDATA MISMOSVersionID='1.0.1'>
 <PROCESSSTATUS>
  <ProcessStatusCode>mode</ProcessStatusCode>
  <ProcessStatusRequestor>browser</ProcessStatusRequestor>
 </PROCESSSTATUS>
 <Application>
  <UNDERWRITINGCASE>
   <FHAVA>
    <ClasRAKeyValue>ClasRAKey</ClasRaKeyValue>
    <FHAVAOriginatorIdentifier>origid</FHAVAOriginatorIdentifier>
   </FHAVA>
  </UNDERWRITINGCASE>
 </Application>
 <PROPERTY>
  <PARSEDSTREETNAME>
   <StreetName>street</StreetName>
  </PARSEDSTREETNAME>
 </PROPERTY>
 <BORROWER>
  <LastName>name</LastName>
 </BORROWER>
</MORTGAGEDATA>

This is an output file from a search of the Holds Tracking data.

When a valid ClasRaKeyValue is sent all of the details for a particular case will be returned. When this key is not sent multiple CASEDATA sections (where CASEID is the ClasRaKeyValue) will be returned with summary data only. In the layout below these summary fields are bolded. 
<?xml version="1.0" standalone="yes" ?> 
<MULTICASEDATA MISMOVersionID="1.0.1">
 <PROCESSSTATUS>
  <ProcessStatusCode>status_flag</ProcessStatusCode> 
  <ProcessStatusMessage sCode="0">status_msg</ProcessStatusMessage> 
  <ProcessStatusMessage sCode="1">Returned xx record(s)</ProcessStatusMessage> 
  <ProcessStatusMessage sCode="n">msg_n</ProcessStatusMessage>
  <ProcessStatusMessage sCode="n" ProcessStatusMessageType = 'notesn'>notesn</ProcessStatusMessage>
 </PROCESSSTATUS>
 <CASEDATA CASEID = 'ClasRaKey'>
  <FHAVACaseMessage
	FHAVAStatusCode = 'status_code'
	FHAVAStatusDate = 'status_date'>
	chums_msg
  </FHAVACaseMessage> 
  <PROPERTY PROPERTYID = 'n' PriorPropertyDisposition = 'priorpd'>
   <Address1>addString</Address1> 
   <CountyName>county</CountyName> 
   <PostalCode>zip</PostalCode>
   <State>state</State> 
   <City>city</City>
   <PARSEDSTREETNAME PARSEDSTREETNAMEID="1">
    <DirectionPrefix>pre</DirectionPrefix>
    <HouseNumber>hse_no</HouseNumber>
    <StreetName>street</StreetName>
    <StreetSuffix>type</StreetSuffix> 
    <DirectionSuffix>post</DirectionSuffix> 
   </PARSEDSTREETNAME>
  </PROPERTY>
  <SubjectProperty>
   <StructureBuiltYear>moyr_comp</StructureBuiltYear>
   <FinancedNumberOfUnits>liv_units</FinancedNumberOfUnits>
   <SubjectPropertyShortLegalDescriptionBlk>blk_plat</SubjectPropertyShortLegalDescriptionBlk>
   <SubjectPropertyShortLegalDescriptionPlt>blk_plat</SubjectPropertyShortLegalDescriptionPlt>
   <SubjectPropertyShortLegalDescriptionLot>lot</SubjectPropertyShortLegalDescriptionLot>
  </SubjectProperty>
   <UNDERWRITINGCASE>
    <FHAVA 
	FHAVAPreviousCaseNumber = 'prev_case'
	FHAVAADPCode = 'adp_code'
	FHAVAStreamlinedRefinanceIndicator = 'sr_refi'>
    <FHAVAFieldOfficeCode>ClasRaKey (first 4 characters)</FHAVAFieldOfficeCode> 
    <AgencyCaseIdentifier>case_no</AgencyCaseIdentifier>
    <LenderCaseIdentifier>case_ref</LenderCaseIdentifier>
    <ClosingPackageReceivedDate>close_dt</ClosingPackageReceivedDate> 
    <FHAVAAppraiserIdentifier>aprsr_id</FHAVAAppraiserIdentifier>
    <FHAVAAppraiserSelectionIndicator>aprsr_type</FHAVAAppraiserSelectionIndicator> 
    <CaseTypeCD>case_type</CaseTypeCD>
    <FHAVAProgramCodeIdentifier>pgm_id</FHAVAProgramCodeIdentifier>
    <FHAVASponsorIdentifier>sponsor</FHAVASponsorIdentifier>
    <FHAVAOriginatorIdentifier>originator</FHAVAOriginatorIdentifier> 
    <FHAVAProcessingCode>procsng</FHAVAProcessingCode>
    <FHAVAFinancingCode>financing</FHAVAFinancingCode>
    <FHAVA203KConsultantIdentifier>consult_id</FHAVA203KConsultantIdentifier>
    <FHAVAGHECM>
    <FHAVAHECMCounselID>counsel_tin</FHAVAHECMCounselID>
    <FHAVAHECMCounselDate>counsel_date</FHAVAHECMCounselDate>
    </FHAVAGHECM>
     <FHAVAStreamlinedReFinance FHAVAStreamlinedReFinanceAuthorizationNumber = 'nt_auth'>
      <FHAVASRFIName>nt_o_name</FHAVASRFIName>
      <FHAVASRFIAddr>nt_o_addrs</FHAVASRFIAddr>
      <FHAVASRFIExpirationDate>nt_exp_dt</FHAVASRFIExpirationDate>
      <FHAVASRFIUnearnedMIP1>nt_unmip1</FHAVASRFIUnearnedMIP1>
      <FHAVASRFIUnearnedMIP2>nt_unmip2</FHAVASRFIUnearnedMIP2>
      <FHAVASRFIEarnedMIP1>nt_mip1</FHAVASRFIEarnedMIP1>
      <FHAVASRFIEarnedMIP2>nt_mip2</FHAVASRFIEarnedMIP2>
      <FHAVASRFIUnearnedMIPFactor1>nt_factor1</FHAVASRFIUnearnedMIPFactor1>
      <FHAVASRFIUnearnedMIPFactor2>nt_factor2</FHAVASRFIUnearnedMIPFactor2>
      <FHAVASRFIMortagee>nt_o_mtg</FHAVASRFIMortagee>
      <FHAVASRFIPremium>nt_o_mip</FHAVASRFIPremium>
      <FHAVASRFITerm>nt_o_term</FHAVASRFITerm>
      <FHAVASRFIOriginalPropertyValue>nt_o_pval</FHAVASRFIOriginalPropertyValue>
      <FHAVASRFIClosing1>nt_clsg1</FHAVASRFIClosing1>
      <FHAVASRFIClosing2>nt_clsg2</FHAVASRFIClosing2>
      <FHAVASRFILoanTerm1>nt_term1</FHAVASRFILoanTerm1>
      <FHAVASRFILoanTerm2>nt_term2</FHAVASRFILoanTerm2>
      <FHAVASRFIContactName>ct_name</FHAVASRFIContactName>
      <FHAVASRFIContactPhone>ct_phone</FHAVASRFIContactPhone>
      </FHAVAStreamlinedReFinance>
    </FHAVA>
   </UNDERWRITINGCASE>
  <APPLICATION LoanPurposeType = 'loan_purpose' />
  <BORROWER BORROWERID='n'>
    <UnparsedName>bn_name</UnparsedName>
    <BorrowerBirthDate>borrn_birth_dt</BorrowerBirthDate>
    <LastName>bn_name<LastName>
    <SSN>bn_ssn</SSN>
    <UnitedStatesTaxPayerIdentificationNumber>bn_ssn</UnitedStatesTaxPayerIdentificationNumber>
    <CAIVRSAuthorizationCode>can_auth</CAIVRSAuthorizationCode>
    <CAIVRSAgencyNegativeReports CAIVRSAgencyNegativeReportsID="n">
      <AgencyName>can_name_n</AgencyName>
      <CaseNumber>can_case_n</CaseNumber>
      <CaseType>can_type_n</CaseType>
      <PhoneReferral>can_phone_n</PhoneReferral>
    </CAIVRSAgencyNegativeReports>
  </BORROWER>
  <PARTY PartyType = 'Lender' PARTYID = 'originator'>
   <PartyName>orig_name</PartyName>
   <Address1>orig_addrs</Address1>
  </PARTY>
  <PARTY PartyType = 'Lender' PARTYID = 'sponsor'>
   <PartyName>spnsr_name</PartyName>
   <Address1>spnsr_addrs</Address1>
  </PARTY>
  <PARTY PartyType = 'Appraiser' PARTYID = 'aprsr_id'>
   <PartyName>arpsr_name</PartyName>
  </PARTY>
  <PARTY PartyType = 'Inspector' PARTYID = 'insp_id'>
   <PartyName>insp_name</PartyName>
  </PARTY>
  <PARTY PartyType = 'Consultant' PARTYID = 'consult_id'>
   <PartyName>consult_name</PartyName>
  </PARTY>
  <PROJECT
  PROJECTID = 'spc_id'
	FHAVAApprovedCondominiumClassIndicator = 'spc_ind'
	FHAVAApprovedCondominiumCooperativePhase = 'spc_phase'
	FHAVAApprovedCondominiumCooperativeSpotLot = 'spot_lot'>
   <ProjectName>spc_name</ProjectName>
  </PROJECT>
  <VALUATIONS BuildingStatusType="constn_code" > 
  <InspectionType>insp_type</InspectionType>
  </VALUATIONS>
  </CASEDATA>
</MULTICASEDATA>
Name Type Details
browser String (Required for all transactions) String assigned by FHA to the Lender/LOS. Required
street Alphanumeric Up to 20 characters. Street name of property.
name Alphanumeric (Required Entry If Querying Case By Name) Up to 22 alphabetic characters Last name of borrower.
ClasRaKey Numeric 9 digits. Reference number to extract a single case. (found as CASEID from general search listing.)
origid Numeric 10 digits (leading zero preserved) Lender ID to retrieve all relevant cases as specified by the ProcessStatusCode value
mode String ALL, Completed, CaseNumberAssigned, AwaitingHOCProcessing, FailedBorrowerValidation or empty


Name Type Details
status_flag
SuccessNoUpdatesAllowed This indicates that the Holds Tracking function successfully return case information. No updates are allowed because this function only queries the case data. It does not update the FHA database.
Unavailable System is down
Error This indicates that the Holds Tracking function was not able to return case information. Either the case number did not exist or it couldn't find cases based on name, address, or SSN/TIN entered. Please see the ProcessStatusMessage for details
status_msg Alphanumeric Message detailing status. Up to 80 alphanumeric Characters (First of up to 27 sCode values, representing unique messages, are possible.)
count Alphanumeric Message specifying number of records returned. (Not stored in case data.)
n Integer sCode attributes are used to index multiple elements
msg_n Alphanumeric Message detailing errors. Up to 80 alphanumeric Characters (up to 27 sCode values, representing unique messages, are possible.)
notesn Alphanumeric Notes on case. Up to 80 characters. (Up to two notes may be present.) The attribute identifies the fields numerically (notes1, notes2) while the text node contains the note text itself.
ClasRaKey Numeric Reference number used to identify a unique case record.
status_code Numeric 30, 32, 33, 34, 65 (Processing), 70, 72, 73, 74, 75 (Completed.) Holding status of the case.
Processing: HUD's Homeownership Center (HOC) is still reviewing the case. Completed: HOC has completed review of the case.
status_date Date Date the status of the request last changed.
chums_msg Alphanumeric Up to 80 characters. Specifies reason case is on hold.
priorpd String Prior property disposition. (Was this case previously sold as Real Estate Owned (previously sold by HUD)?) 'Y' or 'N'
addString Alphanumeric Concatenation of hse_no, street, zip
city Alphanumeric Up to 17 characters. City name where property is located.
state Alphanumeric 2 characters. State where property is located.
county Integer 3 digits (will become 5 digits in future) FIPS county code from the Census Bureau
zip Integer 5/9 digits (+4 portion of ZIP code is accepted but not processed) ZIP code for property.
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)
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.
liv_units Integer Up to 2 digits. Number of units financed.
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
loan_purpose String Purchase or Refinance (Returned as P or R in XML output)
prev_case Integer 10 numeric characters. Indicates FHA case number of previous financing. Entered for FHA Refinances only
adp_code 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.
sr_refi 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. Entered for FHA Refinances only
ClasRaKey (first 4 characters) String HUD Field Office designator. May be entered as text or numeric from this table.
case_no Integer 10 digits. FHA Case number.
case_ref Alphanumeric Up to ten characters. Intended for lender case identification.
close_dt Date Projected Closing date of new case. Entered for FHA Refinances only
aprsr_id Alphanumeric Up to 22 characters. State license of appraiser
aprsr_type String Mortgagee, 3
LenderSelect, 5
Roster, 7
Manual, 4
Indicates method of appraiser selection.
case_type String RegularHUD, IrregularHUD, HUDVA/CRV, DEVA/CRV, or RegularDE.
pgm_id Integer FHA's two-character identifier for the mortgage insurance program under which the application is being made.
sponsor Numeric 10 characters Sponsor's FHA ID (note: leading zeros must be sent where they exist in these IDs)
originator Numeric 10 digits. Designates originator's FHA ID. (Note: leading zeros must be entered when they exist in these ids)
procsng String N/A, HECM, CoinsuranceConversion, MilitarySales, RealEstateOwned, CoinsuranceEndorsements.
financing String N/A, Private, GNMA, FNMA Only collected for Case type 2 with processing type RealEstateOwned and CoinsuranceEndorsements
consult_id Alphanumeric 5 characters ID of 203k consultant
nt_auth Alphanumeric 13 characters. Refinance authorization number. Generated for successful refinance requests.
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
Borrower Data Up to five borrowers may be present. The borrowers are identified by the BORROWERID attribute of the element 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
orig_name Alphanumeric Up to 30 characters Name of originator
orig_addrs Alphanumeric Unparsed address combining city name, state and ZIP code
spnsr_name Alphanumeric Up to 30 characters Name of sponsor
spnsr_addrs Alphanumeric Unparsed address combining city name, state and ZIP code
aprsr_name Alphanumeric Up to 22 characters Name 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
consult_name Alphanumeric Up to 22 characters Name of 203K Consultant
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. Is property a "spot lot" within a subdivision, but not part of the subdivision?
constn_code String Construction code. Proposed, SubstantiallyRehabilitated, UnderConstruction, Existing
insp_type String Mortgagee or LenderSelect. Indicates selection type for compliance inspector.



Comments or Questions? <SF Administration>

 
 
Content current as of 27 July 2006   Follow this link to go  Back to top   
----------
FOIA Privacy Web Policies and Important Links  Home [logo: Fair Housing and Equal Opportunity]
[Logo: HUD seal] U.S. Department of Housing and Urban Development
451 7th Street S.W., Washington, DC 20410
Telephone: (202) 708-1112   TTY: (202) 708-1455
Find the address of a HUD office near you