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.

  • Multi-instance fields can be queried with any index. A few examples are BE0002, BE0102, and BE0202.
  • 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.

📘

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.

Language