V1 Get Loan Schema

Returns a JSON schema for loans. Results can be filtered by specified entities and includeFieldExtensions flag, which determines whether the schema includes field extensions or not.

📘

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

  • There are many entities that make up a loan (for example Borrower, Coborrower, Employment, Asset, and so on). Use the V1 Get Supported Entities API to view the list of entities that can be returned.
  • Pass the entities parameter and specify one or more loan entities to return.
  • Separate multiple entities with a comma.
Query Params
string

Comma-separated list of loan entities to retrieve from the loan schema.

boolean

When set to true, the schema data includes field extensions.

Headers
string
required

Bearer token.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Schema Not Found

500

Internal Server Error

Language
URL
LoadingLoading…
Response
Choose an example:
application/json