V1 Path Generator

Returns JSON paths for the field IDs or field names specified. Use this API's response for specifying the filters attributes when subscribing for a change event webhook.

📘

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.

Query Params
string

Specifies the pattern of field name to search. For example, address would return a JSON paths for all the field names containing address.

boolean
Defaults to false

Indicates whether to ignore invalid loan fields if specified in the request or field name pattern. The default value is false.

Body Params
fieldId
array of strings

Array of field IDs.

fieldId
Headers
string
required

Bearer token.

Responses

401

Unauthorized

403

Forbidden

404

List`1 not found

500

Internal Server Error

Language
URL
Response
Choose an example:
application/json