Download Postman Collection
API Reference

V3 Field Reader

post
https://api.elliemae.com/encompass/v3/loans//fieldReader

Retrieve values for specific fields in a loan.

Usage Notes

📘

Effective with release 24.2, the default value for invalid field behavior will be to fail the request, if invalid fields are provided, and the query parameters are not provided. If you need to provide invalid field IDs and receive a blank response back for any reason, field reader can be called with parameter “invalidFieldBehavior” as “Include”.

Supported Field Types

  • The fieldReader API supports standard, custom and virtual field IDs.
  • Canonical field IDs are not supported and should not be used.
  • If you do not have permission to a requested field, the field will not be returned.

Known Issue: The fieldReader API does not currently prevent the user from passing canonical fields as the input for field ID. However, this is not expected behavior and will be corrected in a future release to invalidate canonical fields.

Path Params
string
required

The unique identifier assigned to the loan.

Query Params
string

Supported values are the following:
Include - The call will not fail and the response will include the invalid fields with empty values.
Exclude - Exclude will not fail the call, but will exclude the invalid fields from the response.
Fail - If there are invalid fields in the request, the API call is going to fail with validation errors.

Body Params
RAW_BODY
array of strings

Array of field IDs of the values you want to retrieve from the loan.

Supported field types: standard, custom and virtual field IDs. Canonical field ids are not supported.

RAW_BODY
Headers
string
required

Bearer token

Responses

Updated 9 months ago

Language
Response 
 Choose an example:
application/json
Updated 9 months ago 










































© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use