HUD Logo
Site Map         A-Z Index         Text   A   A   A
HUD   >   Program Offices   >   Housing   >   Single Family   >   F17c   >   FHA B2G Interface
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.

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

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 welcome package contains some sample code that illustrates posting data to B2G functions:

  • VB6 client
  • VB6 source
  • 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.

Comments or Questions? <SF Administration>

Change Log

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