V3 Get Field Schema

Returns the standard field definitions in a loan. You can query for all standard fields or a specified list of fields.

Based on the architecture supporting Encompass, string fields do not have an absolute limit, allowing for unlimited values. However, certain fields have length restrictions due to compliance guidelines or space limitations on output forms.>> When using Encompass Developer Connect APIs to write data to backend systems, it's recommended to consult with the data intake or integration team to ensure compatibility with system constraints and avoid potential issues related to payload size, performance, or data processing limits.

Usage Notes

  • Multi-instance fields can be queried with any index. A few examples are BE0002, BE0102, and BE0202.
  • The jsonPath attribute of the field definition contains a JSON path that can be used to locate the specified fields in the responses returned by loan APIs like Get Loan / Create Loan / Update Loan.
  • Response header X-Total-Count indicates the total number of records available to fetch.
  • There is no predefined upper limit for the limit parameter and it is restricted by maximum response payload size limit defined in the following Knowledge Article: API Pagination - Response Payload Size Limit
Query Params
string

Comma-separated list of field IDs for which you want field definitions. Each loan data element has a corresponding Encompass field ID. For example, the field ID for Borrower First Name is 4000. You can get the field ID for a loan data element by searching the Loan Data Domain Model Schema.

integer
required

The maximum number of items to return. See Usage Notes for more details.

integer
required

Starting number on the page. Zero-based starting index. The default is zero.

Headers
string
required

Bearer token.

Responses

400

Bad Request

403

Forbidden

Language
URL
Response
Choose an example:
application/json