FHA Connection Business to Government (FHA B2G) Interface

The FHA Connection Business to Government (FHAC B2G) is a way for a Loan Origination System to send information to the FHA Connection in an automated fashion. For a detailed explanation of FHAC B2G functions, please see the FHAC B2G Welcome Package.

Specifications may change with short notice. To stay informed about specification changes please make sure we have your email. Please check our registry to make sure we have your contact information. You may add or update your information as required.

Access to FHAC B2G systems requires authentication. To gain access to the test environment to build and test your client applications for origination functions you will need to provide a valid FHA Lender ID to sfadmin@hud.gov.

Any institution requesting access to the servicing B2G test environment must first have an existing production FHAC connection ID.

When designing your client applications you will need to be aware of the following regulations:

As stated in Mortgagee Letters 97-14 and 93-13, each FHA Connection user must obtain their own user ID. User IDs are NOT to be shared. Passwords should never be shared, displayed online or divulged publicly. They should not be given to third parties in telephone conversations, placed on office message boards, or left written on telephone message notes on unattended workstations. Using an FHA Connection user ID assigned to another person falls under the provisions of Title 18, United States Code, section 1030. This law specifies penalties for exceeding authorized access, alteration, damage or destruction of information residing on federal computers.

Your client applications will need to be able to collect individual user access credentials to be used when authenticating each connection to B2G functions. All IDs must actually belong to individuals; there are no IDs assigned to services. At no time should any user be able to access a transaction using an ID that does not belong to them.

When you are preparing your software for deployment against the production environment you will need a valid FHA Connection ID for the production server. If you do not already have a production ID you will need to contact your Application Coordinator (or the Application Coordinator of one of your clients if you do not directly represent an FHA lender) as we cannot authorize access to the production environment through this office.

Your B2G client application will need to post XML documents as the value portion of a name/value pair in the body of the request. The name portion of the name/value pair may not be "request," "xml," "post," "datain" or any other common name typically associated with HTTP handshaking but it is not otherwise restricted.

The connection uses BASIC authentication over a 128 bit HTTPS transport. You will need to set the content header to application/x-www-form-urlencoded to ensure that the application server parses your request properly. The result of your request is returned as an XML document. At this level; your client application is acting exactly like a web browser posting an HTML form to a server.

The download contains some sample code that illustrates posting data to B2G functions:

  • Java client class
  • Java simple application class
  • Java client source
  • Java simple application example source

The samples are examples to facilitate your own client application development only; no explicit or implied support in the use or modification for use of these examples is offered.

If you are not familiar with the FHA Insurance business processes we strongly suggest that you partner with an FHA lender for assistance because the assistance we can offer here is primarily technical and will be limited in detail and scope when discussing FHA Insurance business rules.

Contacts:

For technical questions and problems: fhab2g@hud.gov
For assistance with business processes: answers@hud.gov
For assistance with user logins: sfadmin@hud.gov

 

Change Log

September 10, 2018

Updates to Borrower/Address Change, Case Number Assignment, and Insurance Application to accommodate Government Entity Borrowers.
September 18, 2017

Updates to Borrower/Address Change and HECM Insurance Application
Addition of new function: Certificate Search
December 30, 2016

Release to production will be January 14th, 2017

Updates to Borrower/Address Change and Insurance Application
LoanPurpose and OtherLoanPurposeDescription (RefinanceImprovements becomes FinanceImprovements)
September 26, 2016
HECM Financial Assessment
Insurance Application
HECM Certificate (interface unchanged - changes are internal)

Also, for all pilot/test connections; please use "entptest.hud.gov" instead of "hwvalwd3231.hud.gov"
August 1, 2016
203K Calculator
Handbook Updates March 14, 2016 implemented April 16, 2016
Changes to:
Handbook rollout, March 14, 2016 postponed to April 16, 2016
Changes to:
March 14, 2016
Handbook Updates
January 15, 2016
January 7, 2016
December 22, 2015
October 27, 2015
October 16, 2015
Insurance Application
Updates to data dictionary
September 25, 2015
Changes to Counseling Confirmation definitions for Insurance Application
August 24, 2015
Minor corrections to data dictionary and final release date for HUD Handbook update
August 17, 2015
Added output fields for prior loan service for HECM cases
August 12, 2015
Fixed typo in schema
August 6, 2015
HUD Handbook Changes
June 22, 2015
HUD Handbook Changes Documentation upgrade
March 12, 2015
February 9, 2015
November 26, 2014
Updates to:

HECM Insurance, Borrower/Address Change, and Case Number Assignment gain a new attribute (_Eligible) to the _NonBorrowerSpouse element to designate eligibility for the "Safeguard to Prevent Displacement of Homeowner" as defined in Subsection 255(j) of the National Housing Act. Please see Mortgagee Letter 2014-07 for details.

Secondary Financing gains a new value for financing source.

May 28, 2014
Updates to: New function:

Changes to Insurance Application and the addition of the Secondary Financing function are in response to ML 2014-08.

Changes to HECM Insurance Application, Borrower/Address Change, Case Query, and Case Number Assignment are in response to the inclusion of non-borrowing spouses in response to ML 2014-07.

May 12, 2014
Updates to:
January 8, 2014
Updates to:
November 16, 2013
Updates to:
September 17, 2013
Updates to:
August 26, 2013
Updates to:
August 26, 2013