Order Services

Submits an order for a service and creates a transaction object. The response header ("location") includes the transactionId that is used to retrieve the results from the service provider.

Usage Notes:

  • The caller is expected to ensure that all the details required for placing a request are available within the specified Encompass entity. For example, The borrower's name and social security number are required to run a credit report. This information is expected within the entity that is specified by the product.entityRef attribute in the request.
  • The correct Partner ID, product name and service provider options are required to make this API call to a service provider.
  • Throughout this API specification, Fannie Mae will be referred to as FNMA, and Freddie Mac will be referred to as FHLMC for consistency and brevity.
Path Params
string
required
Body Params

Post the necessary fields for the API to create a new user.

Product
required

Object containing all the necessary product information needed for a service provider to process a service request.

Core attributes include product name, service credentials, reference to the subject loan and user preferences with respect to the product/service. Refer to the schemas below for details on the product object for different categories and services.

Responses

Language
URL
Response
Choose an example:
application/json