[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]  

HUD - FHA Connection HECM Certificate

- -
 Information by State
 Print version
 

HECM Certificate provides an XML based interface to create and modify HECM Certificates and to retrieve a list of HECM Certificates. HECM Certificate also provides a means to retrieve a printable PDF version of the HECM Certificate.

This function is based on the MISMO Smartdocument and uses the eMortgage framework v.1.01 If you plan to validate using the MISMO DTDs you will need to make the following DTD modifications:

  • Add the attribute _NameSuffix to the borrower element as
    _NameSuffix(II|II|IV|2ND|3RD|Jr|Sr)
  • Add COUNSELINGAGENCY as:
    <!ELEMENT COUNSELINGAGENCY EMPTY>
    <!ATTLIST COUNSELINGAGENCY
         _UnparsedName CDATA #IMPLIED
         _CounselingAgencyID CDATA #IMPLIED
         _Street CDATA #IMPLIED
         _City CDATA #IMPLIED
         _State CDATA #IMPLIED
         _PostalCode CDATA #IMPLIED>
  • Add COUNSELINGSESSION as:
    <!ELEMENT COUNSELINGSESSION EMPTY>
    <!ATTLIST COUNSELINGSESSION
         _Date CDATA #IMPLIED
         _Duration CDATA #IMPLIED
         _Method (Telephone|FaceToFace)#IMPLIED
         _FinancedFee DATA #IMPLIED
         _FeeWaived (Yes|No) #IMPLIED>
  • Add CERTIFICATE as:
    <!ELEMENT CERTIFICATE EMPTY>
    <!ATTLIST CERTIFICATE
         _CertificateID CDATA #IMPLIED
         _Issued (Yes|No) #IMPLIED
         _ClientInfluenced (Yes|No) #IMPLIED>


In contrast to other B2G functions, there are two distinct ways to post data to the HECM Certificate function. If you set the content header to "text/xml" or "application/xml" you can send the XML file as the body of the request with no qualifiers. To post information as an HTML form field value as is done with other B2G functions you must set the content header to "application/x-www-form-urlencoded"

To post your data to the pilot system use https://hwvauwd491.hud.gov/b2b/chums/f17bdcxml.cfm
To post your data to the production system use https://entp.hud.gov/b2b/chums/f17bdcxml.cfm

Return to the CHUMS Functions page

History of Changes

Only Add and Update modes are fully supported in the initial deployment. Query and retrieve modes will be available in the near future.
Initial deployment -- October 23, 2009

Key:

Only used on inputElement/attribute is not produced by program output unless it is being returned due to an error condition.
Only used on outputElement/attribute is returned by program but is not required or interpreted when the program is called.
Used on input and outputMay not always have exactly the same meaning on input an output though. Please consult the reference table from the linked data items for details.
DeprecatedObsolete; all deprecated elements are supported but please use indicated element.
nIndicates a numeral, e.g., msg_n may be msg_1, msg_2, msg_3, etc.
Data Types
IntegerIndicates a numeral
AlphanumericMixed Text (alphabetic, numeric and punctuation) Note: Some fields restrict some punctuation.
NumericFormatted number, e.g. 999.99
StringSpecific keywords as indicated
DateA valid date, represented as MMDDYYYY

XML File Layout

Clicking on these links will provide detailed information of the data items.


<?xml version='1.0' encoding='utf-8'?>
<EMORTGAGE_PACKAGE _ID='HUD_Binder'>
<KEY _Name='TransactionMode' _Value ='Description'/>
<KEY _Name='Requestor' _Value ='Description'/>
<KEY _Name='Status' _Value ='Description'/>
<KEY _Name='StatusMessage' _Value ='Description'/>
<KEY _Name='Comments' _Value ='Description'/>
<KEY _Name='StartDate' _Value ='Description'/>
<KEY _Name='EndDate' _Value ='Description'/>
<SMART_DOCUMENT MISMOVersionIdentifier='1.01' PopulatingSystemDocumentIdentifier='FHAVA'>
<HEADER _ID='FHAVA_Header'>
<DOCUMENT_INFORMATION MustBeRecordedIndicator='False' NegotiableInstrumentIndicator='False'
            SMARTDocumentCategoryType='5' _FormNumberIdentifier='OMB-2502-0524' _StateType='Populated'
            _Type='Other' _TypeOtherDescription='HECMCounselingCertificate' />
</HEADER>
<DATA _ID='FHAVA_HECM_COUNSELING_CERTIFICATE'>
 <MAIN>
  <LOAN MISMOVersionIdentifier='2.3'>
   <_APPLICATION>
    <PROPERTY _City='Description' _PostalCode='Description'
    	_State='Description' _StreetAddress='Description' />
    <BORROWER BorrowerID='Description' _FirstName='Description' _LastName='Description'
    	_MiddleName='Description' _NameSuffix='Description'/>
   </_APPLICATION>
   <_CLOSING_DOCUMENTS>
    <EXECUTION _Date='Description' />
    <COUNSELINGAGENCY _UnparsedName='Description' _CounselingAgencyID='Description'
    _City='Description' _State='Description'
    _Street='Description' _PostalCode='Description' />
    <COUNSELINGSESSION _Date='Description' _Duration='Description'
    	_Method='Description' _UpfrontFee='Description'
	_FinancedFee='Description' _FeeWaived='Description' />
     <FULFILLMENT_PARTY _RoleType='Other' _RoleTypeOtherDescription='Counseler' _Name='Description'>
      <CONTACT_DETAIL>
       <CONTACT_POINT _Type='Phone' _Value='Description' />
       <CONTACT_POINT _Type='Name' _Value='Description' />
      </CONTACT_DETAIL>
     </FULFILLMENT_PARTY>
     <CERTIFICATE _CertificateID='Description' _Issued='Description'
     	_ClientInfluenced='Description' />
   </_CLOSING_DOCUMENTS>
  </LOAN>
 </MAIN>
</DATA>
</SMART_DOCUMENT>
</EMORTGAGE_PACKAGE>

Data Description

End of Data Description
Data Type Data Description
String [Add, Update, Query, Retrieve] Add creates a new certificate. Update modifies an existing certificate. Query produces a list of certificate numbers with minimal data and Retrieve returns an encoded PDF copy of an existing certificate.
String You should be assigned a specific string to use in this field when you request an ID for the development system. Please use this string for all transactions in development and in production.
String [Sucess, Error] Status of transaction.
Alphanumeric Description of status. Up to 25 messages may be displayed describing various error conditions for an Error status.
Alphanumeric 500 characters of free form text.
Date Beginning date for certificate searches.
Date Ending date for certificate searches.
Alphanumeric City property is located in. (17 chracters)
Integer Postal code property is located in.
String State property is located in. 2 Character postal abreviation.
Alphanumeric Street Address of property. (22 characters)
Integer [1 - 5] Arbitrary identifier distinguishing borrowers.
Alphanumeric Borrower's first name.
Alphanumeric Borrower's last name.
Alphanumeric Borrower's middle initial.
String [II, II, IV, 2ND, 3RD, Jr, Sr] Borrower's name suffix.
Date Completion date for counseling.
Alphanumeric Name of counseling agency.
Integer ID number for counseling agency.
Date Date conseling initiated.
Integer Number of minutes required to complete counseling.
String [Telephone, FaceToFace] Method of interview.
Numeric [XXX.XX] Upfront fee collected.
Numeric [XXX.XX] Amount of fee that is financed.
String [Yes, No] Indicates if fee was waived.
Alphanumeric Counselor's name.
Alphanumeric Agency street address.
Alphanumeric Agency city.
String Agency state.
Integer Agency phone number
Integer Attention to
Integer Certificate number.
String [Yes, No] Was a certificate issued?
String [Yes, No] Does the counselor feel that undue influence was placed on the client by other parties?

Comments or Questions? <SF Administration>

 

 
Content current as of 8 October 2009   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